diff --git a/README.md b/README.md index 7e32a332..394c2cde 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ include_toc: true - [[tutorial 001] An empty file](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001)) - [[tutorial 002] A first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002)) +- [[tutorial 003] A first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003)) # Description @@ -33,6 +34,7 @@ Weโ€™re gonna create a first variable called "proxy_mode": ```yml --- +proxy_mode: ``` ## Generated documentation @@ -40,3 +42,137 @@ Weโ€™re gonna create a first variable called "proxy_mode": ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github ``` +### Variables + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Proxy_mode. | + + +# User data + +## Example 1 + +### config/01/config.yaml + + +```yml +--- + +``` +### Description + +The user data file is empty. So it's only default value that will be used. + + +### Output + +```console +foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/01/config.yaml +``` +
๐Ÿ›‘ ERRORS
+โ”ฃโ”โ” The following variables are mandatory but have no value:
+โ”—โ”โ”   - proxy_mode
+
+## Example 2 + +### config/02/config.yaml + + +```yml +--- +proxy_mode: No proxy + +``` +### Output + +```console +foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/02/config.yaml +``` +
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ Caption โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
+โ”‚ Variable                           Default value            โ”‚
+โ”‚ Undocumented variable              Modified value           โ”‚
+โ”‚ Undocumented but modified variable (Original default value) โ”‚
+โ”‚ Unmodifiable variable                                       โ”‚
+โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
+Variables:
+โ”—โ”โ” ๐Ÿ““ proxy_mode: No proxy
+
+## Example 3 + +### config/03/config.yaml + + +```yml +--- +proxy_mode: Manual proxy configuration + +``` +### Output + +```console +foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/03/config.yaml +``` +
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ Caption โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
+โ”‚ Variable                           Default value            โ”‚
+โ”‚ Undocumented variable              Modified value           โ”‚
+โ”‚ Undocumented but modified variable (Original default value) โ”‚
+โ”‚ Unmodifiable variable                                       โ”‚
+โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
+Variables:
+โ”—โ”โ” ๐Ÿ““ proxy_mode: Manual proxy configuration
+
+## Example 4 + +### config/04/config.yaml + + +```yml +--- +proxy_mode: foo + +``` +### Description + +"foo" should be an invalid value for this variable. + + +### Output + +```console +foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/04/config.yaml +``` +
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ Caption โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
+โ”‚ Variable                           Default value            โ”‚
+โ”‚ Undocumented variable              Modified value           โ”‚
+โ”‚ Undocumented but modified variable (Original default value) โ”‚
+โ”‚ Unmodifiable variable                                       โ”‚
+โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
+Variables:
+โ”—โ”โ” ๐Ÿ““ proxy_mode: foo
+
+## Example 5 + +### config/05/config.yaml + + +```yml +--- +proxy_mode: 1 + +``` +### Description + +The integer value "1" is invalid. + + +### Output + +```console +foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/05/config.yaml +``` +
๐Ÿ›‘ ERRORS
+โ”ฃโ”โ” '1' is an invalid string for 'proxy_mode'
+โ”ฃโ”โ” The following variables are mandatory but have no value:
+โ”—โ”โ”   - proxy_mode
+
diff --git a/config/01/config.yaml b/config/01/config.yaml new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/config/01/config.yaml @@ -0,0 +1 @@ +--- diff --git a/config/02/config.yaml b/config/02/config.yaml new file mode 100644 index 00000000..d9144882 --- /dev/null +++ b/config/02/config.yaml @@ -0,0 +1,2 @@ +--- +proxy_mode: No proxy diff --git a/config/03/config.yaml b/config/03/config.yaml new file mode 100644 index 00000000..74edb225 --- /dev/null +++ b/config/03/config.yaml @@ -0,0 +1,2 @@ +--- +proxy_mode: Manual proxy configuration diff --git a/config/04/config.yaml b/config/04/config.yaml new file mode 100644 index 00000000..e3fa25da --- /dev/null +++ b/config/04/config.yaml @@ -0,0 +1,2 @@ +--- +proxy_mode: foo diff --git a/config/05/config.yaml b/config/05/config.yaml new file mode 100644 index 00000000..bf6f64ca --- /dev/null +++ b/config/05/config.yaml @@ -0,0 +1,2 @@ +--- +proxy_mode: 1