meow は、フラグを解析して整った --help や --version メッセージを出力する Node.js 向けの軽量 CLI ヘルパーです。
基本的なセットアップ
const meow = require('meow');
const cli = meow(`
Usage:
$ mycli [input] [options]
Options:
--lang, -l Specify preferred language (default: en)
--verbose, -v Enable debug log output
--help, -h Show this help screen
--version Print version and exit
Examples:
$ mycli index.js --lang es
`, {
flags: {
lang: {
type: 'string',
shortFlag: 'l',
default: 'en'
},
verbose: {
type: 'boolean',
shortFlag: 'v'
}
}
});
解析結果へのアクセス
// Parsed flags (automatically normalized to camelCase)
console.log(cli.flags);
// => { lang: 'en', verbose: true }
// Positional non-flag arguments
console.log(cli.input);
// => ['index.js']
// Display help screen and exit
cli.showHelp();
設定オプション
| オプション | 型 | 説明 |
|---|---|---|
flags |
Object | フラグ名とその型(string、boolean、number)のマップ |
autoHelp |
Boolean | --help を自動的に処理する(デフォルト:true) |
autoVersion |
Boolean | --version を自動的に処理する(デフォルト:true) |
description |
String | package.json の description を上書き指定する |
allowUnknownFlags |
Boolean | flags スキーマに未定義のフラグを許可する |