bashly 0.8.10 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93a8d1b32e641bee6713b57ed0cd3e970c8806273f02f900909553dd391d5b43
-  data.tar.gz: 4024323aa10f725b947d9b59c4019724bd26a58945ff1436102d57130a677442
+  metadata.gz: e1139c7453fff329c05879511103b80b6a89a76896a9d0cb3f5cad016d224b15
+  data.tar.gz: acda8a068081a04a32218be7ddfee8cad1612b3dfafd9e1465170fd9cded32db
 SHA512:
-  metadata.gz: 81a26b1e7eb07c45f596db2b3f787af3580cfdc9be9490b7b361670decdf582b3eeb996a889f8409631ea4f9470cb81812d73655727189844b833849e543bbb5
-  data.tar.gz: 3d52eb5364d947bfe5e8a9e3efa626d10da75ddd68f1dff3c279aca4f830f4ef52e17b6b65a95f2b4dfcba1927fecbcc5c9445d6f0e02dc472834f48bcb9284e
+  metadata.gz: 61247ecd7b928a4babdbf307004424ffa060c567a16b4eb4b062c59e51eb9812f3469981ead958bb4f08aee8cb7ecd86a32a830f6102211012540eac0b878fd4
+  data.tar.gz: 606e5df99d98e9853ed25a7fd516a807a90f1c40d7f19ac2ab1b8f3388a82919dd59af3b291d8de7b866d88cdcb8b1fec7883bd258b80c04f137b1729e58aca1

data/README.md

@@ -73,6 +73,13 @@ 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

data/bin/bashly

@@ -9,9 +9,9 @@ begin
   exit runner.run ARGV
 rescue Bashly::Interrupt
   say! "\nGoodbye"
-  exit 1  
+  exit 1
 rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
   say! "!undred!#{e.class}!txtrst!\n#{e.message}"
   exit 1
-end
+end

data/lib/bashly/cli.rb

@@ -1,12 +1,12 @@
 require 'mister_bin'
 
 module Bashly
-  # The CLI class is used by the bashly binary and forwards incoming CLI 
+  # The CLI class is used by the bashly binary and forwards incoming CLI
   # commands to the relevant Bashly::Commands class
   class CLI
     def self.runner
       runner = MisterBin::Runner.new version: Bashly::VERSION,
-        header: "Bashly - Bash CLI Generator",
+        header: 'Bashly - Bash CLI Generator',
         footer: "Help: !txtpur!bashly COMMAND --help!txtrst!\nDocs: !undblu!https://bashly.dannyb.co"
 
       runner.route 'init',      to: Commands::Init
@@ -18,5 +18,4 @@ module Bashly
       runner
     end
   end
-
 end

data/lib/bashly/commands/add.rb

@@ -1,40 +1,61 @@
 module Bashly
   module Commands
     class Add < Base
