From 19c5b5b3697861e15dd81dd30391b2fa05a20b18 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Tue, 6 Jan 2026 16:53:55 +0100 Subject: [PATCH] [tutorial v1.1_103] A variable with custom validation (config and doc) --- README.md | 76 +++++++++++++++++++--------------------- config/03/output_ro.html | 21 ++++------- tree.html | 20 +++++------ 3 files changed, 54 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index fe77675..676d394 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_101] A choice variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_101/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101)) +- [[tutorial v1.1_102] A web_address variable ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_102/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102)) -# [tutorial v1.1_102] A web_address variable +# [tutorial v1.1_103] A variable with custom validation -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-web_address-variable) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-with-custom-validation) ## Screenshot @@ -31,7 +31,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_102 +git switch --detach v1.1_103 ``` ## Structure @@ -39,16 +39,16 @@ git switch --detach v1.1_102

-.
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     ├── 20-manual.yml
-     ├── 30-auto.yml
-     ├── 40-no_proxy.yml
-     ├── 50-prompt_authentication.yml
-     ├── 55-proxy_dns_socks5.yml
-     └── 60-dns_over_https.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     ├── 10-manual.yml
+     ├── 20-manual.yml
+     ├── 30-auto.yml
+     ├── 40-no_proxy.yml
+     ├── 50-prompt_authentication.yml
+     ├── 55-proxy_dns_socks5.yml
+     └── 60-dns_over_https.yml


Contents of the firefox/60-dns_over_https.yml file @@ -76,6 +76,12 @@ dns_over_https: # DNS over HTTPS custom_dns_url: description: Custom DNS URL type: web_address + validators: + - jinja: |- + {% if _.custom_dns_url.startswith('http://') %} + only https is allowed + {% endif %} + description: must starts with 'https://' only disabled: jinja: |- {% if _.provider is propertyerror or _.provider != 'Custom' %} @@ -152,22 +158,22 @@ rougail -m firefox/ --modes_level basic standard advanced -o doc > **Path**: dns_over_https\ > `basic` -| Variable | Description | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dns_over_https.enable_dns_over_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.
**Default**: false | -| **dns_over_https.provider**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Use Provider.
**Choices**:
• Cloudflare **← (default)**
• NextDNS
• Custom
**Disabled**: when the variable "[Enable DNS over HTTPS](#dns_over_https.enable_dns_over_https)" has the value "false" | -| **dns_over_https.custom_dns_url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Custom DNS URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Disabled**: if "[Use Provider](#dns_over_https.provider)" is not "Custom" | +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dns_over_https.enable_dns_over_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.
**Default**: false | +| **dns_over_https.provider**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Use Provider.
**Choices**:
• Cloudflare **← (default)**
• NextDNS
• Custom
**Disabled**: when the variable "[Enable DNS over HTTPS](#dns_over_https.enable_dns_over_https)" has the value "false" | +| **dns_over_https.custom_dns_url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Custom DNS URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
• must starts with 'https://' only
**Disabled**: if "[Use Provider](#dns_over_https.provider)" is not "Custom" | ### Let's generate the changelog ```shell rougail -m firefox/ --modes_level basic standard advanced -o doc --doc.contents changelog ``` -#### New variable +#### Modified variable -| Variable | Description | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dns_over_https.custom_dns_url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Custom DNS URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Disabled**: if "[Use Provider](#dns_over_https.provider)" is not "Custom" | +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dns_over_https.custom_dns_url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Custom DNS URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
• must starts with 'https://' only
**Disabled**: if "[Use Provider](#dns_over_https.provider)" is not "Custom" | ## User datas @@ -240,20 +246,12 @@ dns_over_https: ```shell rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/03/config.yml ``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy -- :open_file_folder: dns_over_https (DNS over HTTPS) - - :notebook: enable_dns_over_https (Enable DNS over HTTPS): true ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: false) - - :notebook: provider (Use Provider): Custom ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Cloudflare) - - :notebook: custom_dns_url (Custom DNS URL): http://dns.net ← loaded from the YAML file "config/03/config.yml" +> [!CAUTION] +> +> - dns_over_https (DNS over HTTPS) +> - custom_dns_url (Custom DNS URL) +> - [#EFBF04]:bell: the value "http://dns.net" is an invalid URL, only https is allowed, it will be ignored when loading from the YAML file "config/03/config.yml"[/#EFBF04] +> - [#C23636]:stop_sign: mandatory variable but has no value[/#C23636] ### Example 4 #### config/04/config.yml @@ -287,4 +285,4 @@ Variables: - :notebook: custom_dns_url (Custom DNS URL): https://dns.net ← loaded from the YAML file "config/04/config.yml" -- [[tutorial v1.1_103] A variable with custom validation](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_103/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103)) +- [[tutorial v1.1_110] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110)) diff --git a/config/03/output_ro.html b/config/03/output_ro.html index f3ab071..3eba999 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,15 +1,8 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
-┗━━ 📂 dns_over_https (DNS over HTTPS)
-    ┣━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): true ◀ loaded from the
-    ┃   YAML file "config/03/config.yml" (⏳ false)
-    ┣━━ 📓 provider (Use Provider): Custom ◀ loaded from the YAML file 
-    ┃   "config/03/config.yml" (⏳ Cloudflare)
-    ┗━━ 📓 custom_dns_url (Custom DNS URL): http://dns.net ◀ loaded from the 
-        YAML file "config/03/config.yml"
+
🛑 Caution
+┗━━ dns_over_https (DNS over HTTPS)
+    ┗━━ custom_dns_url (Custom DNS URL)
+        ┣━━ 🔔 the value "http://dns.net" is an invalid URL, only https is 
+        ┃   allowed, it will be ignored when loading from the YAML file 
+        ┃   "config/03/config.yml"
+        ┗━━ 🛑 mandatory variable but has no value
 

diff --git a/tree.html b/tree.html
index 06f82f2..5a3b1f4 100644
--- a/tree.html
+++ b/tree.html
@@ -1,12 +1,12 @@
 

-.

-	└── firefox

-	    ├── 00-proxy.yml

-	    ├── 10-manual.yml

-	    ├── 20-manual.yml

-	    ├── 30-auto.yml

-	    ├── 40-no_proxy.yml

-	    ├── 50-prompt_authentication.yml

-	    ├── 55-proxy_dns_socks5.yml

-	    └── 60-dns_over_https.yml

+.

+	└── firefox

+	    ├── 00-proxy.yml

+	    ├── 10-manual.yml

+	    ├── 20-manual.yml

+	    ├── 30-auto.yml

+	    ├── 40-no_proxy.yml

+	    ├── 50-prompt_authentication.yml

+	    ├── 55-proxy_dns_socks5.yml

+	    └── 60-dns_over_https.yml

 


\ No newline at end of file