Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.
Lära Använda Commander-Modulen för CLI-Appar | Bygga Konsolapplikationer med Node.js
Backendutveckling med Node.js och Express.js

bookAnvända Commander-Modulen för CLI-Appar

Att utveckla ett kommandoradsgränssnitt (CLI) med en modul som Commander kan vara mer hanterbart. Även om Node.js erbjuder inbyggda mekanismer för att hantera kommandoradsargument, kan dessa snabbt bli svåra att hantera när CLI:t växer. Här är Commander användbart, eftersom det erbjuder följande fördelar:

  • Effektiviserad CLI-utveckling: Commander förenklar skapandet av ett CLI genom att minska komplexiteten, vilket gör det möjligt att fokusera på att definiera kommandon och deras funktioner;
  • Detaljerade beskrivningar av kommandon och alternativ: Med Commander kan beskrivningar för kommandon och alternativ enkelt tillhandahållas, vilket förbättrar användarvänligheten för CLI:t;
  • Automatisk argumenttolkning: Commander automatiserar processen för att tolka kommandoradsargument, vilket minimerar mängden kod för manuell argumenthantering.

🔌 Installera Commander-modulen

För att börja behöver vi installera Commander-modulen från NPM. Processen är enkel. Innan Commander-modulen kan användas måste den läggas till i projektet. Kör följande kommando för att installera den:

npm install commander

🔧 Skapa kommandon och alternativ

Med Commander kan vi definiera kommandon, specificera deras beteende och även tillhandahålla beskrivningar. Dessutom kan vi förklara alternativ som modifierar kommandonas beteende. Här är en förhandsvisning av vad vi kan åstadkomma med Commander:

Definiera ett kommando

För att definiera ett kommando, använd metoden .command() på programobjektet. Här är den grundläggande strukturen:

program.command('commandName [arguments]')
  • commandName: Namnet på kommandot;
  • [arguments] : Valfria argument som kommandot accepterar.

Lägga till kommandobeskrivningar

Vi kan tillhandahålla en beskrivning för kommandot med metoden .description():

program.command('commandName [arguments]').description('Description of the command');

Hantering av kommandon

Ange åtgärden som ska utföras när kommandot körs med metoden .action(). Här definieras logiken som är kopplad till kommandot:

program.command('commandName [arguments]').action((...arguments) => {
  // Command logic goes here
});

Här är ett komplett exempel:

program
  .command('greet <name>')
  .description('Greet a person')
  .action((name) => {
    console.log(`Hello, ${name}!`);
  });

Här är kodexemplet från videon:

const { program } = require("commander");

program
  .version("1.0.0")
  .command("greet <name>")
  .description("Greet a person")
  .action((name) => {
    console.log(`Hello, ${name}!`);
  });

program.parse(process.argv);

👨‍💻 Prova själv!

Lärande upplevs bäst genom praktisk övning. Prova att köra denna kod på din dator och se resultatet. Interagera med skriptet och upplev glädjen i att skapa unika hälsningsmeddelanden med hjälp av Commander!

Var allt tydligt?

Hur kan vi förbättra det?

Tack för dina kommentarer!

Avsnitt 2. Kapitel 6

Fråga AI

expand

Fråga AI

ChatGPT

Fråga vad du vill eller prova någon av de föreslagna frågorna för att starta vårt samtal

Suggested prompts:

Can you explain how to add more commands to the CLI?

What happens if I run the script without providing a name?

How can I add options (like flags) to my commands?

Awesome!

Completion rate improved to 2.56

bookAnvända Commander-Modulen för CLI-Appar

Svep för att visa menyn

Att utveckla ett kommandoradsgränssnitt (CLI) med en modul som Commander kan vara mer hanterbart. Även om Node.js erbjuder inbyggda mekanismer för att hantera kommandoradsargument, kan dessa snabbt bli svåra att hantera när CLI:t växer. Här är Commander användbart, eftersom det erbjuder följande fördelar:

  • Effektiviserad CLI-utveckling: Commander förenklar skapandet av ett CLI genom att minska komplexiteten, vilket gör det möjligt att fokusera på att definiera kommandon och deras funktioner;
  • Detaljerade beskrivningar av kommandon och alternativ: Med Commander kan beskrivningar för kommandon och alternativ enkelt tillhandahållas, vilket förbättrar användarvänligheten för CLI:t;
  • Automatisk argumenttolkning: Commander automatiserar processen för att tolka kommandoradsargument, vilket minimerar mängden kod för manuell argumenthantering.

🔌 Installera Commander-modulen

För att börja behöver vi installera Commander-modulen från NPM. Processen är enkel. Innan Commander-modulen kan användas måste den läggas till i projektet. Kör följande kommando för att installera den:

npm install commander

🔧 Skapa kommandon och alternativ

Med Commander kan vi definiera kommandon, specificera deras beteende och även tillhandahålla beskrivningar. Dessutom kan vi förklara alternativ som modifierar kommandonas beteende. Här är en förhandsvisning av vad vi kan åstadkomma med Commander:

Definiera ett kommando

För att definiera ett kommando, använd metoden .command() på programobjektet. Här är den grundläggande strukturen:

program.command('commandName [arguments]')
  • commandName: Namnet på kommandot;
  • [arguments] : Valfria argument som kommandot accepterar.

Lägga till kommandobeskrivningar

Vi kan tillhandahålla en beskrivning för kommandot med metoden .description():

program.command('commandName [arguments]').description('Description of the command');

Hantering av kommandon

Ange åtgärden som ska utföras när kommandot körs med metoden .action(). Här definieras logiken som är kopplad till kommandot:

program.command('commandName [arguments]').action((...arguments) => {
  // Command logic goes here
});

Här är ett komplett exempel:

program
  .command('greet <name>')
  .description('Greet a person')
  .action((name) => {
    console.log(`Hello, ${name}!`);
  });

Här är kodexemplet från videon:

const { program } = require("commander");

program
  .version("1.0.0")
  .command("greet <name>")
  .description("Greet a person")
  .action((name) => {
    console.log(`Hello, ${name}!`);
  });

program.parse(process.argv);

👨‍💻 Prova själv!

Lärande upplevs bäst genom praktisk övning. Prova att köra denna kod på din dator och se resultatet. Interagera med skriptet och upplev glädjen i att skapa unika hälsningsmeddelanden med hjälp av Commander!

Var allt tydligt?

Hur kan vi förbättra det?

Tack för dina kommentarer!

Avsnitt 2. Kapitel 6
some-alt