-      help "Add extra features and customization to your script"
-
-      usage "bashly add colors [--force]"
-      usage "bashly add comp FORMAT [OUTPUT --force]"
-      usage "bashly add config [--force]"
-      usage "bashly add lib [--force]"
-      usage "bashly add settings [--force]"
-      usage "bashly add strings [--force]"
-      usage "bashly add test [--force]"
-      usage "bashly add validations [--force]"
-      usage "bashly add yaml [--force]"
-      usage "bashly add (-h|--help)"
-
-      option "-f --force", "Overwrite existing files"
-
-      param "FORMAT", "Output format, can be one of:\n  function : generate a function file to be included in your script.\n  script   : generate a standalone bash completions script.\n  yaml     : generate a yaml compatible with completely."
-      param "OUTPUT", "For the 'comp function' command: Name of the generated function.\nFor the 'comp script' or 'comp yaml' commands: path to output file.\nIn all cases, this is optional and will have sensible defaults."
-
-      command "colors", "Add standard functions for printing colorful and formatted text to the lib directory."
-      command "comp", "Generate a bash completions script or function."
-      command "config", "Add standard functions for handling INI files to the lib directory."
-      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 "settings", "Copy a sample settings.yml file to your project, allowing you to customize some bashly options."
-      command "strings", "Copy an additional configuration file to your project, allowing you to customize all the tips and error strings."
-      command "test", "Add approval testing."
-      command "validations", "Add argument validation functions to the lib directory."
-      command "yaml", "Add standard functions for reading YAML files to the lib directory."
-
-      example "bashly add strings --force"
-      example "bashly add comp function"
-      example "bashly add comp script completions.bash"
-
-      environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
-      environment "BASHLY_LIB_DIR", "The path to use for creating the library files, relative to the source dir [default: lib]"
+      help 'Add extra features and customization to your script'
+
+      usage 'bashly add colors [--force]'
+      usage 'bashly add comp FORMAT [OUTPUT --force]'
+      usage 'bashly add config [--force]'
+      usage 'bashly add help [--force]'
+      usage 'bashly add lib [--force]'
+      usage 'bashly add settings [--force]'
+      usage 'bashly add strings [--force]'
+      usage 'bashly add test [--force]'
+      usage 'bashly add validations [--force]'
+      usage 'bashly add yaml [--force]'
+      usage 'bashly add (-h|--help)'
+
+      option '-f --force', 'Overwrite existing files'
+
+      param 'FORMAT', <<~USAGE
+        Output format, can be one of:
+          function : generate a function file to be included in your script.
+          script   : generate a standalone bash completions script.
+          yaml     : generate a yaml compatible with completely.
+      USAGE
+
+      param 'OUTPUT', <<~USAGE
+        For the 'comp function' command: Name of the generated function.
+        For the 'comp script' or 'comp yaml' commands: path to output file.
+        In all cases, this is optional and will have sensible defaults.
+      USAGE
+
+      command 'colors', 'Add standard functions for printing colorful and formatted text to the lib directory.'
+      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', <<~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.'
+
+      command 'strings', 'Copy an additional configuration file to your project, allowing you to customize all the ' \
+        'tips and error strings.'
+
+      command 'test', 'Add approval testing.'
+      command 'validations', 'Add argument validation functions to the lib directory.'
+      command 'yaml', 'Add standard functions for reading YAML files to the lib directory.'
+      example 'bashly add strings --force'
+      example 'bashly add comp function'
+      example 'bashly add comp script completions.bash'
+
+      environment 'BASHLY_SOURCE_DIR', 'The path containing the bashly configuration and source files [default: src]'
+      environment 'BASHLY_LIB_DIR', 'The path to use for creating the library files, relative to the source dir ' \
+        '[default: lib]'
 
       attr_reader :skip_src_check
 
@@ -47,9 +68,9 @@ module Bashly
         output = args['OUTPUT']
 
         case format
-        when "script"   then add_lib 'completions_script', output
-        when "function" then add_lib 'completions', output
-        when "yaml"     then add_lib 'completions_yaml', output
+        when 'script'   then add_lib 'completions_script', output
+        when 'function' then add_lib 'completions', output
+        when 'yaml'     then add_lib 'completions_yaml', output
         else            raise Error, "Unrecognized format: #{format}"
         end
       end
@@ -58,6 +79,10 @@ module Bashly
         add_lib 'config'
       end
 
+      def lib_command
+        add_lib 'lib'
+      end
+
       def settings_command
         @skip_src_check = true
         add_lib 'settings'
@@ -67,22 +92,22 @@ module Bashly
         add_lib 'strings'
       end
 
-      def lib_command
-        add_lib 'lib'
-      end
-
       def test_command
         add_lib 'test'
       end
 
-      def yaml_command
-        add_lib 'yaml'
+      def help_command
+        add_lib 'help'
       end
 
       def validations_command
         add_lib 'validations'
       end
 
+      def yaml_command
+        add_lib 'yaml'
+      end
+
     private
 
       def add_lib(name, *args)
@@ -93,26 +118,28 @@ module Bashly
           files_created += 1 if created
         end
         message = library.post_install_message
-        say "\n#{message}" if message and files_created > 0
+        say "\n#{message}" if message && files_created.positive?
       end
 
       def safe_write(path, content)
-        if !skip_src_check and !Dir.exist? Settings.source_dir
-          raise InitError, "Directory !txtgrn!#{Settings.source_dir}!txtrst! does not exist\nRun !txtpur!bashly init!txtrst! first"
+        if !skip_src_check && !Dir.exist?(Settings.source_dir)
+          raise InitError, <<~ERROR
+            Directory !txtgrn!#{Settings.source_dir}!txtrst! does not exist
+            Run !txtpur!bashly init!txtrst! first
+          ERROR
         end
 
-        if File.exist? path and !args['--force']
+        if File.exist?(path) && !args['--force']
           say "!txtblu!skipped!txtrst! #{path} (exists)"
           false
