Erstellen Sie Ihr eigenes Gerüstwerkzeug im Yeoman-Stil mit caporal.js

Dieses Tutorial zeigt, wie ein Node.js-Befehlszeilen-Schnittstelle (CLI) erstellt wird, das caporal.js verwendet, um die Erstellung neuer JavaScript-Projekte zu automatisieren. Müde von sich wiederholendes Projekt -Setup? Mit dieser Lösung können Sie ein anpassbares Gerüst -Tool erstellen, um Ihren Workflow zu optimieren.

Der Prozess nutzt JavaScript und leicht verfügbare Bibliotheken und beseitigt die Notwendigkeit von speziellen Tools oder komplexen Sprachen. Dieser Ansatz bietet mehrere Vorteile:

• Effizienz: automatisieren sich wiederholende Aufgaben, die mit einer neuen Projekterstellung verbunden sind.
• Anpassung: Die CLI einfach an Ihre spezifischen Projektanforderungen und -präferenzen anpassen.
• Lernen: Wertvolle Erfahrungen im Erstellen von Befehlszeilenwerkzeugen und Automatisierung von Workflows.

Während vorhandene Tools wie Yeoman ähnliche Funktionen bieten, bietet das Erstellen Ihres eigenen ein tieferes Verständnis und eine beispiellose Anpassung. In diesem Tutorial verwendet Caporal.js für die CLI -Konstruktion, prompt für die Benutzereingabe und shelljs für die Manipulation des Dateisystems. Das abgeschlossene Projekt ist auf GitHub verfügbar: https://www.php.cn/link/2f803d26ce47b9f9de9af69e5b73e3d1

Erste Schritte mit caporal.js

1. Erstellen Sie ein Projektverzeichnis und initialisieren Sie eine package.json -Datei mit den folgenden Abhängigkeiten:

{
  "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. Installieren Sie die Abhängigkeiten mit npm install.

3. Der bin Eintrag in package.json gibt den CLI -Befehl (scaffold) und seinen Einstiegspunkt (index.js) an.

   .

index.js Erstellen des Einstiegspunkts

index.js Die Datei create definiert die CLI -Befehle und deren Aktionen. Unsere CLI hat einen einzelnen

-Fehl mit Optionen zum Angeben einer Vorlage und 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);

Erstellen von Projektvorlagen

templates Vorlagen definieren die Projektstruktur und die Dateien. Erstellen Sie ein templates/node/default Verzeichnis, dann Unterverzeichnis für jeden Vorlagentyp (z. B. templates/node/mvc, package.json). Jedes Vorlagenverzeichnis sollte die erforderlichen Dateien und ein [NAME] mit Platzhaltervariablen (z. B. [VERSION], _variables.js) enthalten. A

Datei listet diese Variablen für die Benutzereingabe auf.

create Implementieren des Befehls

lib/create.js Die Datei create enthält die Logik für den Befehl

:

{
  "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"
  }
}

Diese Funktion übernimmt das Kopieren der Vorlagendateien, fordert den Benutzer nach variablen Werten auf und ersetzt Platzhalter in den Dateien. Der Befehl shelljs.sed ist für diesen dynamischen Ersatz von entscheidender Bedeutung.

Die CLI weltweit verfügbar

Ausführen npm link im Projektverzeichnis, um die CLI weltweit zugänglich zu machen. Sie können dann Befehle wie scaffold create node --variant mvc aus jedem Verzeichnis ausführen.

Erweiterung des Cli

Die Flexibilität dieses Ansatzes ermöglicht erhebliche Erweiterungen:

• Weitere Befehle hinzufügen.
• Umgang mit komplexerer variablerer Ersatz.
• Integrieren Sie Bereitstellungs- oder Bauprozesse.

Dieses Tutorial bietet eine solide Grundlage für den Aufbau eines leistungsstarken und anpassbaren Projektgerüstwerkzeugs. Denken Sie daran, das Github -Repository für den vollständigen Code und weitere Details zu konsultieren.

Das obige ist der detaillierte Inhalt vonErstellen Sie Ihr eigenes Gerüstwerkzeug im Yeoman-Stil mit caporal.js. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!