🤸‍♀️ merge pull request #119 from FWDekker/d-alias~

🤸‍♀️ mommy now supports `-d` option as an alias~

CHANGELOG.md

@@ -1,4 +1,9 @@
 # Changelog
+## [unreleased]
+### added
+* 🤸‍♀️ mommy now supports `-d` as an alias of `--global-config-dirs`~
+
+
 ## [1.5.0] -- 2024-02-28
 ### added
 * 🦓 mommy now supports templates with literal slashes using `%%S%%`~ ([#107](https://github.com/FWDekker/mommy/issues/107))

README.md

@@ -432,7 +432,7 @@ additionally, mommy knows a few extra options, which you can use to discover who
 | `-v`         | `--version`                   | displays mommy's version information~                                                             |
 | `-1`         |                               | writes output to stdout instead of stderr~                                                        |
 | `-c <file>`  | `--config=<file>`             | tells mommy that she should read your [config](#configuration) from `<file>`~                     |
-|              | `--global-config-dirs=<dirs>` | sets [global configuration dirs](#config-file-locations) to the colon-separated list in `<dirs>`~ |
+| `-d <dirs>`  | `--global-config-dirs=<dirs>` | sets [global configuration dirs](#config-file-locations) to the colon-separated list in `<dirs>`~ |
 
 
 ## 🙋 configuration<a name="configuration"></a> <small><sup>[top ▲](#toc)</sup></small>

src/main/completions/fish/mommy.fish

@@ -64,7 +64,7 @@ complete --command mommy --short-option c --long-option config \
     --description "Configuration file" \
     --condition "not __fish_seen_argument $opt_help $opt_version"\
     --condition "test -z (get_args)"
-complete --command mommy --long-option global-config-dirs \
+complete --command mommy --short-option d --long-option global-config-dirs \
     --require-parameter \
     --arguments "(__fish_complete_directories)" \
     --description "Colon-separated global config file dirs" \

src/main/completions/zsh/_mommy

@@ -12,7 +12,7 @@ _arguments \
     "(- *)"{-v,--version}'[Show version]' \
     -1'[Write to stdout]' \
     {-c,--config}'[Configuration file]:config:_files' \
-    --global-config-dirs'[Colon-separated global config file dirs]:global config:_dir_list' \
+    {-d,--global-config-dirs}'[Colon-separated global config file dirs]:global config:_dir_list' \
     {-e,--eval}'[Evaluate string]:string' \
     {-s,--status}'[Exit code]:code:->status' \
     '*::command:'

src/main/man/man1/mommy.1

@@ -41,12 +41,12 @@ note that \fIcommand\fP should be given as a single argument~
 \fB-s\fP \fIstatus\fP, \fB--status=\fP\fIstatus\fP
 gives output corresponding to exit code \fIstatus\fP~
 .TP
+\fB-d\fP \fIdirs\fP, \fB--global-config-dirs=\fP\fIdirs\fP
+sets global configuration dirs to the colon-separated list in \fIdirs\fP~
+.TP
 \fB-c\fP \fIfile\fP, \fB--config=\fP\fIfile\fP
 tells mommy that she should read your config from \fIfile\fP~
 .TP
-\fB--global-config-dirs=\fP\fIdirs\fP
-sets global configuration dirs to the colon-separated list in \fIdirs\fP~
-.TP
 \fB-1\fP
 writes output to \fBstdout\fP instead of \fBstderr\fP~
 

src/main/sh/mommy

@@ -310,7 +310,7 @@ opt_global_config_dirs="${XDG_CONFIG_DIRS}:/etc/mommy/:/usr/local/etc/mommy/"
 opt_eval=""
 opt_status=""
 
-while getopts ":hv1c:e:s:-:" OPT; do
+while getopts ":hv1d:c:e:s:-:" OPT; do
     # Cheap workaround for long options, cf. https://stackoverflow.com/a/28466267
     if [ "-" = "$OPT" ]; then
         OPT="${OPTARG%%=*}"
@@ -323,7 +323,7 @@ while getopts ":hv1c:e:s:-:" OPT; do
     h|help) opt_help="1" ;;
     v|version) opt_version="1" ;;
     1) opt_target="1" ;;
-    global-config-dirs) require_arg; opt_global_config_dirs="$OPTARG" ;;
+    d|global-config-dirs) require_arg; opt_global_config_dirs="$OPTARG" ;;
     c|config) opt_config="$OPTARG" ;;
     e|eval) require_arg; opt_eval="$OPTARG" ;;
     s|status) require_arg; require_int; opt_status="$OPTARG" ;;

