Grunt, el TaskRunner de Javascript

1
13253

Grunt, el TaskRunner de Javascript

0. Índice de contenidos.

1. Entorno

Este tutorial está escrito usando el siguiente entorno:

  • Hardware: Portátil MacBook Pro 17′ (2.8 GHz Intel Core Duo, 8GB DDR3 SDRAM)
  • Sistema Operativo: Mac OS X Lion 10.7.5

2. Introducción

Grunt es una herramienta que nos permite simplificar el proceso de construcción( build ) de proyectos en Javascript, al igual que Maven nos permite automatizar una serie de pasos / procesos a la hora de compilar nuestro código Java, Grunt nos permite hacerlo con nuestro código Javascript.

3. ¿ Por qué usar Grunt ?

Hoy en día nuestras aplicaciones Javascript se componen de cada vez más ficheros, a medida que las bases de código también se van complicando, se están empezando a aplicar algunas de las buenas prácticas que ya se utilizaban en la parte servidora, como pueda ser TDD o maneras de organizar el código ( el uso de clases / objetos, una clase por fichero.. etc ).

El problema de estas técnicas es que es inviable usarlas directamente en un entorno de producción, el mandar 20 archivos Javascript al cliente es un proceso costoso y largo, ya que cada archivo supone una conexión HTTP, y con el crecimiento de las tecnologías móviles se busca minimizar las conexiones.

Para ello se usan técnicas como la concatenación de varios archivos Javascript en un único archivo optimizado, de manera que solo se le mandará un archivo al cliente, ocultando así también la disposición de los archivos en el entorno de desarrollo.

Para facilitar y automatizar estas tareas, existen herramientas como Grunt.

4. ¿ Que ventajas nos ofrece frente a Maven ?

Apache Maven es una herramienta diseñada para código Java, por lo que las necesidades que se tienen a la hora de construir un proyecto Java son bastante distintas a las necesarias a la hora de compilar código Javascript, Grunt es un Gestor de Tareas específico para Javascript, y nos permite realizar las tareas más comunes en nuestro código Javascript, como pueden ser el control de calidad(JSLint), la ofuscación, minimización y concatenación de archivos, también nos puede servir para automatizar el pase de una batería de test antes de realizar estos pasos.

5. Instalar Grunt

5.1. Requisitos:

Grunt usa el entorno de Node.js para funcionar, además del sistema de paquetes que proporciona Node (npm), por lo que es multiplataforma ( siempre que la plataforma esté soportada por Node.js ).

El primer paso para instalar Grunt es instalar Node.js, si no lo tenemos ya instalado en nuestro equipo, para ello basta con irse a la página oficial de Node y descargar e instalar el ejecutable de nuestra plataforma.

Una vez hayamos instalado Node comprobamos que esté bien instalado escribiendo en la consola:

El siguiente paso será instalar Grunt en nuestro sistema, para ello usaremos el comando:

El «flag» -g indica a npm que queremos instalar Grunt de manera global, lo que nos permitirá invocarlo desde cualquier parte dentro de la línea de comandos.

Con esto ya tendríamos Grunt instalado en nuestro sistema, el siguiente paso será establecer las dependencias que tendrá nuestro proyecto y crear un GruntFile, parecido al pom.xml en Maven.

5.2. Declarando las dependencias:

Las dependencias de Grunt se declaran en el archivo package.json en nuestro proyecto, podemos añadir manualmente los paquetes que queramos añadir como dependencias a nuestro proyecto, o, cuando descarguemos nuevos paquetes, añadirlos automáticamente al fichero poniendo el flag –save-dev.

El primer paso es crear nuestro fichero package.json en la raíz de nuestro proyecto, podemos usar la siguiente plantilla:

