diff --git a/README.md b/README.md index 0e6ea1ca..db7c6514 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_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_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_103)] A variable with custom validation +# [tutorial v1.1_110)] Namespace -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-with-custom-validation) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#namespace) ## 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_103 +git switch --detach v1.1_110 ``` ## Structure @@ -39,55 +39,25 @@ git switch --detach v1.1_103

-.
- └── 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
+     └── empty.yml


-Contents of the firefox/60-dns_over_https.yml file +Contents of the firefox/empty.yml file ```yml %YAML 1.2 --- version: 1.1 - -dns_over_https: # DNS over HTTPS - - enable_dns_over_https: false # Enable DNS over HTTPS - - provider: - description: Use Provider - choices: - - Cloudflare - - NextDNS - - Custom - default: Cloudflare - disabled: - variable: _.enable_dns_over_https - when: false - - 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' %} - provider is not custom - {% endif %} - description: if "_.provider" is not "Custom" ... ``` @@ -161,120 +131,6 @@ or "firefox.manual.socks_proxy.version" is "v4" | **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 "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**:
- the domain name in web address can be only a hostname
- must starts with 'https://' only
**Disabled**: if "_.provider" is not "Custom" | -### Let's generate the changelog - -```shell -rougail -m firefox/ --modes_level basic standard advanced -o doc --doc.contents changelog -``` -#### 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**:
- the domain name in web address can be only a hostname
- must starts with 'https://' only
**Disabled**: if "_.provider" is not "Custom" | -## User datas - -### Example 1 - -#### config/01/config.yml - - -```yml ---- -``` -#### Output - -```shell -rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/01/config.yml -``` -
╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📂 DNS over HTTPS
-    ┗━━ 📓 Enable DNS over HTTPS: false
-
-### Example 2 - -#### config/02/config.yml - - -```yml ---- -dns_over_https: - enable_dns_over_https: true -``` -#### Output - -```shell -rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/02/config.yml -``` -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📂 DNS over HTTPS
-    ┣━━ 📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file "config/02/config.yml" (⏳ false)
-    ┗━━ 📓 Use Provider: Cloudflare
-
-### Example 3 - -#### config/03/config.yml - - -```yml ---- -dns_over_https: - enable_dns_over_https: true - provider: Custom - custom_dns_url: http://dns.net -``` -#### Output - -```shell -rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/03/config.yml -``` -
🔔 WARNINGS
-┗━━ the value "http://dns.net" is an invalid URL for "dns_over_https.custom_dns_url" (Custom DNS URL), only https is allowed, it will be ignored when loading from the YAML file "config/03/config.yml"
-🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ DNS over HTTPS
-        ┗━━ Custom DNS URL
-
-### Example 4 - -#### config/04/config.yml - - -```yml ---- -dns_over_https: - enable_dns_over_https: true - provider: Custom - custom_dns_url: https://dns.net -``` -#### Output - -```shell -rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/04/config.yml -``` -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📂 DNS over HTTPS
-    ┣━━ 📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file "config/04/config.yml" (⏳ false)
-    ┣━━ 📓 Use Provider: Custom ◀ loaded from the YAML file "config/04/config.yml" (⏳ Cloudflare)
-    ┗━━ 📓 Custom DNS URL: https://dns.net ◀ loaded from the YAML file "config/04/config.yml"
-
- - -- [[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)) +- [[tutorial v1.1_111] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111)) diff --git a/config/01/cmd_ro.txt b/config/01/cmd_ro.txt deleted file mode 100644 index 9cdee2b7..00000000 --- a/config/01/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/01/config.yml \ No newline at end of file diff --git a/config/01/config.yml b/config/01/config.yml deleted file mode 100644 index ed97d539..00000000 --- a/config/01/config.yml +++ /dev/null @@ -1 +0,0 @@ ---- diff --git a/config/01/output_ro.html b/config/01/output_ro.html deleted file mode 100644 index 045443cb..00000000 --- a/config/01/output_ro.html +++ /dev/null @@ -1,8 +0,0 @@ -
╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📂 DNS over HTTPS
-    ┗━━ 📓 Enable DNS over HTTPS: false
-
diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt deleted file mode 100644 index b9994d96..00000000 --- a/config/02/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/02/config.yml \ No newline at end of file diff --git a/config/02/config.yml b/config/02/config.yml deleted file mode 100644 index aee4796f..00000000 --- a/config/02/config.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -dns_over_https: - enable_dns_over_https: true diff --git a/config/02/output_ro.html b/config/02/output_ro.html deleted file mode 100644 index 0b56fc50..00000000 --- a/config/02/output_ro.html +++ /dev/null @@ -1,11 +0,0 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📂 DNS over HTTPS
-    ┣━━ 📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file "config/02/config.yml" (⏳ false)
-    ┗━━ 📓 Use Provider: Cloudflare
-
diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt deleted file mode 100644 index 0c8e9046..00000000 --- a/config/03/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/03/config.yml \ No newline at end of file diff --git a/config/03/config.yml b/config/03/config.yml deleted file mode 100644 index 2497fc1f..00000000 --- a/config/03/config.yml +++ /dev/null @@ -1,5 +0,0 @@ ---- -dns_over_https: - enable_dns_over_https: true - provider: Custom - custom_dns_url: http://dns.net diff --git a/config/03/output_ro.html b/config/03/output_ro.html deleted file mode 100644 index f90b6d1e..00000000 --- a/config/03/output_ro.html +++ /dev/null @@ -1,7 +0,0 @@ -
🔔 WARNINGS
-┗━━ the value "http://dns.net" is an invalid URL for "dns_over_https.custom_dns_url" (Custom DNS URL), only https is allowed, it will be ignored when loading from the YAML file "config/03/config.yml"
-🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ DNS over HTTPS
-        ┗━━ Custom DNS URL
-
diff --git a/config/04/cmd_ro.txt b/config/04/cmd_ro.txt deleted file mode 100644 index 84818e51..00000000 --- a/config/04/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/04/config.yml \ No newline at end of file diff --git a/config/04/config.yml b/config/04/config.yml deleted file mode 100644 index 7f28b0da..00000000 --- a/config/04/config.yml +++ /dev/null @@ -1,5 +0,0 @@ ---- -dns_over_https: - enable_dns_over_https: true - provider: Custom - custom_dns_url: https://dns.net diff --git a/config/04/output_ro.html b/config/04/output_ro.html deleted file mode 100644 index 4866d7e4..00000000 --- a/config/04/output_ro.html +++ /dev/null @@ -1,12 +0,0 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📂 DNS over HTTPS
-    ┣━━ 📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file "config/04/config.yml" (⏳ false)
-    ┣━━ 📓 Use Provider: Custom ◀ loaded from the YAML file "config/04/config.yml" (⏳ Cloudflare)
-    ┗━━ 📓 Custom DNS URL: https://dns.net ◀ loaded from the YAML file "config/04/config.yml"
-
diff --git a/tree.html b/tree.html index b8e0dd3b..421f04ab 100644 --- a/tree.html +++ b/tree.html @@ -25,19 +25,20 @@

Directory Tree

- .
- └── 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
+     └── empty.yml


-2 directories, 8 files +2 directories, 9 files