rougail-tutorials/README.md

• Summary
• [tutorial v1.1_000] An empty structured file with format version (diff)

[tutorial v1.1_010)] A first variable with only a name

View the diff

Screenshot

Structure

firefox/00-proxy.yml

%YAML 1.2
---
version: 1.1

proxy_mode:
...

Let's generate the documentation

foo@bar:~$ git switch --detach v1.1_010
foo@bar:~$ rougail -m firefox/ -o doc -do github

Variable	Description
proxy_mode string mandatory

Let's generate the changelog

foo@bar:~$ git switch --detach v1.1_010
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github

New variable

Variable	Description
proxy_mode string mandatory

User datas

Example 1

config/01/config.yaml

---

Output

foo@bar:~$ git switch --detach v1.1_010
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml

🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ proxy_mode

Example 2

config/02/config.yaml

---
proxy_mode: No proxy

Output

foo@bar:~$ git switch --detach v1.1_010
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml

╭──────── Caption ────────╮
│ Variable Modified value │
╰─────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yaml"

Example 3

config/03/config.yaml

---
proxy_mode: Manual proxy configuration

Output

foo@bar:~$ git switch --detach v1.1_010
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml

╭──────── Caption ────────╮
│ Variable Modified value │
╰─────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml"

Example 4

config/04/config.yaml

---
proxy_mode: foo

Output

foo@bar:~$ git switch --detach v1.1_010
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml

╭──────── Caption ────────╮
│ Variable Modified value │
╰─────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: foo ◀ loaded from the YAML file "config/04/config.yaml"

Example 5

config/05/config.yaml

---
proxy_mode: 1

Output

foo@bar:~$ git switch --detach v1.1_010
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml

🔔 WARNINGS
┗━━ the value "1" is an invalid string for "proxy_mode", which is not a string, it will be ignored when loading from the YAML file "config/05/config.yaml"
🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ proxy_mode

• [tutorial v1.1_011] Describe the variable (diff)