# Global installation, in case of an installation error, it's necessary to specify before the command `sudo`
$ sudo npm install -g wcj 

# Display help
$ wcj -h
  Usage: wcj my personal command for fun![options] <package>

  Commands:

    resume|rs [options] [cmd]    Details about my resume!

  Options:

    -h, --help     output usage information
    -V, --version  output version number

# Display help for subcommand
$ wcj rs -h

  Usage: resume|rs [options] [cmd]

    Details about my resume!

  Options:

    -h, --help              output usage information
    -b, --basicinfo [type]  basic information
    -e, --education [type]  education

  Description of basicinfo:

    preview Preview of the resume

-b, --basicinfo базовая информация
   name : имя
   height : рост
   dateOfBirth : дата рождения
   workExperience : опыт работы
   mobile : мобильный телефон
   telephone : домашний телефон
   email : адрес электронной почты
   residency : место жительства
   currentSituation : текущее положение
   currentCity : город проживания
   nation : страна
   region : регион
   postalCode : почтовый индекс
   ID : номер удостоверения личности
   website : личный сайт
   maritalStatus : семейное положение
   politicalStatus : политическое положение
-e, --education образование

$ which node
/usr/local/bin/node  

$ node -v
v0.10.36

$ mkdir wcj # создаем каталог
$ cd wcj && mkdir bin
$ npm init # инициализируем файл package.json

#!/usr/bin/env node  
var fs = require("fs"), 
    path = process.cwd();
``````javascript
var run = function (obj) {
    if (obj[0] === '-v') {
        console.log('версия 1.0.0');
    } else if (obj[0] === '-h') {
        console.log('Использование:');
        console.log('  -v --версия [показывает версию]');
    } else {
        fs.readdir(path, function (err, files) {
            if (err) {
                return console.log(err);
            }
            for (var i = 0; i < files.length; i += 1) {
                console.log(files[i]);
            }
        });
    }
};
```// Получение аргументов после первого аргумента, разделенных пробелами
run(process.argv.slice(2));

Запуск `node bin/wcj.js` отображает все файлы и папки в текущей директории. Этот скрипт действительно работает. Дополнительная информация о команде `npm link` доступна [здесь](https://docs.npmjs.com/cli/link).

В поле `bin` файла `package.json` указано, что команда `wcj` связана с вашим скриптом `bin/wcj.js`. [Дополнительно про bin](https://docs.npmjs.com/files/package.json#bin)

Этот инструмент использует правила версионирования [semver](http://semver.org/lang/ru-RU/).

[Пример исходного кода](https://github.com/jaywcjlove/wcj/blob/master/examples/ls.js)

## Глобальная установка и запуск

> Убедитесь, что вы добавили поле `bin` в файл `package.json`. Затем откройте консоль и перейдите в директорию `wcj`.

### Установка

Если при выполнении команды в проектной директории возникают проблемы, можно установить модуль глобально:

### Связывание

Или вы можете использовать команду `npm link`, которая автоматически создаст глобальную символьную ссылку, после чего вы сможете использовать свою команду.```shell
$ wcj
# README.md
# bin
# package.json

$ wcj -v
# Версия 1.0.0

$ wcj -h 
# Использование:
#  -v --version [показывает версию]

npm link
npm ERR! Darwin 14.3.0
npm ERR! argv "node" "/usr/local/bin/npm" "link"
npm ERR! node v0.10.36
npm ERR! npm  v2.7.1
npm ERR! path /usr/local/bin/wcj
npm ERR! code EEXIST

npm ERR! Refusing to delete: /usr/local/bin/wcj not in /Applications/XAMPP/xamppfiles/htdocs/git/github.com/myJS/wcj
File exists: /usr/local/bin/wcj
Move it away, and try again.

npm publish

sudo npm install -g wcj

Основные преимущества Commander заключаются в следующем:

Автоматическое логирование кода, автоматическая генерация справочной информации, объединение коротких опций ("-A -B -C" == "-ABC"), установка значений по умолчанию, обязательные опции, анализатор команд, поддержка запросов

## API

`Option()`: Инициализирует объект с пользовательской опцией, задает "ключевые слова" и "описание"
`Command()`: Инициализирует объект с параметрами командной строки, получает данные из командной строки
`Command#command()`: Определяет имя команды
`Command#action()`: Регистрирует обратный вызов функции
`Command#option()`: Определяет параметры, требуется задать "ключевые слова" и "описание", ключевые слова включают "краткие" и "полные" формы, разделенные запятой, вертикальной чертой, пробелами
`Command#parse()`: Анализирует параметры командной строки argv
`Command#description()`: Устанавливает значение description
`Command#usage()`: Устанавливает значение usage

