From 6e57510ba982d0255f998701bab0a3566f16eaf6 Mon Sep 17 00:00:00 2001 From: Tyler Akins Date: Thu, 16 Nov 2023 16:04:52 -0600 Subject: [PATCH] Making it more clear that sourced files are shell Addresses part of the concerns from #69 --- README.md | 2 ++ mo | 5 +++-- tests/help | 5 +++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 86176aa..ab15e08 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,8 @@ There are more scripts available in the [demos directory](demo/) that could help There are additional features that the program supports. Try using `mo --help` to see what is available. +Please note that this command is written in Bash and pulls data from either the environment or (when using `--source`) from a text file that will be sourced and loaded into the environment, which means you will need to have Bash-style variables defined. Please see the examples in `demo/` for different ways you can use `mo`. + Enhancements ----------- diff --git a/mo b/mo index bcac978..1ef1e5c 100755 --- a/mo +++ b/mo @@ -38,7 +38,8 @@ #/ This message. #/ -s=FILE, --source=FILE #/ Load FILE into the environment before processing templates. -#/ Can be used multiple times. +#/ Can be used multiple times. The file must be a valid shell script +#/ and should only contain variable assignments. #/ -o=DELIM, --open=DELIM #/ Set the opening delimiter. Default is "{{". #/ -c=DELIM, --close=DELIM @@ -1949,7 +1950,7 @@ mo::tokenizeTagContentsSingleQuote() { # Save the original command's path for usage later MO_ORIGINAL_COMMAND="$(cd "${BASH_SOURCE[0]%/*}" || exit 1; pwd)/${BASH_SOURCE[0]##*/}" -MO_VERSION="3.0.3" +MO_VERSION="3.0.4" # If sourced, load all functions. # If executed, perform the actions as expected. diff --git a/tests/help b/tests/help index bdf5d3a..420b37a 100755 --- a/tests/help +++ b/tests/help @@ -43,7 +43,8 @@ Options: This message. -s=FILE, --source=FILE Load FILE into the environment before processing templates. - Can be used multiple times. + Can be used multiple times. The file must be a valid shell script + and should only contain variable assignments. -o=DELIM, --open=DELIM Set the opening delimiter. Default is "{{". -c=DELIM, --close=DELIM @@ -93,7 +94,7 @@ This is open source! Please feel free to contribute. https://github.com/tests-always-included/mo -MO_VERSION=3.0.3 +MO_VERSION=3.0.4 EOF }