De momento vamos a descargar dos paquetes de ejemplo para familiarizarnos con el uso, estos paquetes o plugins añaden funcionalidad a Grunt, una lista se puede encontrar aquí, los plugins a instalar son los siguientes:

  • grunt-contrib-uglify : Este plugin nos permite ofuscar ligeramente nuestros archivos Javascript, de manera que nuestro código estará un poco mas protegido ante ojos ajenos, además reduce el tamaño de nuestros archivos Javascript, eliminando espacios innecesarios, y reduciendo el tamaño de los nombres de las variables.
  • grunt-contrib-concat : Este plugin nos permitirá concatenar varios ficheros en uno, así podremos tener un fichero por clase por ejemplo limitando las peticiones HTTP.

Para instalar los plugin tan solo tenemos que escribir en la consola:

Si todo ha ido bien podremos ver como se habrán agregado las 3 dependencias a nuestro archivo Package.json, de manera que si otro compañero quiere instalar las dependencias de Grunt en nuestro proyecto tan solo tendría que usar el comando:

IMAGEN

6. Declarando nuestras tareas en el Gruntfile.js

El Gruntfile.js es para Grunt lo que es el pom.xml para Maven, aquí es donde declararemos todas las tareas que más adelante podremos invocar, a diferencia de Maven, Grunt nos ofrece mucha más flexibilidad lo que viene perfecto para un lenguaje tan dinámico como Javascript.

Los ficheros Gruntfile hacen uso de la notación JSON por lo que son fáciles de leer, con el siguiente código vamos a conseguir que cada vez que ejecutemos Grunt, todos los archivos Javascript que se encuentren en el fichero src ( y las subcarpetas ) se junten en un único archivo en la carpeta /js y luego se ofuscara ese archivo.

Con esto ya tendríamos lo básico para poder organizar nuestro proyecto sin las limitaciones que nos da el luego tener que distribuir estos archivos al cliente.

Ejecutando el comando grunt en el fichero del proyecto podemos ver como ejecuta el task por defecto:

grunt

7. Controlando la calidad del código Javascript con Grunt

Otra función interesante de Grunt sería la de usarlo para controlar la calidad del código Javascript de manera automática durante nuestro desarrollo, para ello podemos usar herramientas como pueden ser JSLint o JSHint que nos avisaran de posibles fallos en nuestro código.

También podemos usar Grunt para que corra nuestros test automáticos antes de hacer una build final usando Jasmine o Mocha usando los plugin correspondientes.

Un ejemplo de la configuración que usaríamos para los test sería:

Por ultimo solo tendríamos que registrar el Task para poder ejecutarla solo tendríamos que escribir Grunt test

También podríamos hacer una tarea que incluyese todo:

8. Integrando Grunt con otras herramientas.

Grunt, al ser un programa de linea de comandos es fácilmente integrable en otras herramientas como pueden ser Jenkins o Maven, variando la complejidad de dicha integración, lo cual nos ofrece la posibilidad de controlar la calidad del código en el principal lenguaje de nuestra aplicación como también la calidad del código Javascript ( contando que el código Javascript no es el principal en nuestra aplicación ).

Por último, tambien tenemos la opción de integrar Grunt en nuestro IDE de manera que podamos pasar un Task de Grunt antes de hacer la build normal ( si no usásemos Maven para ello )

9. Conclusiones

En los lenguajes dinámicos como Javascript debido a la falta de un compilador que nos avise de los posibles fallos, los test unitarios y las herramientas como JSHint cobran vital importancia a la hora de asegurar la calidad de nuestro código, herramientas como Grunt nos ayudan a realizar estas tareas y nos permiten automatizarlas, haciendo así mas fácil que no se pierdan las buenas costumbres a lo largo del ciclo de vida del proyecto.

El hecho de que Grunt esté escrito en Javascript nos otorga esa flexibilidad a la hora de manipular nuestros Task, lo cual le da una ventaja importante ante otras herramientas como Ant o Maven del mundo Java.

Links de Interes:

1 Comentario

  1. Felicitaciones por el tutorial, lejos el mejor que he leído hasta ahora.
    Me gustaría dar un paso mas… y poder implementarlo en wordpress…, me confunde cómo manejarme con tantos plugins para concatenar en un solo archivo js…cualquier ayuda es bienvenida, gracias

Dejar respuesta

Please enter your comment!
Please enter your name here