Ссылка: [официальная документация примеров](http://tj.github.io/commander.js)

## Установка commander

## Опция

Внутренние опции Built-in option, Commander предоставляет по умолчанию опцию `-h`.

```js
#!/usr/bin/env node
var program = require("commander");
program
  .version('0.0.1')
  .option("-r, --resume", "резюме");
program.parse(process.argv);

    -V, --version  выводит номер версии
    -r, --resume   резюме

program
  .version('0.0.1')
  .option('-r|--resume', 'резюме');
program.parse(process.argv);

if (program.resume) {
    console.log('резюме - '
        + 'это моё резюме!'
    );
}

./bin/wcj.js --res

## Выдает следующее сообщение
ошибка: неизвестный параметр '--res'

#!/usr/bin/env node
program
    .allowUnknownOption()
    .version('0.0.1')
    .option('-r, --resume', 'резюме');

program.parse(process.argv);
// Пропущены некоторые детали...

```## Типы параметров

Поддерживаемые типы параметров командами включают `required`, `optional` и `boolean`.

### required и optional

Первый аргумент параметра также может указывать тип параметра, разделителем является `|` или `,`.

- `<lang>` обязательный параметр, требует значения после себя, иначе программа выбросит ошибку.
- `[db]` необязательный параметр, который может иметь значение или нет.

```js
#!/usr/bin/env node  
var program = require('commander');
program
    .allowUnknownOption()
    .version('0.0.1')
    .option('-r, --resume', 'резюме')
    .option('-l, --language <lang>', 'этот язык, которым я владею.')
    .option('-d, --database [db]', 'эта база данных, которую я знаю', 'MySQL')
    .parse(process.argv);

if (program.resume) {
    console.log('резюме'
        + '-'
        + 'это мое резюме!');
}

if (program.language) {
    console.log('язык: `' + program.language + '`');
}
if (program.database) {
    console.log('база данных: `' + program.database + '`');
}

./bin/wcj.js -l python
## вывод
язык: `python`
база данных: `MySQL`

./bin/wcj.js -l
## вывод
ошибка: аргумент для опции `-l, --language <lang>` отсутствует

Когда параметр `-d` не указан, его значение по умолчанию равно `true`.

## Автоматическая помощь (--help)

Библиотека Commander автоматически генерирует информацию о помощи на основе настроенных опций и подкоманд.

### Пользовательская помощь

Вы можете использовать событие `--help`, чтобы вывести дополнительную информацию о помощи, как это сделано ниже для команды `fe`:

```js
// должно быть до .parse(), так как метод emit() ноды выполняется сразу
программа.on('--help', function () {
    console.log('  Пример использования:');
    console.log('');
    console.log('    Вывод команды  wcj -d');
    console.log('    Вывод команды  wcj -l python');
    console.log('');
});

программа.parse(process.argv);

./bin/wcj.js -h

  Использование: wcj [опции]

  Опции:

    -h, --help              вывод информации о помощи
    -d, --no-дата           показать текущее время
    -l, --язык <lang>       Этот язык мне знаком.
    -b, --база_данных [db]  Это моя любимая база данных.

  Пример использования:

    Вывод команды  wcj -d
    Вывод команды  wcj -l python

#!/usr/bin/env node 
var программа = require('commander');
var appInfo = require('./../package.json');

программа
    .version(appInfo.version)
    .usage('это мои личные команды для игры! [опции] <пакет>')
```
Пример выполнения команд в указанном выше стиле Git:

```javascript
// Поддержка субкоманд в стиле Git
программа
    // Определение субкоманды
    .command('резюме <cmd>')
    // Краткая форма команды
    .alias('рс')
    // Описание команды
    .description('Здесь содержится информация о моем резюме!')
    // Опции для команды резюме
    .option('-н, --имя <режим>', 'Отображает мое имя')
    // Регистрация обратного вызова
    .action(function(cmd, options) {
        let nm = typeof options.имя === 'string' ? options.имя : ''

        console.log('резюме "%s" использует режим "%s"', cmd, nm);
    })
    .on('--help', function() {
        // Вывод справочной информации для субкоманд
        console.log(' Примеры использования:')
        console.log(' $ ./bin/wcj.js резюме ss -н аaaaa')
        console.log(' $ ./bin/wcj.js резюме ss')
        console.log()
    })

программа.parse(process.argv)
```

Пример вывода при выполнении команд:

```shell
$ ./bin/wcj.js резюме ss -н аaaaa

# Вывод:
резюме "ss" использует режим "аaaaa"

$ ./bin/wcj.js резюме ss
# Вывод:
резюме "ss" использует режим ""
```

## Обработка событий

Название каждого события должно совпадать с названием команды, `--help` — это событие по умолчанию.

```shell
программа.on('--help', function(argv, test) {
    process.exit(1)
})
```

# Yargs

Командная строковая библиотека Yargs обеспечивает взаимодействие вашего приложения [Yargs для GitHub](https://github.com/bcoe/yargs)
``````js
var argv = require('yargs').argv;
if (argv.l === 'zh-cn') {
    console.log('Китайский сайт!');
} else if (argv.l === 'en') {
    console.log('Английский сайт!');
}
```

Использование:

```js
var argv = require('yargs').argv;
if (argv.l === 'zh-cn') {
    console.log('Китайский сайт!');
} else if (argv.l === 'en') {
    console.log('Английский сайт!');
}
```

# Дополнительные материалы для чтения

Первый маленький пример был создан после прочтения множества статей, вот некоторые из них:

- [Создание командной строки с помощью Node.js](http://binbinliao.com/programming/commandline-nodejs.html)
- [Командная строка с использованием Node.js](http://cruft.io/posts/node-command-line-utilities/)
- [Создание командной строки с помощью Node.js](http://zdan.me/post/Yöntemleri.html)
- [commander.js](https://github.com/tj/commander.js)
- [Примеры использования commander.js](http://tj.github.io/commander.js/)
- [node-optimist](https://github.com/substack/node-optimist)
```