Краткий справочник

Шпаргалка по Meow CLI Helper

Краткий справочник по Meow для Node.js: минималистичный помощник CLI, определение опций, типы флагов, преобразование в camelCase и справка.

· Опубликовано

meow — лёгкий CLI-помощник для Node.js, который разбирает флаги и формирует аккуратные сообщения --help и --version.

Базовая настройка

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
allowUnknownFlags Boolean Разрешить флаги, не описанные в схеме flags

Ссылки

Связанные темы