-        
+
         else
           File.deep_write path, content
           say "!txtgrn!created!txtrst! #{path}"
           true
-        
+
         end
       end
-
     end
   end
 end

data/lib/bashly/commands/base.rb

@@ -25,9 +25,10 @@ module Bashly
       end
 
       def show_deprecations
-        return if config_validator.deprecations.empty? or ENV['BASHLY_HIDE_DEPRECATIONS']
-        messages = "\n" + config_validator.deprecations.map(&:message).join("\n\n") + "\n\n"
-        say! messages
+        return if config_validator.deprecations.empty? || ENV['BASHLY_HIDE_DEPRECATIONS']
+
+        messages = config_validator.deprecations.map(&:message).join("\n\n")
+        say! "\n#{messages}\n\n"
       end
     end
   end

data/lib/bashly/commands/generate.rb

@@ -3,34 +3,41 @@ require 'filewatcher'
 module Bashly
   module Commands
     class Generate < Base
-      help "Generate the bash script and required files"
-
-      usage "bashly generate [options]"
-      usage "bashly generate (-h|--help)"
-
-      option "-f --force", "Overwrite existing files"
-      option "-q --quiet", "Disable on-screen progress report"
-      option "-u --upgrade", "Upgrade all added library functions"
-      option "-w --watch", "Watch the source directory for changes and regenerate on change"
-      option "-r --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
-      option "-e --env ENV", "Force the generation environment (see BASHLY_ENV)"
-
-      environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
-      environment "BASHLY_TARGET_DIR", "The path to use for creating the bash script [default: .]"
-      environment "BASHLY_LIB_DIR", "The path to use for upgrading library files, relative to the source dir [default: lib]"
-      environment "BASHLY_STRICT", "When not empty, enable bash strict mode (set -euo pipefail)"
-      environment "BASHLY_TAB_INDENT", "When not empty, the generated script will use tab indentation instead of spaces (every 2 leading spaces will be converted to a tab character)"
-      environment "BASHLY_ENV", <<~EOF
+      help 'Generate the bash script and required files'
+
+      usage 'bashly generate [options]'
+      usage 'bashly generate (-h|--help)'
+
+      option '-f --force', 'Overwrite existing files'
+      option '-q --quiet', 'Disable on-screen progress report'
+      option '-u --upgrade', 'Upgrade all added library functions'
+      option '-w --watch', 'Watch the source directory for changes and regenerate on change'
+      option '-r --wrap FUNCTION', 'Wrap the entire script in a function so it can also be sourced'
+      option '-e --env ENV', 'Force the generation environment (see BASHLY_ENV)'
+
+      environment 'BASHLY_SOURCE_DIR', 'The path containing the bashly configuration and source ' \
+        'files [default: src]'
+
+      environment 'BASHLY_TARGET_DIR', 'The path to use for creating the bash script [default: .]'
+      environment 'BASHLY_LIB_DIR',
+        'The path to use for upgrading library files, relative to the source dir [default: lib]'
+
+      environment 'BASHLY_STRICT', 'When not empty, enable bash strict mode (set -euo pipefail)'
+      environment 'BASHLY_TAB_INDENT',
+        'When not empty, the generated script will use tab indentation instead of spaces ' \
+          '(every 2 leading spaces will be converted to a tab character)'
+
+      environment 'BASHLY_ENV', <<~HELP
         Set to 'production' or 'development':
         - production    generate a smaller script, without file markers
         - development   generate with file markers
 
         Can be overridden with --env [default: development]
-      EOF
+      HELP
 
-      example "bashly generate --force"
-      example "bashly generate --wrap my_function"
-      example "bashly g -uw"
+      example 'bashly generate --force'
+      example 'bashly generate --wrap my_function'
+      example 'bashly g -uw'
 
       attr_reader :watching
 
@@ -56,13 +63,12 @@ module Bashly
 
         ensure
           quiet_say "!txtgrn!waiting\n"
-        
         end
       end
 
       def generate
         with_valid_config do
-          quiet_say "creating !txtgrn!production!txtrst! version" if Settings.production?
+          quiet_say 'creating !txtgrn!production!txtrst! version' if Settings.production?
           generate_all_files
           quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script" unless watching
         end
@@ -88,12 +94,11 @@ module Bashly
       def upgrade_libs
         generated_files.each do |file|
           content = File.read file
