Référence rapide

Aide-mémoire Nopt

Guide rapide pour Nopt, l'analyseur d'options de npm pour Node.js : définitions de types, raccourcis, gestion d'argv et validation.

· Publié le

nopt est l'analyseur d'options utilisé en interne par npm et de nombreux outils en ligne de commande.

Utilisation de 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);

Structure de sortie

Soit la commande CLI suivante :

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

L'objet analysé résultant :

{
  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']
  }
}

Types pris en charge

  • String
  • Boolean
  • Number
  • Array
  • Date
  • path (normalise les chemins)
  • url (valide les URL)
  • Énumérations (Enums) : ['small', 'medium', 'large']

Références

Sujets associés