Catlistener

English

Instalation

npm

npm install catlistener

Using

This is the simplest way to use:

var cat = require('catlistener');

cat.server({
  enviroment:{
    ENV: dev
  },
  node: 'node',
  debug: '--debug',
  app: 'server'
});

Using server

In enviroment section, place the enviroment variables that be useful for our project, "enviroment" should be always initial.

In the Node section we can use of any module for start our server:

node

supervisor

babel-node

Using stylus

cat.stylus({
  options: ['compiles','listener', 'watch'],
  css: './app/staticos/css/',
  stylus: './app/staticos/stylus/estilo.styl'
});

In options we can customize the options that stylus contain.

In css add the route where our css compiled going to be saved.

In stylus add the route of our styl file.

Using Browserify

cat.browserify({
  original: './app/staticos/js/script.js',
  compilado: './app/staticos/js/compilado.js',
  presets: ['es2015']
});

In "original" put the direction of our original Js.

In "compilado" put the direction and the name of our Js files compilated in Ecmascript 6.

"Presets" it´s able to put if you want, use Ecmascript 6 compilated with Babelify

IMPORTANT: For this function to Browserify works must download babel-preset-es2015 or other version of babel.

In addition we can use multi bundle, which allows us to compile different files that we pass through an array.

In the same way we can pass an array of presets that allow us to extend the power of babel.

Example:

cat.browserify({
  original: ['./app/static/js/escript.js', './app/static/js/inicio/inicio.js'],
  compilado: ['./app/static/js/script.js', './app/static/js/inicio.js'],
  common: ['./app/static/js/global.js'],
  presets: ['es2015','react', 'stage-2']
});

When using the multi bundle we added a new common property in which we save all the modules that share the files, avoiding to reload those modules.

More information on multi-blundle operation Multi-bundle

In order to use multi bundle we must install a new module:

npm install factor-bundle

Now we have support for React.js but it is necessary to install babel-preset-react and sweat the preset 'react'.

Important Note: To use the Stylus and Browserify modules, these modules must be installed separately.

In the case of stylus:

npm install -g stylus

In the case of Browserify you need to have downloaded more modules such as:

npm install babelify

npm install babel-preset-ES2015

npm install browserify

npm install -g watchify

Terminal Commands

The use of Terminal Commands is actually ilimited, we can use most of the Git commands, whitout leaving to get response about pour server and stylus, similarly we can install npm modules whitout stop the server.

Implementation

To use this module, just create a file where put all previous that you want and it begin like the example:

Node fileCreated

As easy as that Catlistener Module will be executing.

Español

Un automatizador de tareas y con comandos de terminal para poder ejecutar npm o git sin dejar de ejecutar el servidor u otro servicio.

Instalación

npm

npm install catlistener

Uso

La forma de usar es la siguiente:

var cat = require('catlistener');

cat.server({
  enviroment:{
    ENV: dev
  },
  node: 'node',
  debug: '--debug',
  app: 'server'
});

Uso del servidor

En la sección de enviroment colocamos las variables de entorno que utilizaremos para nuestro proyecto, enviroment siempre debe de ir primero.

En la sección node podemos hacer uso de cualquier módulo para levantar nuestro servidor:

node

supervisor

babel-node

Uso de stylus

cat.stylus({
  options: ['compila','escucha', 'observa'],
  css: './app/staticos/css/',
  stylus: './app/staticos/stylus/estilo.styl'
});

En options colocamos las opciones que queramos usar en nuestro stylus.

En css colocamos la dirección donde se guardara nuestro css compilado.

En stylus colocamos la dirección de nuestro archivo styl.

Uso de browserify

cat.browserify({
  original: './app/staticos/js/script.js',
  compilado: './app/staticos/js/compilado.js',
  presets: ['es2015']
});

En original colocamos la dirección de nuestro js original.

En compilado colocamos la dirección y el nombre de nuestros js compilado en ecmascript 6.

En presets podemos colocar si queremos que use ecmascript 6 compilado con babelify

NOTA: Para que la función de browserify funcione debes de descargar babel-preset-es2015 u otra version de babel.

Además, podemos usar multi bundle, lo que nos permite compilar diferentes archivos que pasamos a través de un array.

De la misma manera podemos pasar una serie de presets que nos permiten extender el poder de babel.

Ejemplo:

cat.browserify({
  original: ['./app/static/js/escript.js', './app/static/js/inicio/inicio.js'],
  compilado: ['./app/static/js/script.js', './app/static/js/inicio.js'],
  common: ['./app/static/js/global.js'],
  presets: ['es2015','react', 'stage-2']
});

Al usar el multi bundle agregamos una nueva propiedad `common en el cual guardamos todos los módulos que comparten los archivos, evitando volver a cargar esos modulos.

Mas informacion del funcionamiento de multi blundle. Multi-bundle

Para poder hacer uso de multi bundle debemos instalar un nuevo módulo.

npm install factor-bundle

Ahora tenemos soporte para React.js pero es necesario instalar babel-preset-react y suar el el preset 'react'.

Nota importante: Para poder hacer uso de los modulos Stylus y Browserify, debera instalar esos modulos por separado.

En el caso de stylus:

npm install stylus -g

En el caso de Browserify usted necesita tener descargado más modulos como lo son:

npm install babelify

npm install babel-preset-es2015

npm install browserify

npm install watchify -g

Comandos de terminal

El uso de los comandos es limitado, podemos usar la mayoría de los comandos de git sin dejar de obtener respuesta de lo que ocurre en nuestro servidor y stylus, de igual forma podemos instalar módulos de npm sin detener el servidor.

Ejecución

Para poder hacer uso del módulo, solo crea un archivo donde coloques todo lo anterior que desees e inicia así:

node archivoCreado

Y asi de facil catlistener se estará ejecutando.