-          
-          if content =~ /\[@bashly-upgrade (.+)\]/
-            args = $1.split ' '
-            library_name = args.shift
-            upgrade file, library_name, *args
-          end
+          next unless content =~ /\[@bashly-upgrade (.+)\]/
+
+          args = $1.split
+          library_name = args.shift
+          upgrade file, library_name, *args
         end
       end
 
@@ -105,7 +110,8 @@ module Bashly
         if Library.exist? library_name
           upgrade! existing_file, library_name, *args
         else
-          quiet_say "!txtred!warning!txtrst! not upgrading !txtcyn!#{existing_file}!txtrst!, unknown library '#{library_name}'"
+          quiet_say "!txtred!warning!txtrst! not upgrading !txtcyn!#{existing_file}!txtrst!, " \
+            "unknown library '#{library_name}'"
         end
       end
 
@@ -124,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
@@ -140,6 +147,7 @@ module Bashly
       def create_all_command_files
         command.deep_commands.each do |subcommand|
           next if subcommand.commands.any?
+
           file = "#{Settings.source_dir}/#{subcommand.filename}"
           content = subcommand.render :default_script
           create_file file, content
@@ -147,7 +155,7 @@ module Bashly
       end
 
       def create_file(file, content)
-        if File.exist? file and !args['--force']
+        if File.exist?(file) && !args['--force']
           quiet_say "!txtblu!skipped!txtrst! #{file} (exists)"
         else
           File.deep_write file, content
@@ -157,12 +165,12 @@ module Bashly
 
       def create_master_script
         File.write master_script_path, script.code(tab_indent: Settings.tab_indent)
-        FileUtils.chmod "+x", master_script_path
+        FileUtils.chmod '+x', master_script_path
         quiet_say "!txtgrn!created!txtrst! #{master_script_path}"
       end
 
       def script
-        @script ||= Script::Wrapper.new(command, args['--wrap'])
+        @script ||= Script::Wrapper.new command, args['--wrap']
       end
 
       def master_script_path
@@ -172,7 +180,6 @@ module Bashly
       def command
         @command ||= Script::Command.new config
       end
-
     end
   end
 end

data/lib/bashly/commands/init.rb

@@ -1,24 +1,25 @@
 module Bashly
   module Commands
     class Init < Base
-      summary "Initialize a new workspace"
-      help "This command will create the source folder, and place a template configuration file in it."
+      summary 'Initialize a new workspace'
+      help 'This command will create the source folder, and place a template configuration file in it.'
 
-      usage "bashly init [--minimal]"
-      usage "bashly init (-h|--help)"
+      usage 'bashly init [--minimal]'
+      usage 'bashly init (-h|--help)'
 
-      option "-m --minimal", "Use a minimal configuration file (without commands)"
+      option '-m --minimal', 'Use a minimal configuration file (without commands)'
 
-      environment "BASHLY_SOURCE_DIR", "The path to use for creating the configuration file [default: src]"
+      environment 'BASHLY_SOURCE_DIR', 'The path to use for creating the configuration file [default: src]'
 
       def run
-        if Dir.exist? target_dir and !Dir.empty? target_dir
+        if Dir.exist?(target_dir) && !Dir.empty?(target_dir)
           raise InitError, "Directory !txtgrn!#{target_dir}!txtrst! already exists and is not empty"
         end
-        Dir.mkdir target_dir unless Dir.exist? target_dir
+
+        FileUtils.mkdir_p target_dir
         File.write "#{target_dir}/bashly.yml", yaml_content
         say "!txtgrn!created!txtrst! #{target_dir}/bashly.yml"
-        say "run !txtpur!bashly generate!txtrst! to create the bash script"
+        say 'run !txtpur!bashly generate!txtrst! to create the bash script'
       end
 
     private

data/lib/bashly/commands/preview.rb

@@ -1,12 +1,12 @@
 module Bashly
   module Commands
     class Preview < Base
-      help "Generate the bash script to STDOUT"
+      help 'Generate the bash script to STDOUT'
 
-      usage "bashly preview"
-      usage "bashly preview (-h|--help)"
+      usage 'bashly preview'
+      usage 'bashly preview (-h|--help)'
 
-      environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
+      environment 'BASHLY_SOURCE_DIR', 'The path containing the bashly configuration and source files [default: src]'
 
       def run
         with_valid_config do

data/lib/bashly/commands/validate.rb

@@ -1,25 +1,26 @@
 module Bashly
   module Commands
     class Validate < Base
-      help "Scan the configuration file for errors"
+      help 'Scan the configuration file for errors'
 
