Merge pull request #276 from DannyBen/add/configurable-compact-flags

Allow disabling compact flag expansion (-abc to -a -b -c)

Author: DannyBen

lib/bashly/settings.rb

@@ -3,7 +3,8 @@ class Settings
     class << self
       include AssetHelper
 
-      attr_writer :source_dir, :target_dir, :lib_dir, :strict, :tab_indent
+      attr_writer :compact_short_flags, :source_dir, :target_dir,
+        :lib_dir, :strict, :tab_indent
 
       def source_dir
         @source_dir ||= get :source_dir
@@ -25,6 +26,10 @@ def tab_indent
         @tab_indent ||= get :tab_indent
       end
 
+      def compact_short_flags
+        @compact_short_flags ||= get :compact_short_flags
+      end
+
       def env
         @env ||= get(:env)&.to_sym
       end

lib/bashly/templates/settings.yml

@@ -22,6 +22,10 @@ strict: false
 # (every 2 leading spaces will be converted to a tab character)
 tab_indent: false
 
+# When true, the generated script will consider any argument in the form of
+# `-abc` as if it is `-a -b -c`.
+compact_short_flags: true
+
 # Set to 'production' or 'development':
 # - production    generate a smaller script, without file markers
 # - development   generate with file markers

lib/bashly/views/command/normalize_input.gtx

@@ -11,11 +11,15 @@
 >     elif [[ $arg =~ ^(-[a-zA-Z0-9])=(.+)$ ]]; then
 >       input+=("${BASH_REMATCH[1]}")
 >       input+=("${BASH_REMATCH[2]}")
+
+if Settings.compact_short_flags
 >     elif [[ $arg =~ ^-([a-zA-Z0-9][a-zA-Z0-9]+)$ ]]; then
 >       flags="${BASH_REMATCH[1]}"
 >       for (( i=0 ; i < ${#flags} ; i++ )); do
 >         input+=("-${flags:i:1}")
 >       done
+end
+
 >     else
 >       input+=("$arg")
 >     fi

spec/approvals/fixtures/no-compact-flags

@@ -0,0 +1,29 @@
+creating user files in src
+skipped src/initialize.sh (exists)
+skipped src/root_command.sh (exists)
+created ./cli
+run ./cli --help to test your bash script
++ ./cli -abc --delta
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--alpha]} = 1
+- ${args[--bravo]} = 1
+- ${args[--charlie]} = 1
+- ${args[--delta]} = 1
++ BASHLY_COMPACT_SHORT_FLAGS=no
++ bundle exec bashly generate
+creating user files in src
+skipped src/initialize.sh (exists)
+skipped src/root_command.sh (exists)
+created ./cli
+run ./cli --help to test your bash script
++ ./cli -abc --delta
+invalid option: -abc
++ ./cli -a -b -c
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--alpha]} = 1
+- ${args[--bravo]} = 1
+- ${args[--charlie]} = 1

spec/fixtures/workspaces/no-compact-flags/.gitignore

@@ -0,0 +1 @@
+cli

spec/fixtures/workspaces/no-compact-flags/README.md

@@ -0,0 +1,2 @@
+This fixture tests that setting `compact_short_flags` to `false` indeed ignores
+this `-abc` pattern.

spec/fixtures/workspaces/no-compact-flags/src/bashly.yml

@@ -0,0 +1,21 @@
+name: cli
+help: Sample application
+version: 0.1.0
+
+flags:
+- long: --alpha
+  short: -a
+  help: Alpha
+- long: --bravo
+  short: -b
+  help: Bravo
+- long: --charlie
+  short: -c
+  help: Charlie
+- long: --delta
+  short: -d
+  help: Delta
+
+
+
+

spec/fixtures/workspaces/no-compact-flags/src/initialize.sh

@@ -0,0 +1,6 @@
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment variables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.

spec/fixtures/workspaces/no-compact-flags/src/root_command.sh

@@ -0,0 +1,3 @@
+echo "# this file is located in 'src/root_command.sh'"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args

spec/fixtures/workspaces/no-compact-flags/test.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# This fixture tests that setting `compact_short_flags` to `false` indeed ignores
+# this `-abc` pattern.
+
+bundle exec bashly generate
+
+set -x
+
+./cli -abc --delta
+
+# Use ad-hoc setting through an environment variable
+BASHLY_COMPACT_SHORT_FLAGS="no" bundle exec bashly generate
+
+./cli -abc --delta
+./cli -a -b -c