Tâches Gulp

Un fichier pour chaque type de tâche gulp est placé dans le répertoire tasks/ et importé dans le fichier Gulpfile.js à la racine du dépôt.

On peut les lister avec leur résumé grâce à la commande :

$ gulp help

Liste des tâches disponibles

  • build Construit le répertoire public
  • cast Lance l'index du projet dans BrowserSync et synchronise les modifications
  • dev Effectue successivement les tâches build + cast
  • clean Supprime le répertoire public et son contenu

Compilations et concaténations :

  • make:css Compile les css vers public
  • make:css-min Compile et compacte les css vers public
  • make:html Compile twig en html vers public
  • make:js-main Concatène les fichiers présents dans scripts/main et les envoie dans public

Copie des assets :

  • send:assets Copie les assets dans public
  • send:favicon Copie favicon.ico à la racine de public
  • send:js-vendors Récupère et copie les dépendences js dans public

Post-traitements :

  • do:prettify Normalise l'indentation du html

Autres tâches :

  • prep:sprite Fabrique ou régénère le fichier icon-sprite.svg dans dev

baseURL

On peut se trouver fréquemment dans le cas où selon l'environnement on veut pouvoir faire varier l'url de base des chemins et donner donc différentes valeurs possibles à {{ baseURL }} au moment de la compilation des templates.

Par exemple, au moment du développement en local on veut que l'url de base soit à la racine de localhost mais en déploiement l'adresse qui correspondra aux gabarits sera https://domaine/next/.

Cette variation est effectuée grâce à deux opérations :

  1. Dans le fichier config.json on renseigne les différentes valeurs que peut prendre baseURL
  2. On ajoute dans la tâche Gulp le paramètre qui permettra d'utiliser l'une ou l'autre de ces valeurs pour la compilation
  3. On passe le paramètre lors de la tâche gulp de compilation

Scampi-Twig propose par défaut la possibilité de deux valeurs différentes pour baseURL (voir le fichier config.json) et les réemploie dans la compilation des templates avec les paramètres --prod ou --dev (voir tasks/html.js). Si on ne met pas de paramètre c'est --dev qui s'applique.

Sur le même principe on peut introduire d'autres variations.

Les informations données dans cette rubrique correspondent à la version 1.0 release candidate de Scampi-Twig, encore en développement. Pour lire la documentation de la version courante (0.3.1), référez-vous au readme du dépôt.