nodejs / nodejs/node

Add support to print help/usage of util.parseArgs

Abierto
#56,184 8 comentarios 16 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

feature request
Lenguaje dominante
JavaScript
Estrellas
122k
Forks
37.3k
Merge medio
4 d 2 h
PR fusionados (30 d)
283

Descripción

What is the problem this feature will solve?

An almost ubiquitous practice of writing a CLI is including a help command in the CLI itself. Currently anyone using util.parseArgs needs to write their own help command. This, in my opinion, makes parseArgs incomplete.

What is the feature you are proposing to solve the problem?

My suggestion is to include the ability to prin help/usage information generated directly from the config given to parseArgs. A minimum would be something along the lines of:

  1. Include help text for each ParseArgsOptionConfig to include help text for each option in particula:
foo: {    
 type: 'boolean',    
 short: 'f',   
 help: 'enable foo',
},
  1. Add a main help text to the ParseArgsConfig as well, to include details on what the CLI as a whole:
parseArgs({ 
  help: 'Use this command to achieve foo',
  options: {
    // ...
  }
});
  1. Add the --help/-h option to print the generated usage information either:
  • always add the --help/-h option, and automatically print the usage and exit the process when parsing the args (E.g. how python's builtin argparse does it); this would be a breaking change since it may conflict with other similar options implemented already.
  • add a new option to the ParseArgsConfig to enable autogenerated help option if desired
parseArgs({ 
  enableHelp: true,
  help: 'Use this command to achieve foo',
  options: {
    // ...
  }
});
  • simply provide a method to print the usage and let the user implement it themselves in userland
const { values, positionals, printUsage } = parseArgs({
  help: 'Use this command to achieve foo',
  options: {
    help: {
      type: "boolean",
      short: "h",
      help: "print command line options and exit"
    }
  }
});
if (values.help) {
  printUsage();
  process.exit(0);
}
What alternatives have you considered?

No response

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza en el punto de entrada util.parseArgs y revisa el comportamiento existente de ParseArgsConfig y ParseArgsOptionConfig. Determina qué API de generación de ayuda y qué comportamiento de --help/-h deben admitirse; el trabajo estará terminado cuando el diseño elegido esté implementado para los textos de uso de comandos y opciones.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, node.js
Área
cli
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Tranquilo
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.