mirror of
https://github.com/koloideal/Argenta.git
synced 2026-06-10 10:05:28 +03:00
docs
This commit is contained in:
@@ -5,6 +5,8 @@
|
||||
|
||||
Флаги (или параметры) — это специальные аргументы, которые конечный юзер может добавлять к командам, чтобы управлять их поведением.
|
||||
|
||||
-----
|
||||
|
||||
Синтаксис флагов
|
||||
-----------------
|
||||
|
||||
@@ -17,6 +19,8 @@
|
||||
То есть, у флага обязательно должен быть префикс, который может быть одним, двум или трем минусам. После префикса следует имя флага, без
|
||||
пробела, после, через пробел, идёт значение флага, если оно есть.
|
||||
|
||||
-----
|
||||
|
||||
Два типа флагов
|
||||
---------------
|
||||
|
||||
@@ -27,6 +31,8 @@
|
||||
|
||||
При регистрации флага вы можете указать допустимые для него значения, по умолчанию любое введённое значение для флага будет валидным. Допустимые значения можно указать различными способами:
|
||||
|
||||
-----
|
||||
|
||||
Ограничение по списку возможных значений
|
||||
----------------------------------------
|
||||
|
||||
@@ -37,12 +43,15 @@
|
||||
Предположим, у вас есть флаг ``--format``, который может принимать только значения ``json`` или ``xml``.
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
|
||||
# Эта команда сработает
|
||||
export --format json
|
||||
|
||||
# А эта вызовет ошибку валидации, так как "csv" нет в списке разрешённых
|
||||
export --format csv
|
||||
|
||||
-----
|
||||
|
||||
Проверка с помощью регулярных выражений
|
||||
-----------------------------------------
|
||||
@@ -54,6 +63,7 @@
|
||||
Допустим, флаг ``--email`` должен принимать только корректные email-адреса.
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
|
||||
# Сработает, так как значение соответствует формату email
|
||||
send --email "user@example.com"
|
||||
|
||||
Reference in New Issue
Block a user