src/test/helper/spec_helper.sh

@@ -21,7 +21,7 @@ export MOMMY_TMP_DIR
 export n="
 "
 
-strip_opt() { printf "%s\n" "$1" | sed "s/[-= ]//g"; }
+strip_opt() { printf "%s\n" "$1" | sed -E "s/(^-+|[= ])//g"; }
 
 
 ## Hooks

src/test/sh/unit_spec.sh

@@ -16,8 +16,8 @@ set_config() {
 Describe "mommy"
     Describe "command-line options"
         It "gives an error for unknown short options"
-            When run "$MOMMY_EXEC" -d
-            The error should equal "mommy doesn't know option -d~"
+            When run "$MOMMY_EXEC" -z
+            The error should equal "mommy doesn't know option -z~"
             The status should be failure
         End
 
@@ -75,34 +75,36 @@ Describe "mommy"
             End
         End
 
-        Describe "--global-config-dirs"
-            It "gives an error when no argument is given"
-                When run "$MOMMY_EXEC" --global-config-dirs="" -c "" true
-                The error should equal "mommy is missing the argument for option 'global-config-dirs'~"
+        Describe "-d/--global-config-dirs"
+            Parameters:value "-d " "--global-config-dirs="
+
+            It "gives an error when no argument is given using $1"
+                When run "$MOMMY_EXEC" $1"" -c "" true
+                The error should equal "mommy is missing the argument for option '$(strip_opt "$1")'~"
                 The status should be failure
             End
 
-            It "uses the configuration from the file"
+            It "uses the configuration from the file when using $1"
                 set_config "MOMMY_COMPLIMENTS='sport revive'" "$MOMMY_TMP_DIR/global1/config.sh"
 
-                When run "$MOMMY_EXEC" --global-config-dirs="$MOMMY_TMP_DIR/global1/" -c "" true
+                When run "$MOMMY_EXEC" $1"$MOMMY_TMP_DIR/global1/" -c "" true
                 The error should equal "sport revive"
                 The status should be success
             End
 
-            It "non-existing directories are skipped until an existing directory is found"
+            It "non-existing directories are skipped until an existing directory is found when using $1"
                 set_config "MOMMY_COMPLIMENTS='cherry crop'" "$MOMMY_TMP_DIR/global2/config.sh"
 
-                When run "$MOMMY_EXEC" --global-config-dirs="$MOMMY_TMP_DIR/global1/:$MOMMY_TMP_DIR/global2/" -c "" true
+                When run "$MOMMY_EXEC" $1"$MOMMY_TMP_DIR/global1/:$MOMMY_TMP_DIR/global2/" -c "" true
                 The error should equal "cherry crop"
                 The status should be success
             End
 
-            It "when multiple global directories exist, only the first is used"
+            It "when multiple global directories exist, only the first is used when using $1"
                 set_config "MOMMY_COMPLIMENTS='film style'" "$MOMMY_TMP_DIR/global1/config.sh"
                 set_config "MOMMY_COMPLIMENTS='care smile'" "$MOMMY_TMP_DIR/global2/config.sh"
 
-                When run "$MOMMY_EXEC" --global-config-dirs="$MOMMY_TMP_DIR/global1/:$MOMMY_TMP_DIR/global2/" -c "" true
+                When run "$MOMMY_EXEC" $1"$MOMMY_TMP_DIR/global1/:$MOMMY_TMP_DIR/global2/" -c "" true
                 The error should equal "film style"
                 The status should be success
             End