Tutoriel pour apprendre à utiliser l'outil JavaScript Grunt - Créer des tâches

Une tâche est une fonction JavaScript. En JavaScript, le mot-clé this utilisé dans le corps d'une fonction se rapporte à l'objet contexte de celle-ci. Dans le cas des tâches Grunt, le contexte permet d'accéder à un certain nombre de propriétés et de méthodes utiles. Dans les exemples suivants, vous verrez que l'objet configuration relatif à une tâche est accessible via this.options().

Je vous renvoie aux précédents articles pour plus de détails :

• l'API Grunt : this ;
• configurer les tâches : this.options().

Créer une tâche simple revient à appeler la méthode grunt.task.registerTask en lui passant en paramètre :

1. Un nom de tâche, une description (facultatif) et une fonction avec ou sans paramètre.

    

   Sélectionnez

   grunt.registerTask(taskName, [description, ] taskFunction)

2. Un nom de tâche, une description (facultatif) et une liste de tâches simples et/ou à cibles multiples.

grunt.registerTask(taskName, [description, ] taskList)

Vous créez une tâche simple lorsque vous avez besoin d'une tâche répondant au moins à l'un de ces critères :

1. Pas de configuration ;
2. Toujours la même action sur les mêmes objets.

Illustrons ces deux cas :

1. Vous voulez toujours copier un fichier F de A vers B ? Une tâche sans configuration ;
2. Vous voulez copier un fichier F de A vers B, mais vous prévoyez que F, A et B puissent être changés au besoin ? Une configuration définissant F, A et B, une tâche qui fait toujours la même action de copie de F de A vers B.

Illustrons le cas 1) précédent :

module.exports = function(grunt) {
  // une tâche simple copiant un fichier donné de A vers B
  grunt.registerTask('copyF', 'Copy file A into folder B', function(logEnabled) {
    var F = 'the_file.txt',
        A = 'c:\\',
        B = 'd:\\';
 
    if (logEnabled){
       grunt.log.writeln('copy of ' + F + ' from ' + A + ' to ' + B);
    }
 
    grunt.file.copy(A + F, B + F);
 
    if (logEnabled){
       grunt.log.writeln('copy done');
    }
  });
};

Et le cas 2) :

module.exports = function(grunt) {
  grunt.initConfig({
    copyF: {
      options: {
        F: 'the_file.txt',
        A: 'c:\\',
        B: 'd:\\'
      }
    }
  });
 
  // une tâche simple copiant un fichier donné de A vers B
  grunt.registerTask('copyF', 'Copy file A into folder B', function(logEnabled) {
    var F = this.options().F,
        A = this.options().A,
        B = this.options().B;
 
    if (logEnabled){
      grunt.log.writeln('copy of ' + F + ' from ' + A + ' to ' + B);
    }
 
    grunt.file.copy(A + F, B + F);
 
    if (logEnabled){
      grunt.log.writeln('copy done');
    }
  });
};

Une tâche simple peut aussi n'être qu'un alias permettant de lancer séquentiellement une liste de tâches simples et/ou à cibles multiples.

// la tâche dist lance séquentiellement chacune des tâches de la liste
grunt.registerTask('dist', ['jshint', 'qunit', 'concat:dist', 'uglify:dist']);

Une tâche à cibles multiples, ou « multitâche », est une tâche pour laquelle les propriétés de l'objet de configuration - à l'exception de la propriété options - sont autant de configurations individuelles.

Chacune de ces configurations est appelée « cible ». Si la tâche s'exécute sur une cible, elle s'exécute avec la configuration de cette cible. Si la tâche s'exécute sans qu'une cible ne soit spécifiée, elle s'exécute séquentiellement pour chacune des cibles définies.

Quel avantage par rapport à une tâche simple ?

Une tâche simple produit le même résultat à chaque exécution, sauf si la fonction qui la définit accepte des arguments permettant de piloter son comportement. Cependant :

• les arguments de la fonction ne permettent pas la même flexibilité que la configuration ;
• les arguments de la fonction ne sont pas gérés par Grunt : cf. Configurer les tâches (options, fichiers src-dest, templates, etc.).

Au crédit des tâches à cibles multiples :

• la même tâche peut être exécutée plusieurs fois au cours d'un même process avec des configurations différentes et donc produire des résultats différents ;
• la même tâche peut être exécutée dans des process différents avec des configurations différentes et donc produire des résultats différents suivant le process ;
• les tâches à cibles multiples fournissent à support à la gestion des fichiers source-destination qui n'existe pas pour les tâches simples.

Le contexte des tâches à cibles multiples fournit les mêmes fonctionnalités que les tâches simples, mais pas que ! Je vous renvoie à la section sur le contexte des tâches à cibles multiples de l'article sur l'API Grunt pour plus d'informations.

Créer une tâche à cibles multiples revient à appeler la méthode grunt.registerMultiTask en lui passant en paramètre :

1. Un nom de tâche ;
2. Une description (facultatif) ;
3. Une fonction avec ou sans paramètre

grunt.registerMultiTask(taskName, [description, ] taskFunction)

Reprenons l'exemple de la tâche copyF et adaptons-le pour en faire une tâche à cibles multiples.

module.exports = function(grunt) {
  grunt.initConfig({
    deployConfig: {
      dev: {
        A: 'c:\\dev.config',
        B: 'd:\\application.config'
      },
      uat: {
        A: 'c:\\uat.config',
        B: '\\\\UAT_SERVER\\c$\\application.config'
      },
      prod: {
        A: 'c:\\prod.config',
        B: '\\\\PROD_SERVER\\c$\\application.config'
      }
    }
  });
 
  // une tâche simple copiant un fichier donné de A vers B
  grunt.registerTask('deployConfig', 'Deploy config from A to B', function(logEnabled) {
    var A = this.options().A,
        B = this.options().B;
 
    if (logEnabled){
      grunt.log.writeln('deploy from ' + A + ' to ' + B);
    }
 
    grunt.file.copy(A, B);
 
    if (logEnabled){
      grunt.log.writeln('copy done');
    }
  });
}

Cette tâche permet de déployer la configuration adaptée à l'environnement ciblé.