Mise en route – Grunt Le JavaScript Task Runner

Mise en route - Grunt Le JavaScript Task RunnerCommencer

Si vous avez déjà installé Grunt et sont maintenant la recherche d’une référence rapide, s’il vous plaît caisse notre exemple Gruntfile et comment configurer une tâche.

Cela mettra la commande grognement dans votre chemin d’accès système, lui permettant d’être exécuté à partir d’un répertoire.

Notez que l’installation grunt-cli ne pas installer la tâche coureur Grunt! Le travail du Grunt CLI est simple: exécuter la version de Grunt qui a été installé à côté d’un Gruntfile. Cela permet à plusieurs versions de Grunt à être installés sur la même machine simultanément.

Chaque grognement de temps est exécuté, il recherche un Grunt installé localement à l’aide de nœuds nécessitent system (). À cause de cela, vous pouvez exécuter grognement d’un sous-dossier dans votre projet.

Si un Grunt installé localement est trouvée, la CLI charge l’installation locale de la bibliothèque Grunt, applique la configuration de votre Gruntfile. et exécute toutes les tâches que vous avez demandé pour qu’il fonctionne. Pour vraiment comprendre ce qui se passe, lire le code.

En supposant que le Grunt CLI a été installé et que le projet a déjà été configuré avec un package.json et un Gruntfile. il est très facile de commencer à travailler avec Grunt:

  1. Modifier le répertoire racine du projet.
  2. Installer les dépendances du projet avec npm installer.
  3. Exécutez Grunt avec grognement.

C’est vraiment tout ce qu’il ya à faire. tâches Grunt installés peuvent être répertoriés en exécutant grunt –help, mais il est généralement une bonne idée de commencer avec la documentation du projet.

Une configuration typique consiste à ajouter deux fichiers à votre projet: package.json et Gruntfile.

Gruntfile. Ce fichier est nommé Gruntfile.js ou Gruntfile.coffee et est utilisé pour configurer ou définir des tâches et charger des plugins Grunt. Lorsque cette documentation mentionne un Gruntfile il parle d’un fichier, qui est soit un Gruntfile.js ou Gruntfile.coffee .

Il y a quelques façons de créer un fichier package.json pour votre projet:

  • La plupart des modèles grunt-init va créer automatiquement un fichier package.json spécifique au projet.
  • La commande npm init va créer un fichier de base de package.json.
  • Commencez par l’exemple ci-dessous, et d’étendre au besoin, à la suite de cette spécification.

Par exemple, cela va installer la dernière version de Grunt dans votre dossier de projet, en ajoutant à vos devDependencies:

La même chose peut être fait pour gruntplugins et d’autres modules de noeud. Comme on le voit dans l’exemple suivant l’installation du module de tâche JSHint:

Commander les gruntplugins actuellement disponibles pour être installés et utilisés sur votre projet à la page des plugins.

Assurez-vous de valider le fichier de package.json mis à jour avec votre projet lorsque vous avez terminé!

Le fichier Gruntfile.js ou Gruntfile.coffee est un JavaScript ou CoffeeScript fichier valide qui appartient dans le répertoire racine de votre projet, à côté du fichier package.json, et devrait être engagé avec votre source de projet.

Un Gruntfile se compose des parties suivantes:

  • le "papier d’emballage" fonction
  • Configuration du projet et de la tâche
  • Chargement des plugins et des tâches Grunt
  • Tâches personnalisées

Dans le Gruntfile suivant. métadonnées du projet est importé dans la config Grunt à partir du fichier package.json du projet et la tâche de enlaidir du plugin grunt-contrib-enlaidir est configuré pour rapetisser un fichier source et de générer une bannière commentaire en utilisant dynamiquement que les métadonnées. Lorsque grunt est exécuté sur la ligne de commande, la tâche enlaidir sera exécuté par défaut.

Maintenant que vous avez vu l’ensemble Gruntfile. regardons ses composants.

Chaque Gruntfile (et gruntplugin) utilise ce format de base, et l’ensemble de votre code Grunt doit être spécifié à l’intérieur de cette fonction:

La plupart des tâches de Grunt reposent sur des données de configuration définies dans un objet passé à la méthode grunt.initConfig.

Dans cet exemple, grunt.file.readJSON ( ‘package.json’) importe les métadonnées JSON stockées dans package.json dans la config grognement. Car lt;%% gt; chaînes de modèle peuvent référencer les propriétés de configuration, les données de configuration telles que les chemins de fichiers et des listes de fichiers peuvent être spécifiés de cette manière de réduire la répétition.

Vous pouvez stocker des données arbitraires à l’intérieur de l’objet de configuration, et aussi longtemps que cela ne soit pas incompatible avec les propriétés de vos tâches nécessitent, il sera ignoré autrement. Aussi, parce que cela est JavaScript, vous n’êtes pas limité à JSON; vous pouvez utiliser toutes les JS valables ici. Vous pouvez même programme générer la configuration si nécessaire.

Comme la plupart des tâches, la tâche de enlaidir du grunt-contrib-enlaidir plug-in attend sa configuration à spécifier dans une propriété du même nom. Ici, l’option de la bannière est spécifiée, avec une construction nommée seule cible enlaidir que minifies un seul fichier source à un seul fichier de destination.

Remarque: la commande grunt listera toutes les tâches disponibles.

Vous pouvez configurer Grunt pour exécuter une ou plusieurs tâches par défaut en définissant une tâche par défaut. Dans l’exemple suivant, en cours d’exécution grognement à la ligne de commande sans spécifier une tâche sera exécutée la tâche enlaidir. Ceci est fonctionnellement le même grognement explicitement exécutant enlaidir ou même défaut grognement. Tout nombre de tâches (avec ou sans arguments) peut être spécifiée dans le tableau.

Si votre projet nécessite des tâches non prévues par un plugin Grunt, vous pouvez définir des tâches personnalisées à droite à l’intérieur du Gruntfile. Par exemple, cette Gruntfile définit une tâche par défaut complètement personnalisée qui n’a même pas utiliser la configuration de la tâche:

tâches spécifiques à un projet sur mesure ne doivent être définis dans le Gruntfile; ils peuvent être définies dans des fichiers externes Js et chargés par la méthode grunt.loadTasks.

  • Le guide de grunt Installation contient des informations détaillées sur l’installation spécifique, la production ou en développement, les versions de Grunt et grunt-cli.
  • Le guide des tâches de Configuration a une explication en profondeur sur la façon de configurer les tâches, les objectifs, les options et les fichiers à l’intérieur du Gruntfile. avec une explication des modèles, des modèles et des jokers l’importation de données externes.
  • Le guide des tâches de création de listes les différences entre les types de tâches Grunt et montre un certain nombre de tâches et des exemples de configuration.
  • Pour plus d’informations sur l’écriture des tâches personnalisées ou plugins Grunt, consultez la documentation développeur.

Trouvé une erreur dans la documentation? Fichier un problème.

Source: gruntjs.com

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *

un × 3 =