sfcode
An Online Competing and Development Environment
|
COA — парсер параметров командной строки, позволяющий извлечь максимум пользы от формального API вашей программы. Как только вы опишете определение в терминах команд, параметров и аргументов, вы автоматически получите:
Команда — сущность верхнего уровня. У команды могут быть определены параметры и аргументы.
Возвращает объект, который можно использовать в других программах. Подкоманды являются методами этого объекта.
Определяет канонический идентификатор команды, используемый в вызовах API.
</strong> | String _name имя команды |
this
экземпляр команды (для поддержки цепочки методов)Определяет название команды, используемый в текстовых сообщениях.
</strong> | String _title название команды |
this
экземпляр команды (для поддержки цепочки методов)Создает новую подкоманду или добавляет ранее определенную подкоманду к текущей команде.
</strong> | COA.Cmd [cmd] экземпляр ранее определенной подкоманды |
Создает параметр для текущей команды.
new
экземпляр параметраСоздает аргумент для текущей команды.
new
экземпляр аргументаДобавляет (или создает) действие для текущей команды.
</strong> | Function act функция, выполняемая в контексте экземпляра текущей команды и принимающая следующие параметры:
|
</strong> | *{Boolean}* [force=false] флаг, назначающий немедленное исполнение вместо добавления к списку существующих действий |
this
экземпляр команды (для поддержки цепочки методов)Исполняет функцию с переданными аргументами в контексте экземпляра текущей команды.
</strong> | Function fn |
</strong> | Array args |
this
экземпляр команды (для поддержки цепочки методов)Назначает кастомную функцию автодополнения для текущей команды.
</strong> | Function fn функция-генератор автодополнения, исполняемая в контексте текущей команды. Принимает параметры:
|
this
экземпляр команды (для поддержки цепочки методов)Ставит флаг поддержки справки командной строки, т.е. вызов команды с параметрами -h –help выводит справку по работе с командой.
this
экземпляр команды (для поддержки цепочки методов)Добавляет поддержку автодополнения командной строки. Добавляется подкоманда "completion", которая выполняет все необходимые действия.
Может быть добавлен только для главной команды.
this
экземпляр команды (для поддержки цепочки методов)Возвращает текст справки по использованию команды для текущего экземпляра.
usage
Текст справки по использованиюРазбирает аргументы из значения, возвращаемого NodeJS process.argv, и запускает текущую программу, т.е. вызывает process.exit после завершения всех действий.
</strong> | Array argv |
this
экземпляр команды (для поддержки цепочки методов)Исполняет переданную (или текущую) команду с указанными параметрами и аргументами.
</strong> | String|Array cmds подкоманда для исполнения (необязательно) |
</strong> | Object opts параметры, передаваемые команде (необязательно) |
</strong> | Object args аргументы, передаваемые команде (необязательно) |
Проваливает промисы, возращенные в действиях.
Используется в .act() для возврата с ошибкой.
</strong> | Object reason причина провалаВы можете определить метод toString() и свойство toString() объекта причины провала. |
Завершает цепочку методов текущей подкоманды и возвращает экземпляр родительской команды.
parent
родительская командаПараметр — именованная сущность. У параметра может быть определено короткое или длинное имя для использования из командной строки.