Gulp

⚠ Obsolète ! Utiliser plutôt les scripts npm pour les builds.

Introduction

C'est un gestionnaire de tâches. Cela permet de construire un site statique automatiquement.


Installation

npm install -g gulp
npm install gulp --save-dev

Utilisation

Dans un fichier gulpfile.js

var gulp = require('gulp');

gulp.task('default', function() {
  // opérations
});

Pour lancer la tâche default il sufit d'utiliser la commande: gulp default ou gulp.

Gulp utilise de nombreux plugins différents suivant les besoins tels que:

  • gulp-jade
  • gulp-stylus
  • gulp-livereload
  • gulp-filter
  • gulp-uglify
  • gulp-minify-css
  • gulp-imagemin
  • gulp-clean
  • git-plumber
  • ...

Stream

Gulp fonctionne en système de stream/source, exemple gulp.src('js/**/*.js'). Un stream permet de lire et d'écrire un contenu sous forme de flux et de recevoir les informations sous forme de petits blocs plus digestes pour la mémoire.

Le flux est piper, c'est-à-dire traiter dans différentes opérations (concatener, fusionner, minifier,...).

var jade = require('gulp-jade');
gulp.src('')
  .pipe(jade())

Et on indique le dossier de destination avec gulp.dest('dossier').

On peut configurer les pipes. Chaque plugin à sa propre configuration et fonction

gulp.src('*.jade')
  .pipe(jade({
    pretty: true
  }))
  .pipe(gulp.dest('/'));

On peut lancer des tâches avant d'autres en ajoutant un paramètre dans la focntion task: `` gulp.task('default')


Fonctions

nom code description commentaires
Tâche gulp.task('nom-tâche', function()) créer une tâche contient 1* stream
Stream gulp.src('path-fichiers') fichier(s) source asynchrone dans la tâche
Pipe .pipe() lance une opération
Destination gulp.dest('path-dossier') destination des fichiers transformés
Watch gulp.watch('fichiers', ['tâche']) relance une tâche à chaque modification

Exemple

gulpfile.js

var gulp = require('gulp'),
    livereload = require('gulp-livereload'),
    jade = require('gulp-jade'),
    useref = require('useref');

gulp.task('html', function() {
  return gulp.src('*.jade')
          .pipe(jade({pretty: true}))
          .pipe(gulp.dest('/'))
});

gulp.task('css', function() {
  return gulp.src('*.stylus')
          .pipe(stylus({
            compress: true
          }))
          .pipe(gulp.dest('css'))
});

gulp.task('watch', function() {
  // actualise à chaque modifications
  var server = livereload();
  gulp.watch('*.jade', ['html']);
  gulp.watch(['*.html', 'css/*.css']).on('change', function(event) {
    server.changed(event.path);
  });
});

gulp.task('default', ['html'], function() {
  retiurn gulp.src('*.html')
            .pipe(useref.assets())
            .pipe(useref.restore())
            .pipe(useref())
            .pipe(gulp.dest('dist');
});

Alternatives

JavaScript Bundlers

JavaScript Bundler est un outil qui regroupe le code JS et toutes les dépendances du projet dans un seul fichier JS. Historiquement JS n'a pas de standard pour importer des dépendances, comme import ou require. Maintenant il y a la fonctionnalité import de ES2015 mais elle n'est pas encore suffisament implémentée.

Des solutions existes dans d'autres environnements, par exemple Node.js utilise son propre module d'implémentation require() et exports basé sur Commonjs spécifications. C'est pourquoi on voit ce méchanisme souvent appelé "commonjs".

Il y a une contrainte avec require() : c'est synchrone donc si nous avons besoin d'un fichier qui n'a pas encore été chargé nous avons besoin de faire une requête HTTP, mais celle-ci est asynchrone. La solution c'est de mettre toutes les dépendances dans un seul fichier pour avoir tout le code en mémoire, prés à être utilisé quand la fonction require() est invoqué.

ready to be used when invoking the require() function that the JavaScript bundler will implement some way.

ⓘ CommonJS n'est pas le seul module d'implémentation disponible. Par exemple Webpack utilise AMD. AMD(Asynchronous Module Definition) est asynchrone.

Liste des plus utilisés

  • Browserify (2011) : utilise le require() de nodejs côté navigateur afin d'utiliser plusieurs fichiers js et le concaténer dans un seul tag script.
  • Webpack (2012) : on peut tout moduler (CSS, images, fonts...). À combiner avec les scripts NPM à la place de Gulp.
  • Rollup (2012) : bundle du code ES2015 + enlève le code non utilisé des librairies.
  • Blendid (2017) : configure tous les outils nécessaires
    • Compile JS (Webpack 2 + Babel), preconfigured with es2015, and stage-1 presets.
    • Compile CSS (Node Sass)
    • Compile HTML (Nunjucks) when needed.
    • Live update JS, CSS, images, and assets via Browsersync and Webpack Hot Middleware
    • Hot module replacement is enabled, with support for React Hot Loader 3
    • New files are tracked - no restarting the processes required.
    • Compile errors are handled gracefully and displayed in the console, in the browser (for JS), and via notifications.
    • Source maps are set up for both CSS and JS. JS defaults to Webpack's cheap-eval-sourcemap, which is one of the fastest to compile.
    • Deploy compiled files directly to gh-pages. Great for prototypes and static sites.