🐛 fix examples documentation

README.md

@@ -3,7 +3,7 @@
 [![Latest Release](https://img.shields.io/github/v/release/jcaillon/valet?sort=date&style=flat&logo=github&logoColor=white&label=Latest%20release&color=%2350C878)][latest-release]
 [![Total downloads](https://img.shields.io/github/downloads/jcaillon/valet/total.svg?style=flat)][releases]
 [![MIT license](https://img.shields.io/badge/License-MIT-74A5C2.svg?style=flat)][license]
-[![bash 5.1+ required](https://img.shields.io/badge/Requires-bash%20v5.1+-865FC5.svg?logo=gnubash&logoColor=white)][bash]
+[![bash 5+ required](https://img.shields.io/badge/Requires-bash%20v5+-865FC5.svg?logo=gnubash&logoColor=white)][bash]
 
 [![icon](docs/static/logo.png)][valet-site]
 

docs/content/docs/002.installation/_index.md

@@ -8,7 +8,7 @@ url: /docs/installation
 
 ## 📦 Dependencies
 
-- Bash version 5.1 or superior is required (might work with older versions but it is not guaranteed).
+- Bash version 5 or superior is required (might work with older versions but it is not guaranteed).
 - From [GNU coreutils][gnu-core-utils]: it uses `rm`, `mv`, `mkdir` for all commands. It uses `chmod`, `ln` for the installation/updates. *You most likely already have all of these!*
 - [curl][curl] and [tar][tar] are needed only if you want to use the self-update command.
 

docs/content/docs/025.command-properties/_index.md

@@ -226,7 +226,9 @@ Examples are used in the command help/usage and let the user quickly understand
 
 ### ✔️ name
 
-The command for this example. You should not include `valet` as it will be preprended automatically.
+The command for this example.
+
+You should not include `valet` as it will be prepended automatically. If you do not want to prepend it, start the name with `!` (useful to illustrate a more complex command line).
 
 | Mandatory? | Default value? |
 |----------|---------------|

tests.d/1005-lib-io/results.approved.md

@@ -161,6 +161,19 @@ Exit code: `0`
 3
 ```
 
+### Testing io::isDirectoryWritable
+
+Exit code: `0`
+
+**Standard** output:
+
+```plaintext
+→ io::isDirectoryWritable '/tmp'
+Writable
+→ io::isDirectoryWritable '/notexisting'
+Not writable
+```
+
 ## Test script 01.invoke
 
 ### Testing io::invoke5, should return 1, input stream from string

valet.d/commands.d/self-build.sh

@@ -394,8 +394,19 @@ function declareFinalCommandDefinitionHelpVariables() {
     fi
   done
 
+  # for each example, prepend valet to the example name
+  local example
+  local -a examples=()
+  for example in "${TEMP_CMD_BUILD_examples_name[@]}"; do
+    if [[ ${example} == "!"* ]]; then
+      examples+=("${example:1}")
+    else
+      examples+=("valet ${example}")
+    fi
+  done
+
   # declare examples, arguments and options for the help
-  if [[ "${#TEMP_CMD_BUILD_examples_name[@]}" -gt 0 ]]; then eval "CMD_EXAMPLES_NAME_${function}=(\"\${TEMP_CMD_BUILD_examples_name[@]}\")"; fi
+  if [[ "${#examples[@]}" -gt 0 ]]; then eval "CMD_EXAMPLES_NAME_${function}=(\"\${examples[@]}\")"; fi
   if [[ "${#TEMP_CMD_BUILD_examples_description[@]}" -gt 0 ]]; then eval "CMD_EXAMPLES_DESCRIPTION_${function}=(\"\${TEMP_CMD_BUILD_examples_description[@]}\")"; fi
   eval "CMD_OPTIONS_NAME_${function}=(\"\${TEMP_CMD_BUILD_options_name[@]}\")"
   eval "CMD_OPTIONS_DESCRIPTION_${function}=(\"\${TEMP_CMD_BUILD_options_description[@]}\")"

valet.d/lib-interactive

@@ -192,11 +192,11 @@ function interactive::promptYesNoRaw() {
       $'\n' | ' ')
         break
         ;;
-      y)
+      y | Y)
         state=true
         break
         ;;
-      n)
+      n | N)
         state=false
         break
         ;;

valet.d/main

@@ -285,7 +285,7 @@ function main::getHelpText() {
   local examples
   if [[ -n "${functionExamples:-}" ]]; then
     examples="${cTitle}EXAMPLES${cDefault}"$'\n'$'\n'
-    mainWriteAsTable "${helpWidth}" "" "CMD_EXAMPLES" "${functionName}"
+    mainWriteAsTable "${helpWidth}" "${cCommand}" "CMD_EXAMPLES" "${functionName}"
     examples+="${RETURNED_VALUE}"$'\n'
   fi