la ligne de commande-args vaut le détour!
Vous pouvez définir des options en utilisant les principales normes de notation (en savoir plus ). Ces commandes sont toutes équivalentes, définissant les mêmes valeurs:
$ example --verbose --timeout=1000 --src one.js --src two.js
$ example --verbose --timeout 1000 --src one.js two.js
$ example -vt 1000 --src one.js two.js
$ example -vt 1000 one.js two.js
Pour accéder aux valeurs, créez d'abord une liste de définitions d'options décrivant les options acceptées par votre application. La type
propriété est une fonction de définition (la valeur fournie est transmise par ce biais), vous donnant un contrôle total sur la valeur reçue.
const optionDefinitions = [
{ name: 'verbose', alias: 'v', type: Boolean },
{ name: 'src', type: String, multiple: true, defaultOption: true },
{ name: 'timeout', alias: 't', type: Number }
]
Ensuite, analysez les options à l'aide de commandLineArgs () :
const commandLineArgs = require('command-line-args')
const options = commandLineArgs(optionDefinitions)
options
ressemble maintenant à ceci:
{
src: [
'one.js',
'two.js'
],
verbose: true,
timeout: 1000
}
Utilisation avancée
Outre l'utilisation typique ci-dessus, vous pouvez configurer des arguments de ligne de commande pour accepter des formes de syntaxe plus avancées.
Syntaxe basée sur les commandes (style git) sous la forme:
$ executable <command> [options]
Par exemple.
$ git commit --squash -m "This is my commit message"
Syntaxe des commandes et sous-commandes (style docker) sous la forme:
$ executable <command> [options] <sub-command> [options]
Par exemple.
$ docker run --detached --image centos bash -c yum install -y httpd
Génération de guide d'utilisation
Un guide d'utilisation (généralement imprimé lorsqu'il --help
est défini) peut être généré à l'aide de l'utilisation de la ligne de commande . Consultez les exemples ci-dessous et lisez la documentation pour savoir comment les créer.
Un exemple de guide d'utilisation typique.
Le guide d'utilisation de polymère-cli est un bon exemple réel.
Lectures complémentaires
Il y a beaucoup plus à apprendre, veuillez consulter le wiki pour des exemples et de la documentation.