Merge pull request #271 from TypedDevs/docs/add-bash-style-on-examples

Minor docs style improvements

docs/command-line.md

@@ -38,7 +38,7 @@ Run a core assert function standalone without a test context. Read more: [Standa
 ```bash [Example]
 ./bashunit --assert equals "foo" "bar"
 ```
-```bash [Output]
+```[Output]
 ✗ Failed: Main::exec assert
     Expected 'foo'
     but got 'bar'
@@ -160,7 +160,7 @@ Upgrade **bashunit** to latest version.
 Displays a help message with all allowed arguments and options.
 
 ::: code-group
-```-vue [Output]
+```[Output]
 bashunit [arguments] [options]
 
 Arguments:

docs/configuration.md

@@ -18,7 +18,7 @@ If a directory is specified, it will execute tests within files ending in `test.
 If you use wildcards, **bashunit** will run any tests it finds.
 
 ::: code-group
-```[Example]
+```bash [Example]
 # all tests inside the tests directory
 DEFAULT_PATH=tests
 
@@ -41,10 +41,10 @@ Verbose is the default output, but it can be overridden by the environment confi
 Similar as using `-s|--simple|-v|--verbose` option on the [command line](/command-line#output).
 
 ::: code-group
-```[Simple output]
+```bash [Simple output]
 ....
 ```
-```[.env]
+```bash [.env]
 SIMPLE_OUTPUT=true
 ```
 :::
@@ -57,7 +57,7 @@ Running tests/functional/logic_test.sh
 ✓ Passed: Should validate an ok exit code
 ✓ Passed: Text should be equal
 ```
-```[.env]
+```bash [.env]
 SIMPLE_OUTPUT=false
 ```
 :::
@@ -80,10 +80,10 @@ Specifies if you want to show the bashunit header. `true` by default.
 Additionally, you can use the env-var `HEADER_ASCII_ART` to display bashunit in ASCII. `false` by default.
 
 ::: code-group
-```[Without header]
+``` [Without header]
 ✓ Passed: foo bar
 ```
-```[.env]
+```bash [.env]
 SHOW_HEADER=false
 ```
 :::
@@ -94,7 +94,7 @@ bashunit - {{ pkg.version }} // [!code hl]
 
 ✓ Passed: foo bar
 ```
-```[.env]
+```bash [.env]
 SHOW_HEADER=true
 ```
 :::
@@ -110,7 +110,7 @@ __               _                   _    // [!code hl]
 
 ✓ Passed: foo bar
 ```
-```[.env]
+```bash [.env]
 SHOW_HEADER=true
 HEADER_ASCII_ART=true
 ```
@@ -120,23 +120,23 @@ HEADER_ASCII_ART=true
 
 > `SHOW_EXECUTION_TIME=true|false`
 
-Specifies if you want to display the execution time after running **bashunit**. `true` by default.
+Specify if you want to display the execution time after running **bashunit**. `true` by default.
 
 ::: warning
 This feature is not available on macOS.
 :::
 
 ::: code-group
-```[With execution time]
+```-vue [With execution time]
 ✓ Passed: foo bar
 
 Tests:      1 passed, 1 total
 Assertions: 3 passed, 3 total
 All tests passed
-Time taken: 14 ms // [!code hl]
+Time taken: 14 ms  // [!code hl]
 ```
-```[.env]
-SHOW_EXECUTION_TIMEER=true
+```bash [.env]
+SHOW_EXECUTION_TIMER=true
 ```
 :::
 
@@ -148,8 +148,8 @@ Tests:      1 passed, 1 total
 Assertions: 3 passed, 3 total
 All tests passed
 ```
-```[.env]
-SHOW_EXECUTION_TIMEER=false
+```bash [.env]
+SHOW_EXECUTION_TIMER=false
 ```
 :::
 

docs/standalone.md

@@ -6,7 +6,10 @@ You can use all bashunit assertions outside any tests if you would like to use t
 
 If you want to use the nice assertions syntax of bashunit - without the tests context/functions, but to end-to-end tests executables, you can use the `-a|--assert` option when running `./bashunit` and call the assertion directly from there.
 
-The return exit code will be `0` for success assertions and `1` for failures.
+The return exit code will be:
+- `0` success assertion
+- `1` failed assertion
+- `127` non-existing function
 
 ::: info
 The prefix `assert_` is optional.
@@ -16,6 +19,7 @@ The prefix `assert_` is optional.
 ```bash [Example]
 # with `assert_` prefix
 ./bashunit -a assert_equals "foo" "foo"
+
 # or without prefix
 ./bashunit -a equals "foo" "foo"
 ```
@@ -28,6 +32,7 @@ The prefix `assert_` is optional.
 ```bash [Example]
 # with `assert_` prefix
 ./bashunit -a assert_not_equals "foo" "foo"
+
 # or without prefix
 ./bashunit -a not_equals "foo" "foo"
 ```