Referencia rápida

Hoja de trucos del analizador Nopt

Guía rápida para Nopt, el analizador de opciones de npm para Node.js: definición de tipos, abreviaturas, manejo de argv restante y validación.

· Publicado

nopt es el analizador de opciones utilizado internamente por npm y muchas herramientas de línea de comandos.

Uso básico

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

Estructura de salida

Dado el siguiente comando CLI:

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

El objeto analizado resultante:

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

Tipos admitidos

  • String
  • Boolean
  • Number
  • Array
  • Date
  • path (normaliza rutas)
  • url (valida cadenas URL)
  • Enumeraciones (Enums): ['small', 'medium', 'large']

Referencias

Temas relacionados