Créez votre propre outil d'échafaudage de style yeoman avec caporal.js

Ce didacticiel montre comment créer un outil d'interface de ligne de commande Node.js à l'aide de caporal.js pour automatiser la création de nouveaux projets JavaScript. Vous en avez assez de la configuration répétitive du projet? Cette solution vous permet de créer un outil d'échafaudage personnalisable pour rationaliser votre flux de travail.

Le processus exploite JavaScript et les bibliothèques facilement disponibles, éliminant le besoin d'outils spécialisés ou de langages complexes. Cette approche offre plusieurs avantages:

• Efficacité: Automatiser les tâches répétitives associées à la création de nouveaux projets.
• Personnalisation: Adaptez facilement la CLI à vos besoins et préférences de projet spécifiques.
• Apprentissage: acquérir une expérience précieuse dans la création d'outils de ligne de commande et l'automatisation des flux de travail.

Alors que des outils existants comme Yeoman offrent des fonctionnalités similaires, la construction de la vôtre offre une compréhension plus profonde et une personnalisation sans précédent. Ce tutoriel utilise Caporal.js pour la construction CLI, prompt pour la saisie de l'utilisateur et shelljs pour la manipulation du système de fichiers. Le projet terminé est disponible sur github: https://www.php.cn/link/2f803d26ce47b9f9de9af69e5b73e3d1

Début avec caporal.js

1. Créez un répertoire de projet et initialisez un fichier package.json avec les dépendances suivantes:

{
  "name": "scaffold",
  "version": "1.0.0",
  "main": "index.js",
  "bin": {
    "scaffold": "index.js"
  },
  "dependencies": {
    "caporal": "^0.3.0",
    "colors": "^1.1.2",
    "prompt": "^1.0.0",
    "shelljs": "^0.7.7"
  }
}

2. Installez les dépendances en utilisant npm install.

3. L'entrée bin dans package.json Spécifie la commande CLI (scaffold) et son point d'entrée (index.js).

Construire le point d'entrée index.js

Le fichier index.js définit les commandes CLI et leurs actions. Notre CLI aura une seule commande create avec des options pour spécifier un modèle et une variante:

#!/usr/bin/env node

const prog = require('caporal');
const createCmd = require('./lib/create');

prog
  .version('1.0.0')
  .command('create', 'Create a new application')
  .argument('<template>', 'Template to use')
  .option('--variant <variant>', 'Which variant of the template to create')
  .action(createCmd);

prog.parse(process.argv);

Création de modèles de projet

Les modèles définissent la structure et les fichiers du projet. Créez un répertoire templates, puis des sous-répertoires pour chaque type de modèle (par exemple, templates/node/default, templates/node/mvc). Chaque répertoire de modèle doit contenir les fichiers nécessaires et A package.json avec des variables d'espace réservé (par exemple, [NAME], [VERSION]). Un fichier _variables.js répertorie ces variables pour l'entrée de l'utilisateur.

Implémentation de la commande create

Le fichier lib/create.js contient la logique de la commande create:

{
  "name": "scaffold",
  "version": "1.0.0",
  "main": "index.js",
  "bin": {
    "scaffold": "index.js"
  },
  "dependencies": {
    "caporal": "^0.3.0",
    "colors": "^1.1.2",
    "prompt": "^1.0.0",
    "shelljs": "^0.7.7"
  }
}

Cette fonction gère la copie des fichiers de modèle, l'incitant à l'utilisateur pour les valeurs variables et le remplacement des espaces réservés dans les fichiers. La commande shelljs.sed est cruciale pour ce remplacement dynamique.

Rendre la CLI à l'échelle mondiale

Run npm link dans le répertoire du projet pour rendre la CLI accessible à l'échelle mondiale. Vous pouvez ensuite exécuter des commandes comme scaffold create node --variant mvc à partir de n'importe quel répertoire.

étendre le cli

La flexibilité de cette approche permet des extensions significatives:

Ajouter plus de commandes.
Gérer les remplacements de variables plus complexes.
Intégrer les processus de déploiement ou de création.

Ce tutoriel fournit une base solide pour construire un outil d'échafaudage de projet puissant et personnalisable. N'oubliez pas de consulter le référentiel GitHub pour le code complet et plus de détails.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!