CLI-Framework JavaScript (Node.js) Commander.js

Commander.js: Erstellung leistungsstarker Konsolenanwendungen in Node.js

In der Welt der modernen Webentwicklung und Automatisierung spielen Konsolenanwendungen (CLI) eine Schlüsselrolle. Sie ermöglichen die Automatisierung von Routineaufgaben, die Verwaltung von Projekten, das Bereitstellen von Code und die Interaktion mit APIs ohne grafische Benutzeroberfläche. Wenn Sie in JavaScript (Node.js) programmieren, ist das Framework Commander.js die beste Wahl für die Erstellung eleganter und funktionaler CLI-Tools.

Commander.js ist eine leichte, aber unglaublich leistungsstarke Bibliothek, die die gesamte Routine des Parsens von Befehlszeilenargumenten, der Generierung von Hilfetexten und der Fehlerbehandlung übernimmt. Mit ihr können Sie ein einfaches Skript in eine professionelle Konsolenanwendung mit Unterstützung für Unterbefehle, Optionen und automatische Validierung verwandeln. In diesem Artikel werden wir im Detail besprechen, wie Sie Commander.js auf der Bildungswebsite pythonlib.ru zur Erstellung eigener CLI-Dienstprogramme verwenden.

Installation und grundlegende Verwendung

Stellen Sie vor Beginn sicher, dass Node.js (Version 12 und höher) installiert ist. Die Installation von Commander.js erfolgt über npm:

npm install commander

Erstellen Sie nach der Installation eine Datei cli.js und binden Sie die Bibliothek ein. Betrachten wir ein einfaches Beispiel – eine Anwendung, die "Hallo, Welt!" ausgibt und einen Benutzernamen entgegennimmt.

#!/usr/bin/env nodeconst { Command } = require('commander');const program = new Command();

program  .name('greet')  .description('Gibt eine Begrüßung aus')  .version('1.0.0');

program  .command('hello')  .description('Begrüßt den Benutzer')  .argument('<name>', 'Benutzername')  .action((name) => {    console.log(`Hallo, ${name}! Willkommen bei Commander.js.`);  });

program.parse(process.argv);

Führen Sie nun das Skript aus:

node cli.js hello Ivan

Sie sehen: Hallo, Ivan! Willkommen bei Commander.js.

Hauptfunktionen von Commander.js

Commander.js bietet eine umfangreiche Sammlung von Funktionen zur Erstellung professioneller CLI-Anwendungen. Betrachten wir diese genauer.

1. Befehle und Unterbefehle

Sie können eine unbegrenzte Anzahl von Befehlen erstellen (z. B. init, build, deploy) und diese ineinander verschachteln. Dies ist besonders nützlich für komplexe Tools wie Paketmanager oder Projekt-Builder.

program  .command('init')  .description('Initialisiert ein neues Projekt')  .option('-t, --template <type>', 'Projektvorlage (basic, advanced)')  .action((options) => {    console.log(`Projekt wird mit Vorlage erstellt: ${options.template || 'basic'}`);  });

2. Optionen (Flags)

Optionen ermöglichen es dem Benutzer, zusätzliche Parameter zu übergeben. Commander.js unterstützt kurze (-v) und lange (--verbose) Flags sowie erforderliche und optionale Werte.

program  .option('-d, --debug', 'Debug-Modus aktivieren')  .option('-p, --port <number>', 'Server-Port', '3000') // Standardwert  .parse(process.argv);

if (program.opts().debug) {  console.log('Debugging aktiviert');}

3. Befehlsargumente

Argumente sind Positionsparameter, die der Benutzer nach dem Befehl übergibt. Sie können erforderlich (<name>) oder optional ([name]) sein.

program  .command('copy <source> [destination]')  .description('Kopiert eine Datei von source nach destination')  .action((source, destination) => {    console.log(`Kopiere von ${source} nach ${destination || 'aktuelles Verzeichnis'}`);  });