From 8e8e266bc7c78dff456442eae06e7e32b7a49920 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Tue, 4 Nov 2025 19:22:26 +0100 Subject: [PATCH] [tutorial v1.1_051)] A conditional disabled variable (config and doc) --- README.md | 47 +++++++++++++++++++++------------------- config/01/output_ro.html | 12 +++++----- 2 files changed, 31 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 6b5495cb..680ee943 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_044] A conditional disabled variable with identifier](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_044/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_044~1..v1.1_044)) +- [[tutorial v1.1_050] A variable with type "web_address"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_050/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050)) -# [tutorial v1.1_050)] A variable with type "web_address" +# [tutorial v1.1_051)] A conditional disabled variable -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051) ## Screenshot @@ -124,13 +124,16 @@ version: 1.1 auto: description: Automatic proxy configuration URL type: web_address + disabled: + variable: _.proxy_mode + when_not: Automatic proxy configuration URL ... ``` ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_050 +foo@bar:~$ git switch --detach v1.1_051 foo@bar:~$ rougail -m firefox/ -o doc -do github ``` | Variable                                                                                        | Description                                                                                     | @@ -178,21 +181,21 @@ This family builds families dynamically | **manual.*https*_proxy.port**
**manual.*socks*_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* port.
**Validators**:
- well-known ports (1 to 1023) are allowed
- registred ports (1024 to 49151) are allowed
- private ports (greater than 49152) are allowed
**Default**: the value of the variable "manual.http_proxy.port" | | **manual.*https*_proxy.version**
**manual.*socks*_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.
**Choices**:
- v4
- v5 **← (default)**
**Disabled**: when the identifier is "HTTPS" | -| Variable                                                                                                     | Description                                                                                                  | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname | +| Variable                                                                                                          | Description                                                                                                       | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname
**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL" | ### Let's generate the changelog ```console -foo@bar:~$ git switch --detach v1.1_050 +foo@bar:~$ git switch --detach v1.1_051 foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github ``` -#### New variable +#### Modified variable -| Variable                                                                                             | Description                                                                                          | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname | +| Variable                                                                                                                                                                                                        | Description                                                                                                                                                                                                     | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname
**Disabled**: {'message': 'when the variable "{0}" hasn\'t the value "Automatic proxy configuration URL"', 'path': {'path': 'proxy_mode'}, 'description': 'Configure Proxy Access to the Internet'} | ## User datas @@ -210,16 +213,16 @@ auto: https://auto.proxy.net/wpad.dat #### Output ```console -foo@bar:~$ git switch --detach v1.1_050 +foo@bar:~$ git switch --detach v1.1_051 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml ``` -
╭──────── Caption ────────╮
-│ Variable Default value  │
-│          Modified value │
-╰─────────────────────────╯
+
🔔 WARNINGS
+┗━━ variable "auto" (Automatic proxy configuration URL) is disabled, it will be ignored when loading from the YAML file "config/01/config.yaml"
+╭─────── Caption ────────╮
+│ Variable Default value │
+╰────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/01/config.yaml"
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy
 
### Example 2 @@ -234,7 +237,7 @@ proxy_mode: Automatic proxy configuration URL #### Output ```console -foo@bar:~$ git switch --detach v1.1_050 +foo@bar:~$ git switch --detach v1.1_051 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml ```
🛑 ERRORS
@@ -255,7 +258,7 @@ auto: https://auto.proxy.net/wpad.dat
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_050
+foo@bar:~$ git switch --detach v1.1_051
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
 ```
 
╭────────────── Caption ───────────────╮
@@ -268,4 +271,4 @@ Variables:
 
-- [[tutorial v1.1_051] A conditional disabled variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051)) +- [[tutorial v1.1_060] A variable with type "domainname", parameters type and disabled](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_060/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_060~1..v1.1_060)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 30f4da7b..e554078e 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,8 +1,8 @@ -
╭──────── Caption ────────╮
-│ Variable Default value  │
-│          Modified value │
-╰─────────────────────────╯
+
🔔 WARNINGS
+┗━━ variable "auto" (Automatic proxy configuration URL) is disabled, it will be ignored when loading from the YAML file "config/01/config.yaml"
+╭─────── Caption ────────╮
+│ Variable Default value │
+╰────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/01/config.yaml"
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy