bashly 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51f9de0e5f94e6af9e792e567704aeb3b7a48b269fc376657244d6801210f3b9
-  data.tar.gz: 5b353f9e94ce7b164a121f824ee846e55403bc54a6237fed29e6fa39d19ce6ee
+  metadata.gz: ebf951958bb0478fb95b88273b87ccb2f297d36b655996b79d16c2ffdb32e773
+  data.tar.gz: aa3a9c218e9876fea287f141191baa4d95b40ae8b5569a7418c40911373e43ef
 SHA512:
-  metadata.gz: 58becd123b9fa29d72dbb10a5812a16037a5d6dd626a8b9cbf3b94eee55c6299220e7b7cba770b1d0eae620869cd9c6e909fc1708c3ccf28a482d85e159a2d02
-  data.tar.gz: c10390d56a7b56ccc0c3e369c5365a40d7cda17933de43621185e3488d2149f519fc9ff7a1510665562af1a8efbae7653a1185ba67669a6bf6a2b54552fdccdb
+  metadata.gz: 468d632281f56529a13770dce48d3bfbfc19433f2d32f52c0741b0d3c3ff80b15ad78b1936897e451d341f74b0d68ed6e5dd753ed4ed155984890b97ef8fbcf9
+  data.tar.gz: 4af3052a3d4b66b647bb461b6300eae17f72cfa61ef419f917fc6a23b881cb0af11dfb37d04628b2afedbf99f080ab04e2a5104d90d4ce148a01ceda1c2c2816

data/README.md

@@ -27,7 +27,6 @@ usually handled by a framework in any other programming language.
 It is available both as a [ruby gem](https://rubygems.org/gems/bashly) and as
 a [docker image](https://hub.docker.com/r/dannyben/bashly).
 
-
 ## Documentation
 
 - [Bashly Homepage][docs]
@@ -49,6 +48,7 @@ a [docker image](https://hub.docker.com/r/dannyben/bashly).
 Bashly is responsible for:
 
 - Generating a **single, standalone bash script**.
+- Generating a **human readable, shellcheck-compliant and shfmt-compliant script**.
 - Generating **usage texts** and help screens, showing your tool's arguments, flags and commands (works for sub-commands also).
 - Parsing the user's command line and extracting:
   - Optional or required **positional arguments**.
@@ -72,15 +72,12 @@ to contribute, feel free to [open an issue][issues] or
 
 Visit the *[How to contribute][contributing]* page for more information.
 
-
 ## Stargazers and Forkers
 
 [![Stargazers repo roster for @DannyBen/bashly](https://reporoster.com/stars/DannyBen/bashly)](https://github.com/DannyBen/bashly/stargazers)
 
 [![Forkers repo roster for @DannyBen/bashly](https://reporoster.com/forks/DannyBen/bashly)](https://github.com/DannyBen/bashly/network/members)
 
-
-
 [issues]: https://github.com/DannyBen/bashly/issues
 [discussions]: https://github.com/DannyBen/bashly/discussions
 [docs]: https://bashly.dannyb.co/

data/lib/bashly/commands/add.rb

@@ -34,8 +34,11 @@ module Bashly
       command 'comp', 'Generate a bash completions script or function.'
       command 'config', 'Add standard functions for handling INI files to the lib directory.'
       command 'help', 'Add a help command, in addition to the standard --help flag.'
-      command 'lib', 'Create the additional lib directory for additional user scripts. All *.sh scripts in this ' \
-        'folder will be included in the final bash script.'
+      command 'lib', <<~USAGE
+        Create the lib directory for any additional user scripts.
+        All *.sh scripts in this directory will be included in the final bash script.
+        Note that if you configured a different partials_extension, then the extensions of the files in this directory need to match.
+      USAGE
 
       command 'settings', 'Copy a sample settings.yml file to your project, allowing you to customize some ' \
         'bashly options.'

data/lib/bashly/commands/generate.rb

@@ -130,7 +130,8 @@ module Bashly
       def create_user_files
         quiet_say "creating user files in !txtgrn!#{Settings.source_dir}"
 
-        create_file "#{Settings.source_dir}/initialize.sh", command.render(:default_initialize_script)
+        create_file "#{Settings.source_dir}/initialize.#{Settings.partials_extension}",
+          command.render(:default_initialize_script)
 
         if command.commands.empty?
           create_root_command_file

data/lib/bashly/config_validator.rb

@@ -37,6 +37,12 @@ module Bashly
       assert_boolean "#{key}.required", value['required']
     end
 
+    def assert_default_command(key, value)
+      return unless value
+
+      assert [true, false, nil, 'force'].include?(value), "#{key} must be a boolean, or the string 'force'"
+    end
+
     def assert_dependencies(key, value)
       return unless value
 
@@ -145,7 +151,7 @@ module Bashly
       assert_optional_string "#{key}.function", value['function']
 
       assert_boolean "#{key}.private", value['private']
-      assert_boolean "#{key}.default", value['default']
+      assert_default_command "#{key}.default", value['default']
       assert_expose "#{key}.expose", value['expose']
       assert_version "#{key}.version", value['version']
       assert_catch_all "#{key}.catch_all", value['catch_all']
@@ -171,10 +177,6 @@ module Bashly
           "#{key}.function must contain lowercase alphanumeric characters and underscores only"
       end
 
-      if value['default']
-        assert value['args'], "#{key}.default makes no sense without args"
-      end
-
       if value['catch_all'] && value['args']
         repeatable_arg = value['args'].find { |a| a['repeatable'] }&.dig 'name'
         refute repeatable_arg, "#{key}.catch_all makes no sense with repeatable arg (#{repeatable_arg})"

data/lib/bashly/libraries/completions_function.rb

@@ -4,7 +4,7 @@ module Bashly
       def files
         [
           {
-            path:    "#{Settings.full_lib_dir}/#{function_name}.sh",
+            path:    "#{Settings.full_lib_dir}/#{function_name}.#{Settings.partials_extension}",
             content: completions_function_code(function_name),
           },
         ]

data/lib/bashly/libraries/help.rb

@@ -6,7 +6,7 @@ module Bashly
       def files
         [
           {
-            path:    "#{Settings.source_dir}/help_command.sh",
+            path:    "#{Settings.source_dir}/help_command.#{Settings.partials_extension}",
             content: help_command,
           },
         ]

data/lib/bashly/libraries.yml

@@ -1,7 +1,7 @@
 colors:
   files:
     - source: "templates/lib/colors.sh"
-      target: "%{user_lib_dir}/colors.sh"
+      target: "%{user_lib_dir}/colors.%{user_ext}"
 
 completions: :CompletionsFunction
 completions_script: :CompletionsScript
@@ -10,14 +10,14 @@ completions_yaml: :CompletionsYAML
 config:
   files:
     - source: "templates/lib/config.sh"
-      target: "%{user_lib_dir}/config.sh"
+      target: "%{user_lib_dir}/config.%{user_ext}"
 
 help: :Help
 
 lib:
   files:
     - source: "templates/lib/sample_function.sh"
-      target: "%{user_lib_dir}/sample_function.sh"
+      target: "%{user_lib_dir}/sample_function.%{user_ext}"
 
 settings:
   files:
@@ -46,15 +46,15 @@ test:
 validations:
   files:
     - source: "templates/lib/validations/validate_dir_exists.sh"
-      target: "%{user_lib_dir}/validations/validate_dir_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_dir_exists.%{user_ext}"
     - source: "templates/lib/validations/validate_file_exists.sh"
-      target: "%{user_lib_dir}/validations/validate_file_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_file_exists.%{user_ext}"
     - source: "templates/lib/validations/validate_integer.sh"
-      target: "%{user_lib_dir}/validations/validate_integer.sh"
+      target: "%{user_lib_dir}/validations/validate_integer.%{user_ext}"
     - source: "templates/lib/validations/validate_not_empty.sh"
-      target: "%{user_lib_dir}/validations/validate_not_empty.sh"
+      target: "%{user_lib_dir}/validations/validate_not_empty.%{user_ext}"
 
 yaml:
   files:
     - source: "templates/lib/yaml.sh"
-      target: "%{user_lib_dir}/yaml.sh"
+      target: "%{user_lib_dir}/yaml.%{user_ext}"

data/lib/bashly/library.rb

@@ -63,6 +63,7 @@ module Bashly
         user_source_dir: Settings.source_dir,
         user_target_dir: Settings.target_dir,
         user_lib_dir:    Settings.full_lib_dir,
+        user_ext:        Settings.partials_extension,
       }
     end
   end

data/lib/bashly/script/command.rb

@@ -156,7 +156,7 @@ module Bashly
       # Returns the bash filename that is expected to hold the user code
       # for this command
       def filename
-        options['filename'] || "#{action_name.to_underscore}_command.sh"
+        options['filename'] || "#{action_name.to_underscore}_command.#{Settings.partials_extension}"
       end
 
       # Returns an array of Flags
@@ -281,7 +281,7 @@ module Bashly
       # This is meant to provide the user with the ability to add custom
       # functions
       def user_lib
-        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.sh"].sort
+        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.#{Settings.partials_extension}"].sort
       end
 
       # Returns an array of all the args with a whitelist

data/lib/bashly/script/wrapper.rb

@@ -49,7 +49,7 @@ module Bashly
       end
 
       def custom_header_path
-        @custom_header_path ||= "#{Settings.source_dir}/header.sh"
+        @custom_header_path ||= "#{Settings.source_dir}/header.#{Settings.partials_extension}"
       end
     end
   end

data/lib/bashly/settings.rb

@@ -3,47 +3,51 @@ module Bashly
     class << self
       include AssetHelper
 
-      attr_writer :compact_short_flags, :source_dir, :target_dir,
-        :lib_dir, :strict, :tab_indent
+      attr_writer :compact_short_flags, :lib_dir, :partials_extension,
+        :source_dir, :strict, :tab_indent, :target_dir
 
-      def source_dir
-        @source_dir ||= get :source_dir
+      def compact_short_flags
+        @compact_short_flags ||= get :compact_short_flags
       end
 
-      def target_dir
-        @target_dir ||= get :target_dir
+      def env
+        @env ||= get(:env)&.to_sym
       end
 
-      def lib_dir
-        @lib_dir ||= get :lib_dir
+      def env=(value)
+        @env = value&.to_sym
       end
 
-      def strict
-        @strict ||= get :strict
+      def full_lib_dir
+        "#{source_dir}/#{lib_dir}"
       end
 
-      def tab_indent
-        @tab_indent ||= get :tab_indent
+      def lib_dir
+        @lib_dir ||= get :lib_dir
       end
 
-      def compact_short_flags
-        @compact_short_flags ||= get :compact_short_flags
+      def partials_extension
+        @partials_extension ||= get :partials_extension
       end
 
-      def env
-        @env ||= get(:env)&.to_sym
+      def production?
+        env == :production
       end
 
-      def env=(value)
-        @env = value&.to_sym
+      def source_dir
+        @source_dir ||= get :source_dir
       end
 
-      def production?
-        env == :production
+      def strict
+        @strict ||= get :strict
       end
 
-      def full_lib_dir
-        "#{source_dir}/#{lib_dir}"
+      def tab_indent
+        @tab_indent ||= get :tab_indent
+      end
+
+      def target_dir
+        @target_dir ||= get :target_dir
       end
 
     private

data/lib/bashly/templates/settings.yml

@@ -30,3 +30,6 @@ compact_short_flags: true
 # - production    generate a smaller script, without file markers
 # - development   generate with file markers
 env: development
+
+# The extension to use when reading/writing partial script snippets.
+partials_extension: sh

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '0.9.0'
+  VERSION = '0.9.2'
 end

data/lib/bashly/views/command/command_fallback.gtx

@@ -1,10 +1,13 @@
 = view_marker
 
-> "")
->   {{ function_name }}_usage >&2
->   exit 1
->   ;;
->
+if !default_command || default_command.default != 'force'
+  > "")
+  >   {{ function_name }}_usage >&2
+  >   exit 1
+  >   ;;
+  >
+end
+
 > *)
 
 if default_command
@@ -21,6 +24,7 @@ elsif extensible.is_a? String
   >     printf "{{ strings[:invalid_command] }}\n" "$action" >&2
   >     exit 1
   >   fi
+  >   ;;
   >
 
 elsif extensible
@@ -31,6 +35,7 @@ elsif extensible
   >     printf "{{ strings[:invalid_command] }}\n" "$action" >&2
   >     exit 1
   >   fi
+  >   ;;
   >
 
 else

data/lib/bashly/views/command/command_filter.gtx

@@ -4,8 +4,7 @@ if commands.any?
   > action=${1:-}
   > 
   > case $action in
-  >   -*)
-  >     ;;
+  >   -*) ;;
   > 
 
   commands.each do |command|

data/lib/bashly/views/command/default_assignments.gtx

@@ -2,11 +2,11 @@ if default_args.any? or default_flags.any?
   = view_marker
 
   default_args.each do |arg|
-    > [[ -n ${args[{{ arg.name }}]:-} ]] || args[{{ arg.name }}]="{{ arg.default }}"
+    > [[ -n ${args['{{ arg.name }}']:-} ]] || args['{{ arg.name }}']="{{ arg.default }}"
   end
 
   default_flags.each do |flag|
-    > [[ -n ${args[{{ flag.long }}]:-} ]] || args[{{ flag.long }}]="{{ flag.default }}"
+    > [[ -n ${args['{{ flag.long }}']:-} ]] || args['{{ flag.long }}']="{{ flag.default }}"
   end
 
   >

data/lib/bashly/views/command/dependencies_filter.gtx

@@ -5,8 +5,7 @@ if dependencies
     > if ! command -v {{ dependency }} >/dev/null 2>&1; then
     >   printf "{{ strings[:missing_dependency] % { dependency: dependency } }}\n" >&2
     if message and !message.empty?
-      >   # shellcheck disable=SC2059
-      >   printf "{{ message }}\n" >&2
+      >   printf "%s\n" "{{ message }}" >&2
     end
     >   exit 1
     > fi

data/lib/bashly/views/command/fixed_flags_filter.gtx

@@ -4,14 +4,14 @@
 >   case "${1:-}" in
 
 if root_command?
-  = short_flag_exist?("-v") ? "--version)" : "--version | -v)".indent(4)
+  = (short_flag_exist?("-v") ? "--version)" : "--version | -v)").indent(4)
   >       version_command
   >       exit
   >       ;;
   > 
 end
 
-= short_flag_exist?("-h") ? "--help)" : "--help | -h)".indent(4)
+= (short_flag_exist?("-h") ? "--help)" : "--help | -h)").indent(4)
 >       long_usage=yes
 >       <%= function_name %>_usage
 >       exit

data/lib/bashly/views/command/parse_requirements_case_catch_all.gtx

@@ -3,9 +3,9 @@
 if args.any?
   condition = "if"
   args.each do |arg|
-    > {{ condition }} [[ -z ${args[{{ arg.name }}]+x} ]]; then
+    > {{ condition }} [[ -z ${args['{{ arg.name }}']+x} ]]; then
     =   arg.render(:validations).indent 2
-    >   args[{{ arg.name }}]=$1
+    >   args['{{ arg.name }}']=$1
     >   shift
     
     condition = "elif"

data/lib/bashly/views/command/parse_requirements_case_repeatable.gtx

@@ -2,18 +2,17 @@
 
 condition = "if"
 args.each do |arg|
-  > {{ condition }} [[ -z ${args[{{ arg.name }}]+x} ]]; then
-  = arg.render(:validations).indent 2
-
+  = arg.render(:validations)
+  > {{ condition }} [[ -z ${args['{{ arg.name }}']+x} ]]; then
   if arg.repeatable
-    >   args[{{ arg.name }}]="\"$1\""
+    >   args['{{ arg.name }}']="\"$1\""
     >   shift
     > else
-    >   args[{{ arg.name }}]="${args[{{ arg.name }}]} \"$1\""
+    >   args['{{ arg.name }}']="${args[{{ arg.name }}]} \"$1\""
     >   shift
 
   else
-    >   args[{{ arg.name }}]=$1
+    >   args['{{ arg.name }}']=$1
     >   shift
 
   end

data/lib/bashly/views/command/parse_requirements_case_simple.gtx

@@ -3,9 +3,9 @@
 if args.any?
   condition = "if"
   args.each do |arg|
-    > {{ condition }} [[ -z ${args[{{ arg.name }}]+x} ]]; then
+    > {{ condition }} [[ -z ${args['{{ arg.name }}']+x} ]]; then
     > {{ arg.render(:validations).indent 2 }}
-    >   args[{{ arg.name }}]=$1
+    >   args['{{ arg.name }}']=$1
     >   shift
 
     condition = "elif"

data/lib/bashly/views/command/required_args_filter.gtx

@@ -2,7 +2,7 @@ if required_args.any?
   = view_marker
 
   required_args.each do |arg|
-    > if [[ -z ${args[{{ arg.name }}]+x} ]]; then
+    > if [[ -z ${args['{{ arg.name }}']+x} ]]; then
     >   printf "{{ strings[:missing_required_argument] % { arg: arg.name.upcase, usage: usage_string } }}\n" >&2
     >   exit 1
     > fi

data/lib/bashly/views/command/required_flags_filter.gtx

@@ -2,7 +2,7 @@ if required_flags.any?
   = view_marker
 
   required_flags.each do |flag|
-    > if [[ -z ${args[{{ flag.long }}]+x} ]]; then
+    > if [[ -z ${args['{{ flag.long }}']+x} ]]; then
     >   printf "{{ strings[:missing_required_flag] % { usage: flag.usage_string } }}\n" >&2
     >   exit 1
     > fi

data/lib/bashly/views/command/run.gtx

@@ -11,7 +11,7 @@
 
 deep_commands.each do |command|
   >     "{{ command.action_name }}")
-  >       if [[ ${args[--help]:-} ]]; then
+  >       if [[ ${args['--help']:-} ]]; then
   >         long_usage=yes
   >         {{ command.function_name }}_usage
   >       else
@@ -21,9 +21,11 @@ deep_commands.each do |command|
   >
 end
 
->     "root")
->       root_command
->       ;;
+if commands.empty?
+  >     "root")
+  >       root_command
+  >       ;;
+end
 >
 >   esac
 > }

data/lib/bashly/views/command/whitelist_filter.gtx

@@ -12,7 +12,7 @@ if whitelisted_args.any? or whitelisted_flags.any?
       > done
 
     else
-      > if [[ ! ${args[{{ arg.name }}]} =~ ^({{ arg.allowed.join '|' }})$ ]]; then
+      > if [[ ! ${args['{{ arg.name }}']} =~ ^({{ arg.allowed.join '|' }})$ ]]; then
       >   printf "%s\n" "{{ strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } }}" >&2
       >   exit 1
       > fi
@@ -31,7 +31,7 @@ if whitelisted_args.any? or whitelisted_flags.any?
       > done
     
     else
-      > if [[ ! ${args[{{ flag.name }}]} =~ ^({{ flag.allowed.join '|' }})$ ]]; then
+      > if [[ ! ${args['{{ flag.name }}']} =~ ^({{ flag.allowed.join '|' }})$ ]]; then
       >   printf "%s\n" "{{ strings[:disallowed_flag] % { name: flag.name, allowed: flag.allowed.join(', ') } }}" >&2
       >   exit 1
       > fi

data/lib/bashly/views/flag/case_arg.gtx

@@ -4,14 +4,14 @@
 = render(:validations).indent 2
 
 if repeatable
-  >   if [[ -z ${args[{{ name }}]+x} ]]; then
-  >     args[{{ name }}]="\"$2\""
+  >   if [[ -z ${args['{{ name }}']+x} ]]; then
+  >     args['{{ name }}']="\"$2\""
   >   else
-  >     args[{{ name }}]="${args[{{ name }}]} \"$2\""
+  >     args['{{ name }}']="${args[{{ name }}]} \"$2\""
   >   fi
 
 else
-  >   args[{{ name }}]="$2"
+  >   args['{{ name }}']="$2"
 
 end
 

data/lib/bashly/views/flag/case_no_arg.gtx

@@ -1,9 +1,9 @@
 = view_marker
 
 if repeatable
-  > ((args[<%= name %>]+=1))
+  > ((args['<%= name %>'] += 1))
 else
-  > args[<%= name %>]=1
+  > args['<%= name %>']=1
 end
 
 > shift

data/lib/bashly/views/flag/conflicts.gtx

@@ -3,7 +3,7 @@ if conflicts
   = view_marker
   
   if conflicts.count == 1
-    > if [[ -n "${args[{{ conflicts.first }}]:-}" ]]; then
+    > if [[ -n "${args['{{ conflicts.first }}']:-}" ]]; then
     >   printf "{{ strings[:conflicting_flags] }}\n" "$key" "{{ conflicts.first }}" >&2
     >   exit 1
     > fi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: completely