-      usage "bashly validate [--verbose]"
-      usage "bashly validate (-h|--help)"
+      usage 'bashly validate [--verbose]'
+      usage 'bashly validate (-h|--help)'
 
-      option "-v --verbose", "Show the bashly configuration file prior to validating. This is useful when using split config (import) since it will show the final compiled configuration."
+      option '-v --verbose', 'Show the bashly configuration file prior to validating. ' \
+        'This is useful when using split config (import) since it will show the final compiled configuration.'
 
-      environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
+      environment 'BASHLY_SOURCE_DIR', 'The path containing the bashly configuration and source files [default: src]'
 
       def run
         if args['--verbose']
           lp config
-          puts "---"
+          puts '---'
         end
         validate_config
         show_deprecations
         deprecations = config_validator.deprecations
         if deprecations.empty?
-          say "!txtgrn!OK"
+          say '!txtgrn!OK'
         else
           say "!txtred!WARNING!txtrst! Found #{deprecations.count} deprecations"
         end

data/lib/bashly/concerns/asset_helper.rb

@@ -8,4 +8,4 @@ module Bashly
       File.read asset(path)
     end
   end
-end
+end

data/lib/bashly/concerns/completions.rb

@@ -6,16 +6,14 @@ module Bashly
   module Completions
     module Flag
       def completion_data(command_full_name)
-        result = {}
         comps = allowed || completions
+        return {} unless comps
 
-        if comps
-          aliases.each do |name|
-            result["#{command_full_name}*#{name}"] = comps
-          end
+        aliases.to_h do |name|
+          prefix = command_full_name
+          prefix = "#{prefix}*" unless prefix.end_with? '*'
+          ["#{prefix}#{name}",  comps]
         end
-
-        result
       end
     end
 
@@ -23,13 +21,14 @@ module Bashly
       def completion_data(with_version: true)
         result = {}
 
-        all_full_names.each do |name|
-          result[name] = completion_words(with_version: with_version)
+        completion_full_names.each do |name|
+          name = "#{name}*" if name.include? '*'
+          result[name] = completion_words with_version: with_version
           flags.each do |flag|
             result.merge! flag.completion_data(name)
           end
         end
-        
+
         commands.each do |command|
           result.merge! command.completion_data(with_version: false)
         end
@@ -42,13 +41,24 @@ module Bashly
       end
 
       def completion_function(name = nil)
-        completion_generator.wrapper_function(name)
+        completion_generator.wrapper_function name
+      end
+
+    protected
+
+      def completion_full_names
+        if parent_command
+          glue = parent_command.global_flags? ? '*' : ' '
+          parent_command.completion_full_names.product(aliases).map { |a| a.join glue }
+        else
+          aliases
+        end
       end
 
     private
 
       def completion_generator
-        Completely::Completions.new(completion_data)
+        Completely::Completions.new completion_data
       end
 
       def completion_flag_names
@@ -63,14 +73,13 @@ module Bashly
         trivial_flags = %w[--help -h]
         trivial_flags += %w[--version -v] if with_version
         all = (
-          command_aliases + trivial_flags + 
+          command_aliases + trivial_flags +
           completion_flag_names + completion_allowed_args
         )
 
         all += completions if completions
         all.compact.uniq.sort
       end
-
     end
   end
-end
+end

data/lib/bashly/concerns/renderable.rb

@@ -11,7 +11,7 @@ module Bashly
     end
 
     def view_marker(id = nil)
-      id ||= ":#{caller_locations.first.path}"
+      id ||= ":#{caller_locations(1..1).first.path}"
       "# #{id}" unless Settings.production?
     end
 
@@ -23,7 +23,7 @@ module Bashly
       content = if File.exist? path
         File.read(path).remove_front_matter
       elsif placeholder
-        %q[echo "error: cannot load file"]
+        'echo "error: cannot load file"'
       else
         ''
       end
@@ -38,15 +38,15 @@ module Bashly
     end
 
     def self_views_path
-      @self_view_path ||= "#{base_views_path}/#{views_subfolder}"
+      @self_views_path ||= "#{base_views_path}/#{views_subfolder}"
     end
 
     def base_views_path
-      @base_views_path ||= File.expand_path("../views/", __dir__)
+      @base_views_path ||= File.expand_path '../views/', __dir__
     end
 
     def views_subfolder
       @views_subfolder ||= self.class.name.split('::').last.to_underscore
     end
   end
-end
+end