From 2068a46fb18748c8e8abd3b9fd6a339993213085 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sat, 18 Apr 2026 21:48:53 +0200 Subject: [PATCH] [tutorial v1.1_150] A variable with custom validation (config and doc) --- CHANGELOG.md | 8 +++--- DOCUMENTATION.md | 10 +++---- README.md | 61 +++++++++++++++++++--------------------- config/03/output_ro.html | 21 +++++--------- tree.html | 26 ++++++++--------- 5 files changed, 58 insertions(+), 68 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8b63bfd7..8158f17c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ -# 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". | diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 3605675b..efa2570c 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -66,8 +66,8 @@ > **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". | diff --git a/README.md b/README.md index e9d6fdf3..eef3e416 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_141] A choice variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_141/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_142~1..v1.1_142)) +- [[tutorial v1.1_142] A web_address variable ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_142/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_150~1..v1.1_150)) -# [tutorial v1.1_142] A web_address variable +# [tutorial v1.1_150] A variable with custom validation -[Read the tutorial "A web_address variable " in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-web_address-variable) +[Read the tutorial "A variable with custom validation" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-variable-with-custom-validation) ## Screenshot @@ -25,25 +25,25 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_142 +git switch --detach v1.1_150 ``` ## Structure

-.
- ├── 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
- └── types
-     └── proxy
-         └── 00-type.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
+ └── types
+     └── proxy
+         └── 00-type.yml


Contents of the firefox/60-dns_over_https.yml file @@ -71,6 +71,11 @@ dns_over_https: # DNS over HTTPS custom_dns_url: description: Custom DNS URL type: web_address + validators: + - jinja: |- + {{ _.custom_dns_url.startswith("http://") }} + return_type: boolean + description: must starts with 'https://' only disabled: jinja: |- {{ _.provider is propertyerror or _.provider != 'Custom' }} @@ -178,20 +183,12 @@ dns_over_https: ```shell rougail -m firefox/ --types types/proxy --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) +> - :bell: the value "http://dns.net" is an invalid URL, must starts with 'https://' only, it will be ignored when loading from the YAML file "config/03/config.yml" +> - :stop_sign: mandatory variable but has no value *** ### Example 4 @@ -231,4 +228,4 @@ Variables: *** -- [[tutorial v1.1_150] A variable with custom validation](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_150/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_150~1..v1.1_150)) +- [[tutorial v1.1_160] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_160/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_160~1..v1.1_160)) diff --git a/config/03/output_ro.html b/config/03/output_ro.html index f3ab0717..4cdee614 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, must starts with 
+        ┃   'https://' only, 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 5eca9f76..166a1733 100644
--- a/tree.html
+++ b/tree.html
@@ -1,15 +1,15 @@
 

-.

-	├── 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

-	└── types

-	    └── proxy

-	        └── 00-type.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

+	└── types

+	    └── proxy

+	        └── 00-type.yml

 


\ No newline at end of file