fix: update doc
This commit is contained in:
parent
a71b476307
commit
673c9c22fe
7 changed files with 94 additions and 26 deletions
21
README.fr.md
Normal file
21
README.fr.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
gitea: none
|
||||
include_toc: true
|
||||
---
|
||||
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)
|
||||
|
||||
## Définir des données utilisateur interactivement dans la console
|
||||
|
||||
> **🛈 Informations**
|
||||
>
|
||||
> L'utilisateur va entrer les valeurs des variables dans une interface en ligne de commande. Ces variables vont être affichées les unes après les autres, permettant à l'utilisateur de changer ou ajouter des valeurs.\
|
||||
> **Chemin** : questionary\
|
||||
> *`désactivé`*\
|
||||
> **Désactivé** : si questionary n'est pas mis dans "[Sélection pour données utilisateur](#step.user_data)"
|
||||
|
||||
| Variable | Description | Valeur par défaut | Type |
|
||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|
|
||||
| **<a id="questionary.mandatory" name="questionary.mandatory">questionary.mandatory</a>**<br/>**Ligne de commande** : <br/>• -qm, --questionary.mandatory<br/>• -nqm, --questionary.no-mandatory<br/>**Variable d'environnement** : ROUGAILCLI_QUESTIONARY.MANDATORY | Demander des valeurs uniquement pour des variables obligatoires sans valeur. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
|
||||
| **<a id="questionary.show_secrets" name="questionary.show_secrets">questionary.show_secrets</a>**<br/>**Ligne de commande** : <br/>• -qs, --questionary.show_secrets<br/>• -nqs, --questionary.no-show_secrets<br/>**Variable d'environnement** : ROUGAILCLI_QUESTIONARY.SHOW_SECRETS | Afficher les secrets plutôt que de les obscurcir. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
|
||||
|
||||
|
||||
21
README.md
21
README.md
|
|
@ -1,2 +1,21 @@
|
|||
# rougail-user-data-questionary
|
||||
---
|
||||
gitea: none
|
||||
include_toc: true
|
||||
---
|
||||
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)
|
||||
|
||||
## Define user data interactively in the console
|
||||
|
||||
> **🛈 Informations**
|
||||
>
|
||||
> The user will enter variable values in a command-line interface. The variables will be displayed one after another, allowing the user to change or add values.\
|
||||
> **Path**: questionary\
|
||||
> *`disabled`*\
|
||||
> **Disabled**: if questionary is not set in "[Select for user datas](#step.user_data)"
|
||||
|
||||
| Variable | Description | Default value | Type |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|
|
||||
| **<a id="questionary.mandatory" name="questionary.mandatory">questionary.mandatory</a>**<br/>**Command line**: <br/>• -qm, --questionary.mandatory<br/>• -nqm, --questionary.no-mandatory<br/>**Environment variable**: ROUGAILCLI_QUESTIONARY.MANDATORY | Ask values only for mandatories variables without any value. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
|
||||
| **<a id="questionary.show_secrets" name="questionary.show_secrets">questionary.show_secrets</a>**<br/>**Command line**: <br/>• -qs, --questionary.show_secrets<br/>• -nqs, --questionary.no-show_secrets<br/>**Environment variable**: ROUGAILCLI_QUESTIONARY.SHOW_SECRETS | Show secrets instead of obscuring them. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,8 +5,8 @@
|
|||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: \n"
|
||||
"POT-Creation-Date: 2025-11-26 20:48+0100\n"
|
||||
"PO-Revision-Date: 2025-11-26 20:48+0100\n"
|
||||
"POT-Creation-Date: 2025-12-02 13:40+0100\n"
|
||||
"PO-Revision-Date: 2025-12-02 13:43+0100\n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"Language: fr\n"
|
||||
|
|
@ -17,25 +17,43 @@ msgstr ""
|
|||
"X-Generator: Poedit 3.8\n"
|
||||
|
||||
#: src/rougail/user_data_questionary/config.py:32
|
||||
msgid "Define values interactivly"
|
||||
msgstr "Définir des valeurs interactivement"
|
||||
msgid "Define user data interactively in the console"
|
||||
msgstr "Définir des données utilisateur interactivement dans la console"
|
||||
|
||||
#: src/rougail/user_data_questionary/config.py:40
|
||||
#: src/rougail/user_data_questionary/config.py:33
|
||||
msgid ""
|
||||
"The user will enter variable values in a command-line interface. The "
|
||||
"variables will be displayed one after another, allowing the user to change "
|
||||
"or add values."
|
||||
msgstr ""
|
||||
"L'utilisateur va entrer les valeurs des variables dans une interface en "
|
||||
"ligne de commande. Ces variables vont être affichées les unes après les "
|
||||
"autres, permettant à l'utilisateur de changer ou ajouter des valeurs."
|
||||
|
||||
#: src/rougail/user_data_questionary/config.py:39
|
||||
msgid "if questionary is not set in \"step.user_data\""
|
||||
msgstr "si questionary n'est pas mis dans \"step.user_data\""
|
||||
|
||||
#: src/rougail/user_data_questionary/config.py:42
|
||||
msgid "Ask values only for mandatories variables without any value"
|
||||
msgstr "Demander des valeurs uniquement pour des variables obligatoires sans valeur"
|
||||
msgstr ""
|
||||
"Demander des valeurs uniquement pour des variables obligatoires sans valeur"
|
||||
|
||||
#: src/rougail/user_data_questionary/config.py:45
|
||||
#: src/rougail/user_data_questionary/config.py:47
|
||||
msgid "Show secrets instead of obscuring them"
|
||||
msgstr "Afficher les secrets plutôt que des obscurcir"
|
||||
msgstr "Afficher les secrets plutôt que de les obscurcir"
|
||||
|
||||
#: src/rougail/user_data_questionary/data.py:59
|
||||
#: src/rougail/user_data_questionary/data.py:61
|
||||
msgid "questionary is not set in step.user_data"
|
||||
msgstr "questionary n'est pas mis dans step.user_data"
|
||||
|
||||
#: src/rougail/user_data_questionary/data.py:226
|
||||
#: src/rougail/user_data_questionary/data.py:229
|
||||
msgid "Not a valid {0}"
|
||||
msgstr "N'est pas un valide {0}"
|
||||
|
||||
#: src/rougail/user_data_questionary/data.py:250
|
||||
msgid "Value must not be empty"
|
||||
msgstr "La valeur ne doit pas être vide"
|
||||
|
||||
#: src/rougail/user_data_questionary/data.py:235
|
||||
msgid "Not a valid {0}"
|
||||
msgstr "N'est pas un valide {0}"
|
||||
#~ msgid "when questionary is not set in \"step.user_data\""
|
||||
#~ msgstr "lorsque questionary n'est pas mis dans step.user_data"
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: PACKAGE VERSION\n"
|
||||
"POT-Creation-Date: 2025-11-26 20:48+0100\n"
|
||||
"POT-Creation-Date: 2025-12-02 13:43+0100\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
|
|
@ -16,26 +16,34 @@ msgstr ""
|
|||
|
||||
|
||||
#: src/rougail/user_data_questionary/config.py:32
|
||||
msgid "Define values interactivly"
|
||||
msgid "Define user data interactively in the console"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/user_data_questionary/config.py:40
|
||||
#: src/rougail/user_data_questionary/config.py:33
|
||||
msgid "The user will enter variable values in a command-line interface. The variables will be displayed one after another, allowing the user to change or add values."
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/user_data_questionary/config.py:39
|
||||
msgid "if questionary is not set in \"step.user_data\""
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/user_data_questionary/config.py:42
|
||||
msgid "Ask values only for mandatories variables without any value"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/user_data_questionary/config.py:45
|
||||
#: src/rougail/user_data_questionary/config.py:47
|
||||
msgid "Show secrets instead of obscuring them"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/user_data_questionary/data.py:59
|
||||
#: src/rougail/user_data_questionary/data.py:61
|
||||
msgid "questionary is not set in step.user_data"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/user_data_questionary/data.py:226
|
||||
msgid "Value must not be empty"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/user_data_questionary/data.py:235
|
||||
#: src/rougail/user_data_questionary/data.py:229
|
||||
msgid "Not a valid {0}"
|
||||
msgstr ""
|
||||
|
||||
#: src/rougail/user_data_questionary/data.py:250
|
||||
msgid "Value must not be empty"
|
||||
msgstr ""
|
||||
|
||||
|
|
|
|||
|
|
@ -29,12 +29,14 @@ def get_rougail_config(
|
|||
"""generate rougail config"""
|
||||
options = f"""
|
||||
questionary:
|
||||
description: {_("Define values interactivly")}
|
||||
description: {_("Define user data interactively in the console")}
|
||||
help: {_("The user will enter variable values in a command-line interface. The variables will be displayed one after another, allowing the user to change or add values.")}
|
||||
disabled:
|
||||
jinja: |
|
||||
{{% if step.user_data is not propertyerror and 'questionary' not in step.user_data %}}
|
||||
disabled
|
||||
{{% endif %}}
|
||||
description: {_('if questionary is not set in "step.user_data"')}
|
||||
|
||||
mandatory:
|
||||
description: {_("Ask values only for mandatories variables without any value")}
|
||||
|
|
|
|||
|
|
@ -177,7 +177,7 @@ class RougailUserDataQuestionary:
|
|||
return text
|
||||
|
||||
def _display_questionary_frozen(self, args: str, default: any) -> None:
|
||||
qprint(" " + args + str(default))
|
||||
qprint(" " + args + " " + str(default))
|
||||
|
||||
|
||||
class RougailValidator(Validator):
|
||||
|
|
|
|||
Binary file not shown.
Loading…
Reference in a new issue