Riferimento rapido

Cheat Sheet per il Parser Nopt

Guida rapida per Nopt, il parser di opzioni di npm per Node.js: definizioni di tipo, abbreviazioni, gestione dei restanti argv e validazione.

· Pubblicato

nopt è il parser di opzioni utilizzato internamente da npm e da molti strumenti a riga di comando.

Uso di base

const nopt = require('nopt');

// 1. Define expected option types
const knownOpts = {
  foo: [String, null],
  size: ['big', 'medium', 'small'],
  many: [String, Array],
  debug: Boolean,
  version: Boolean,
  help: Boolean
};

// 2. Define short aliases
const shortHands = {
  h: '--help',
  v: '--version',
  d: '--debug'
};

// 3. Parse arguments
const parsed = nopt(knownOpts, shortHands, process.argv, 2);

Struttura dell'output

Dato il seguente comando CLI:

node app.js --size big -d input1.txt input2.txt

L'oggetto risultante dal parsing:

{
  size: 'big',
  debug: true,
  argv: {
    remain: ['input1.txt', 'input2.txt'], // Non-option positional arguments
    cooked: ['--size', 'big', '--debug', 'input1.txt', 'input2.txt'],
    original: ['--size', 'big', '-d', 'input1.txt', 'input2.txt']
  }
}

Tipi supportati

  • String
  • Boolean
  • Number
  • Array
  • Date
  • path (normalizza i percorsi)
  • url (valida stringhe URL)
  • Enumerazioni (Enums): ['small', 'medium', 'large']

Riferimenti

Argomenti correlati