コマンドライン引数は一見の価値があります!
メインの表記基準を使用してオプションを設定できます(詳細)。これらのコマンドはすべて同等で、同じ値を設定します。
$ 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
値にアクセスするには、まず、アプリケーションが受け入れるオプションを説明するオプション定義のリストを作成します。type
プロパティは、あなたに受け取った値を完全に制御を与えるsetter関数(これを通過する供給値)、です。
const optionDefinitions = [
{ name: 'verbose', alias: 'v', type: Boolean },
{ name: 'src', type: String, multiple: true, defaultOption: true },
{ name: 'timeout', alias: 't', type: Number }
]
次に、commandLineArgs()を使用してオプションを解析します。
const commandLineArgs = require('command-line-args')
const options = commandLineArgs(optionDefinitions)
options
これは次のようになります。
{
src: [
'one.js',
'two.js'
],
verbose: true,
timeout: 1000
}
高度な使用法
上記の典型的な使用法に加えて、より高度な構文形式を受け入れるようにコマンドライン引数を構成できます。
次の形式のコマンドベースの構文(gitスタイル):
$ executable <command> [options]
例えば。
$ git commit --squash -m "This is my commit message"
次の形式のコマンドおよびサブコマンド構文(dockerスタイル)。
$ executable <command> [options] <sub-command> [options]
例えば。
$ docker run --detached --image centos bash -c yum install -y httpd
使用ガイドの生成
使用ガイド(通常、--help
が設定されている場合に印刷されます)は、command-line-usageを使用して生成できます。以下の例を参照し、ドキュメントを読んでください作成方法の説明についてをおください。
典型的な使用ガイドの例。
ポリマー-CLIの使用ガイドは良い現実の例です。
参考文献
学ぶべきことはまだたくさんあります。例とドキュメントについてはwikiを参照してください。