• Summary
• [tutorial v1.1_031] A variable with type's parameters (diff)

[tutorial v1.1_032] A variable with type "port"

View the diff

Read the documentation

Screenshot

Clone and install

To test this tutorial, you need to download this repository and install Rougail:

git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
cd rougail-tutorials
python -m venv venv_rougail
. venv_rougail/bin/activate
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml

Then switch to the tutorial page:

git switch --detach v1.1_032

Structure

.
└── firefox
    ├── 00-proxy.yml
    └── 10-manual.yml

Contents of the firefox/10-manual.yml file

%YAML 1.2
---
version: 1.1

manual:  # Manual proxy configuration

  http_proxy:  # HTTP Proxy

    address:
      description: HTTP address
      type: domainname
      params:
        allow_ip: true

    port:
      description: HTTP Port
      type: port
      default: 8080
...

Let's generate the documentation

rougail -m firefox/ -o doc

Variable	Description
proxy_mode choice mandatory	Configure Proxy Access to the Internet. Choices: • No proxy ← (default) • Auto-detect proxy settings for this network • Use system proxy settings • Manual proxy configuration • Automatic proxy configuration URL

Manual proxy configuration

🛈 Informations

Path: manual

HTTP Proxy

🛈 Informations

Path: manual.http_proxy

Variable	Description
manual.http_proxy.address domainname mandatory	HTTP address. Validators: • type domainname • the domain name can be an IP
manual.http_proxy.port port mandatory	HTTP 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: 8080

Let's generate the changelog

rougail -m firefox/ -o doc --doc.contents changelog

New variable

Variable	Description
manual.http_proxy.port port mandatory	HTTP 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: 8080

User datas

Example 1

config/01/config.yml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: example.net

Output

rougail -m firefox/ -u yaml -yf config/01/config.yml

╭─────────────────────────── Caption ────────────────────────────╮
│ Variable                           Default value               │
│ Undocumented but modified variable Modified value              │
│                                    (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
┃   loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
┗━━ 📂 Manual proxy configuration
    ┗━━ 📂 HTTP Proxy
        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
        ┃   "config/01/config.yml"
        ┗━━ 📓 HTTP Port: 8080

Example 2

config/02/config.yml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: example.net
    port: 3128

Output

rougail -m firefox/ -u yaml -yf config/02/config.yml

╭─────────────────────────── Caption ────────────────────────────╮
│ Variable                           Modified value              │
│ Undocumented but modified variable (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
┃   loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
┗━━ 📂 Manual proxy configuration
    ┗━━ 📂 HTTP Proxy
        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
        ┃   "config/02/config.yml"
        ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
            "config/02/config.yml" (⏳ 8080)

Example 3

config/03/config.yml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: example.net
    port: 100000

Output

rougail -m firefox/ -u yaml -yf config/03/config.yml

🔔 WARNINGS
┗━━ the value "100000" is an invalid port for "manual.http_proxy.port" (HTTP 
    Port), must be between 1 and 65535, it will be ignored when loading from the
    YAML file "config/03/config.yml"
╭─────────────────────────── Caption ────────────────────────────╮
│ Variable                           Default value               │
│ Undocumented but modified variable Modified value              │
│                                    (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
┃   loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
┗━━ 📂 Manual proxy configuration
    ┗━━ 📂 HTTP Proxy
        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
        ┃   "config/03/config.yml"
        ┗━━ 📓 HTTP Port: 8080

Output when invalid user datas is an error

rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_error

🛑 ERRORS
┗━━ the value "100000" is an invalid port for "manual.http_proxy.port" (HTTP 
    Port), must be between 1 and 65535, it will be ignored when loading from the
    YAML file "config/03/config.yml"

• [tutorial v1.1_033] A variable with type "boolean" (diff)