autumn-cli

Name: autumn-cli
Author: yellow-hammer

37stars4forks

How to install autumn-cli?

yellow-hammer/skills-onescript/autumn-cli

$npx -y skills add yellow-hammer/skills-onescript --skill autumn-cli

Installs into the current project.

Summary

Создаёт консольные приложения с командами и подкомандами на autumn-cli для OneScript. Использовать при CLI на OneScript, командах приложения, аргументах и опциях.

Files · 1

View on GitHub

SKILL.md

1	# autumn-cli
2
3	Обёртка над библиотекой cli для создания консольных приложений на фреймворке Autumn. Команды, подкоманды, аргументы и опции описываются аннотациями на классах.
4
5	## Подключение и запуск
6
7	Точка входа (например `main.os`):
8
9	```bsl
10	#Использовать autumn
11	#Использовать autumn-cli
12	#Использовать "Каталог/С/Классами/Команд"
13
14	Поделка = Новый Поделка();
15	Поделка.ЗапуститьПриложение();
16	```
17
18	Каталог с командами должен содержать классы с аннотацией `&КомандаПриложения` или `&ПодкомандаПриложения`.
19
20	## Команда приложения
21
22	Класс объявляется командой аннотацией на конструкторе. Метод, выполняемый при вызове команды, помечается `&ВыполнениеКоманды`.
23
24	```bsl
25	&Аргумент(Имя = "ARG", Описание = "Значение числа")
26	&ТЧисло
27	Перем ПереданноеЧисло;
28
29	&КомандаПриложения(Имя = "p plus", Описание = "Прибавляет 10 к заданному числу")
30	Процедура ПриСозданииОбъекта()
31	КонецПроцедуры
32
33	&ВыполнениеКоманды
34	Процедура ВывестиРезультатСложения() Экспорт
35	Результат = ПереданноеЧисло + 10;
36	Сообщить("Результат сложения: " + Результат);
37	КонецПроцедуры
38	```
39
40	Параметры аннотации `&КомандаПриложения`: `Имя` — имя в CLI (например `"p plus"`), `Описание` — текст справки. Повторяемый параметр `Подкоманда` — имена желудей подкоманд.
41
42	## Аргументы и опции
43
44	- Аргумент — позиционный аргумент: переменная с `&Аргумент(Имя = "ARG", Описание = "...")`.
45	- Опция — именованный параметр: переменная с `&Опция(Имя = "n name", Описание = "Имя пользователя")`.
46
47	Пример опции:
48
49	```bsl
50	&Опция(Имя = "n name", Описание = "Имя пользователя")
51	Перем ИмяПользователя;
52
53	&КомандаПриложения(Имя = "H hello", Описание = "Поздоровается с пользователем")
54	Процедура ПриСозданииОбъекта()
55	КонецПроцедуры
56
57	&ВыполнениеКоманды
58	Процедура ПоприветствоватьПользователя() Экспорт
59	Сообщить("Привет " + ИмяПользователя + "!");
60	КонецПроцедуры
61	```
62
63	## Типы аргументов и опций
64
65	Аннотации типа для полей: `&ТЧисло`, `&ТСтрока`, `&ТБулево`, `&ТДата`, `&ТМассивДат`, `&ТМассивЧисел`, `&ТМассивСтрок`, `&ТПеречисление`. Для булева также `&Флаговый`, `&Флаг`.
66
67	Дополнительно: `&ВОкружении("ИМЯ_ПЕРЕМЕННОЙ")`, `&ПоУмолчанию("значение")`, `&СкрытьВСправке`, `&Обязательный`, `&Описание`, `&ПодробноеОписание`, `&Псевдоним`, `&Перечисление` с параметрами Имя/Значение/Описание.
68
69	## Подкоманды
70
71	Родительская команда перечисляет подкоманды через повторяемый параметр `Подкоманда`:
72
73	```bsl
74	&КомандаПриложения(Имя = "d date", Описание = "Выводит дату",
75	Подкоманда = "ПодкомандаДень",
76	Подкоманда = "ПодкомандаМесяц"
77	)
78	Процедура ПриСозданииОбъекта()
79	КонецПроцедуры
80	```
81
82	Класс подкоманды:
83
84	```bsl
85	&ПодкомандаПриложения(Имя = "day", Описание = "Выводит дату - начало дня")
86	Процедура ПриСозданииОбъекта()
87	КонецПроцедуры
88
89	&ВыполнениеКоманды
90	Процедура СообщитьДень() Экспорт
91	Сообщить(НачалоДня(ТекущаяДата()));
92	КонецПроцедуры
93	```
94
95	У `&ПодкомандаПриложения` те же параметры, что и у `&КомандаПриложения` (Идентификатор, Имя, Описание, Подкоманда, ДобавлятьАннотациюЖелудь).
96
97	## Имя и версия приложения
98
99	Вариант 1 — файл `autumn-properties.json` в каталоге проекта:
100
101	```json
102	{
103	"cli": {
104	"ИмяПриложения": "cli_test",
105	"ПолноеИмяПриложения": "cli_test v%{cli.ВерсияПриложения}",
106	"ВерсияПриложения": "1.0.1"
107	}
108	}
109	```
110
111	Вариант 2 — желудь с интерфейсом описания приложения в каталоге команд:
112
113	```bsl
114	&Желудь("ОписаниеКонсольногоПриложения")
115	&Верховный
116	Процедура ПриСозданииОбъекта()
117	КонецПроцедуры
118
119	Функция ИмяПриложения() Экспорт
120	Возврат "demo-cli";
121	КонецФункции
122
123	Функция ПолноеИмяПриложения() Экспорт
124	Возврат "Демонстрационное консольное приложение";
125	КонецФункции
126
127	Функция ВерсияПриложения() Экспорт
128	Возврат "1.0";
129	КонецФункции
130	```
131
132	## Миграция с чистой cli
133
134	Существующие команды с методами `ОписаниеКоманды` и `ВыполнитьКоманду` можно не переписывать: добавить аннотации `&КомандаПриложения`/`&ПодкомандаПриложения` и оставить эти методы — фреймворк их использует. Либо обернуть в Дуб с &Завязь и возвращать экземпляр легаси-класса.
135
136	Документация: [autumn-library.github.io/autumn-cli](https://autumn-library.github.io/autumn-cli).

People who liked this also viewed

6 picks

Type

autumn-cli

37stars4forks

View on GitHub

How to install autumn-cli?

yellow-hammer/skills-onescript/autumn-cli

$npx -y skills add yellow-hammer/skills-onescript --skill autumn-cli

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# autumn-cli
2
3	Обёртка над библиотекой cli для создания консольных приложений на фреймворке Autumn. Команды, подкоманды, аргументы и опции описываются аннотациями на классах.
4
5	## Подключение и запуск
6
7	Точка входа (например `main.os`):
8
9	```bsl
10	#Использовать autumn
11	#Использовать autumn-cli
12	#Использовать "Каталог/С/Классами/Команд"
13
14	Поделка = Новый Поделка();
15	Поделка.ЗапуститьПриложение();
16	```
17
18	Каталог с командами должен содержать классы с аннотацией `&КомандаПриложения` или `&ПодкомандаПриложения`.
19
20	## Команда приложения
21
22	Класс объявляется командой аннотацией на конструкторе. Метод, выполняемый при вызове команды, помечается `&ВыполнениеКоманды`.
23
24	```bsl
25	&Аргумент(Имя = "ARG", Описание = "Значение числа")
26	&ТЧисло
27	Перем ПереданноеЧисло;
28
29	&КомандаПриложения(Имя = "p plus", Описание = "Прибавляет 10 к заданному числу")
30	Процедура ПриСозданииОбъекта()
31	КонецПроцедуры
32
33	&ВыполнениеКоманды
34	Процедура ВывестиРезультатСложения() Экспорт
35	Результат = ПереданноеЧисло + 10;
36	Сообщить("Результат сложения: " + Результат);
37	КонецПроцедуры
38	```
39
40	Параметры аннотации `&КомандаПриложения`: `Имя` — имя в CLI (например `"p plus"`), `Описание` — текст справки. Повторяемый параметр `Подкоманда` — имена желудей подкоманд.
41
42	## Аргументы и опции
43
44	- Аргумент — позиционный аргумент: переменная с `&Аргумент(Имя = "ARG", Описание = "...")`.
45	- Опция — именованный параметр: переменная с `&Опция(Имя = "n name", Описание = "Имя пользователя")`.
46
47	Пример опции:
48
49	```bsl
50	&Опция(Имя = "n name", Описание = "Имя пользователя")
51	Перем ИмяПользователя;
52
53	&КомандаПриложения(Имя = "H hello", Описание = "Поздоровается с пользователем")
54	Процедура ПриСозданииОбъекта()
55	КонецПроцедуры
56
57	&ВыполнениеКоманды
58	Процедура ПоприветствоватьПользователя() Экспорт
59	Сообщить("Привет " + ИмяПользователя + "!");
60	КонецПроцедуры
61	```
62
63	## Типы аргументов и опций
64
65	Аннотации типа для полей: `&ТЧисло`, `&ТСтрока`, `&ТБулево`, `&ТДата`, `&ТМассивДат`, `&ТМассивЧисел`, `&ТМассивСтрок`, `&ТПеречисление`. Для булева также `&Флаговый`, `&Флаг`.
66
67	Дополнительно: `&ВОкружении("ИМЯ_ПЕРЕМЕННОЙ")`, `&ПоУмолчанию("значение")`, `&СкрытьВСправке`, `&Обязательный`, `&Описание`, `&ПодробноеОписание`, `&Псевдоним`, `&Перечисление` с параметрами Имя/Значение/Описание.
68
69	## Подкоманды
70
71	Родительская команда перечисляет подкоманды через повторяемый параметр `Подкоманда`:
72
73	```bsl
74	&КомандаПриложения(Имя = "d date", Описание = "Выводит дату",
75	Подкоманда = "ПодкомандаДень",
76	Подкоманда = "ПодкомандаМесяц"
77	)
78	Процедура ПриСозданииОбъекта()
79	КонецПроцедуры
80	```
81
82	Класс подкоманды:
83
84	```bsl
85	&ПодкомандаПриложения(Имя = "day", Описание = "Выводит дату - начало дня")
86	Процедура ПриСозданииОбъекта()
87	КонецПроцедуры
88
89	&ВыполнениеКоманды
90	Процедура СообщитьДень() Экспорт
91	Сообщить(НачалоДня(ТекущаяДата()));
92	КонецПроцедуры
93	```
94
95	У `&ПодкомандаПриложения` те же параметры, что и у `&КомандаПриложения` (Идентификатор, Имя, Описание, Подкоманда, ДобавлятьАннотациюЖелудь).
96
97	## Имя и версия приложения
98
99	Вариант 1 — файл `autumn-properties.json` в каталоге проекта:
100
101	```json
102	{
103	"cli": {
104	"ИмяПриложения": "cli_test",
105	"ПолноеИмяПриложения": "cli_test v%{cli.ВерсияПриложения}",
106	"ВерсияПриложения": "1.0.1"
107	}
108	}
109	```
110
111	Вариант 2 — желудь с интерфейсом описания приложения в каталоге команд:
112
113	```bsl
114	&Желудь("ОписаниеКонсольногоПриложения")
115	&Верховный
116	Процедура ПриСозданииОбъекта()
117	КонецПроцедуры
118
119	Функция ИмяПриложения() Экспорт
120	Возврат "demo-cli";
121	КонецФункции
122
123	Функция ПолноеИмяПриложения() Экспорт
124	Возврат "Демонстрационное консольное приложение";
125	КонецФункции
126
127	Функция ВерсияПриложения() Экспорт
128	Возврат "1.0";
129	КонецФункции
130	```
131
132	## Миграция с чистой cli
133
134	Существующие команды с методами `ОписаниеКоманды` и `ВыполнитьКоманду` можно не переписывать: добавить аннотации `&КомандаПриложения`/`&ПодкомандаПриложения` и оставить эти методы — фреймворк их использует. Либо обернуть в Дуб с &Завязь и возвращать экземпляр легаси-класса.
135
136	Документация: [autumn-library.github.io/autumn-cli](https://autumn-library.github.io/autumn-cli).

People who liked this also viewed

6 picks

Type