bashly 0.9.4 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 810dfb8f0b25029420a1479aa38d682a79787716112d9b5f9c816533fc3e97ea
-  data.tar.gz: c6782bd0bf01a475b137487dcdec634645484c877386b1ccaaa8432d53831595
+  metadata.gz: b23af9b1533c906c685ef6f62620bb32b55fb45599e354e85548e800d7ecf832
+  data.tar.gz: e65e8f10fefd0b2945c9c31459ee427b9688a5d8565880ddbce3021d2b8b1c6a
 SHA512:
-  metadata.gz: 3c6cb7413b619b50cd76ecfa66d704623780f05f3316e1e9bcb9e7a3c02a4a3b9a9215759e928e32e4d6492993fb5b5cbcb6ba0379bd0fe638f6ab1182b791a4
-  data.tar.gz: e83491e2a1ab364701351a74bbef05377bbe479521fe907b8f9b1dc3fa567be4f5b53f87c4f4d4dd4313e9fff16ab84e07dd5cbfae5ed7ff0f4c2d44b98d69bd
+  metadata.gz: 4c82c7e9a804e2d95d1a4179aaf96948c7f9e8150f64ace8d8b87b990a5157f22def814289f2aebb82869fafdd38fb03fc3aeec4fc752ff836c37efe0e53e389
+  data.tar.gz: b82bc5d7be814046b42fc959238f3a455d3f1f9c17fa0d2a5e1a3cd2e516db64db33ed9d62afcdfef8368f33a7c3b5a4b65ac58bd9d3aa308aacc1130e9983de

data/README.md

@@ -13,7 +13,7 @@ Create feature-rich bash scripts using simple YAML configuration
 
 ---
 
-![demo](demo/cast.svg)
+![demo](demo/cast.gif)
 
 </div>
 

data/bin/bashly

@@ -12,6 +12,6 @@ rescue Bashly::Interrupt
   exit 1
 rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
-  say! "!undred!#{e.class}!txtrst!\n#{e.message}"
+  say! "rib` #{e.class} `\n#{e.message}"
   exit 1
 end

data/lib/bashly/cli.rb

@@ -7,7 +7,7 @@ module Bashly
     def self.runner
       runner = MisterBin::Runner.new version: Bashly::VERSION,
         header: 'Bashly - Bash CLI Generator',
-        footer: "Help: !txtpur!bashly COMMAND --help!txtrst!\nDocs: !undblu!https://bashly.dannyb.co"
+        footer: "Help: m`bashly COMMAND --help`\nDocs: bu`https://bashly.dannyb.co`"
 
       runner.route 'init',      to: Commands::Init
       runner.route 'preview',   to: Commands::Preview

data/lib/bashly/commands/add.rb

@@ -3,120 +3,72 @@ module Bashly
     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 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 [--source NAME] LIBRARY [ARGS...] [--force]'
+      usage 'bashly add [--source NAME] --list'
       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
+      option '-s --source NAME', <<~USAGE
+        Specify a different libraries source. NAME can be:
 
-      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.
+        * Path to a local libraries directory
+        * GitHub (HTTPS) repository:  github:user/repo[//path@ref]
+        * GitHub (SSH) repository:    github-ssh:user/repo[//path@ref]
+        * Remote git repository:      git:repo-url.git[//path@ref]
       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]'
+      option '-f --force', 'Overwrite existing files'
+      option '-l --list', 'Show available libraries'
 
       attr_reader :skip_src_check
 
-      def colors_command
-        add_lib 'colors'
-      end
-
-      def comp_command
-        format = args['FORMAT']
-        output = args['OUTPUT']
+      def run
+        say "Performing git operations, this may take a while...\n" if lib_source.git?
 
-        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
-        else            raise Error, "Unrecognized format: #{format}"
+        if args['--list']
+          show_list
+        else
+          add_lib args['LIBRARY']
         end
-      end
 
-      def config_command
-        add_lib 'config'
+        lib_source.cleanup if lib_source.git?
       end
 
-      def lib_command
-        add_lib 'lib'
-      end
+    private
 
-      def settings_command
-        @skip_src_check = true
-        add_lib 'settings'
+      def source
+        args['--source']
       end
 
-      def strings_command
-        add_lib 'strings'
+      def lib_source
+        @lib_source ||= Bashly::LibrarySource.new source
       end
 
-      def test_command
-        add_lib 'test'
+      def show_list
+        lib_source.config.each do |key, config|
+          usage = key
+          usage += " #{config['usage']}" if config['usage']
+          say "g`#{usage}`"
+          say word_wrap("  #{config['help']}")
+          say ''
+        end
       end
 
-      def help_command
-        add_lib 'help'
-      end
+      def add_lib(name)
+        library = lib_source.libraries[name.to_sym]
+        raise "Unknown library: g`#{name}`\nRun m`bashly add --list` to see available libraries" unless library
 
-      def validations_command
-        add_lib 'validations'
-      end
+        library.args = args['ARGS']
+        @skip_src_check = lib_source.config.dig name, 'skip_src_check'
 
-      def yaml_command
-        add_lib 'yaml'
+        add_library_files library
       end
 
-    private
-
-      def add_lib(name, *args)
-        library = Bashly::Library.new name, *args
+      def add_library_files(library)
         files_created = 0
         library.files.each do |file|
           created = safe_write file[:path], file[:content]
           files_created += 1 if created
         end
+
         message = library.post_install_message
         say "\n#{message}" if message && files_created.positive?
       end
@@ -124,18 +76,18 @@ module Bashly
       def safe_write(path, content)
         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
+            Directory g`#{Settings.source_dir}` does not exist
+            Run m`bashly init` first
           ERROR
         end
 
         if File.exist?(path) && !args['--force']
-          say "!txtblu!skipped!txtrst! #{path} (exists)"
+          say "b`skipped` #{path} (exists)"
           false
 
         else
           File.deep_write path, content
-          say "!txtgrn!created!txtrst! #{path}"
+          say "g`created` #{path}"
           true
 
         end

data/lib/bashly/commands/base.rb

@@ -7,7 +7,7 @@ module Bashly
       include AssetHelper
 
       def config
-        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
+        @config ||= Config.new Settings.config_path
       end
 
       def config_validator
@@ -21,14 +21,6 @@ module Bashly
       def with_valid_config
         validate_config
         yield
-        show_deprecations
-      end
-
-      def show_deprecations
-        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/doc.rb

@@ -35,27 +35,27 @@ module Bashly
       end
 
       def show_key(key)
-        say "!txtgrn!#{key}"
+        say "g`#{key}`"
         say ''
       end
 
       def show_url(url)
-        say "  See !undblu!#{url}"
+        say "  See bu`#{url}`"
         say ''
       end
 
       def show_example(example)
         example = word_wrap "    #{example}"
-        example.gsub!(/^(\s*- )?(\s*\w+):/, '\1!txtblu!\2!txtrst!:')
-        example.gsub!(/^(\s*- )/, '!txtylw!\1!txtrst!')
-        example.gsub!(/^(\s*#.+)/, '!txtpur!\1!txtrst!')
+        example.gsub!(/^(\s*- )?(\s*\w+):/, '\1b`\2`:')
+        example.gsub!(/^(\s*- )/, 'y`\1`')
+        example.gsub!(/^(\s*#.+)/, 'm`\1`')
         say example
         say ''
       end
 
       def show_help(help)
         help = word_wrap "  #{help}"
-        help.gsub!(/`([^`]+)`/, '!txtgrn!\1!txtrst!')
+        help.gsub!(/`([^`]+)`/, 'g`\1`')
         say help
         say ''
       end
@@ -63,7 +63,7 @@ module Bashly
       def data
         return raw_data unless args['SEARCH']
 
-        result = raw_data.select { |k, _v| k.== args['SEARCH'] }
+        result = raw_data.select { |k, _v| k == args['SEARCH'] }
         return result if result.any?
 
         result = raw_data.select { |k, _v| k.include? args['SEARCH'] }

data/lib/bashly/commands/generate.rb

@@ -13,26 +13,11 @@ module Bashly
       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)'
+      option '-e --env ENV', <<~HELP
+        Force the generation environment:
 
-      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]
       HELP
 
       example 'bashly generate --force'
@@ -52,25 +37,25 @@ module Bashly
     private
 
       def watch
-        quiet_say "!txtgrn!watching!txtrst! #{Settings.source_dir}\n"
+        quiet_say "g`watching` #{Settings.source_dir}\n"
 
         Filewatcher.new([Settings.source_dir]).watch do
           reset
           generate
 
         rescue Bashly::ConfigurationError => e
-          say! "!undred!#{e.class}!txtrst!\n#{e.message}"
+          say! "rib` #{e.class} `\n#{e.message}"
 
         ensure
-          quiet_say "!txtgrn!waiting\n"
+          quiet_say "g`waiting`\n"
         end
       end
 
       def generate
         with_valid_config do
-          quiet_say 'creating !txtgrn!production!txtrst! version' if Settings.production?
+          quiet_say 'creating g`production` version' if Settings.production?
           generate_all_files
-          quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script" unless watching
+          quiet_say "run m`#{master_script_path} --help` to test your bash script" unless watching
         end
       end
 
@@ -97,6 +82,7 @@ module Bashly
           next unless content =~ /\[@bashly-upgrade (.+)\]/
 
           args = $1.split
+
           library_name = args.shift
           upgrade file, library_name, *args
         end
@@ -107,28 +93,37 @@ module Bashly
       end
 
       def upgrade(existing_file, library_name, *args)
-        if Library.exist? library_name
-          upgrade! existing_file, library_name, *args
+        if library_name.include? ';'
+          source_name, library_name = library_name.split(';')
+          source = Bashly::LibrarySource.new source_name
+        else
+          source = Bashly::LibrarySource.new
+        end
+
+        library = source.libraries[library_name.to_sym]
+
+        if library
+          library.args = args
+          upgrade! existing_file, library
         else
-          quiet_say "!txtred!warning!txtrst! not upgrading !txtcyn!#{existing_file}!txtrst!, " \
+          quiet_say "r`warning` not upgrading c`#{existing_file}`, " \
             "unknown library '#{library_name}'"
         end
       end
 
-      def upgrade!(existing_file, library_name, *args)
-        library = Bashly::Library.new library_name, *args
+      def upgrade!(existing_file, library)
         file = library.find_file existing_file
 
         if file
           File.deep_write file[:path], file[:content]
-          quiet_say "!txtcyn!updated!txtrst! #{file[:path]}"
+          quiet_say "c`updated` #{file[:path]}"
         else
-          quiet_say "!txtred!warning!txtrst! not upgrading !txtcyn!#{existing_file}!txtrst!, path mismatch"
+          quiet_say "r`warning` not upgrading c`#{existing_file}`, path mismatch"
         end
       end
 
       def create_user_files
-        quiet_say "creating user files in !txtgrn!#{Settings.source_dir}"
+        quiet_say "creating user files in g`#{Settings.source_dir}`"
 
         create_file "#{Settings.source_dir}/initialize.#{Settings.partials_extension}",
           command.render(:default_initialize_script)
@@ -156,17 +151,17 @@ module Bashly
 
       def create_file(file, content)
         if File.exist?(file) && !args['--force']
-          quiet_say "!txtblu!skipped!txtrst! #{file} (exists)"
+          quiet_say "b`skipped` #{file} (exists)"
         else
           File.deep_write file, content
-          quiet_say "!txtgrn!created!txtrst! #{file}"
+          quiet_say "g`created` #{file}"
         end
       end
 
       def create_master_script
         File.write master_script_path, script.code(tab_indent: Settings.tab_indent)
         FileUtils.chmod '+x', master_script_path
-        quiet_say "!txtgrn!created!txtrst! #{master_script_path}"
+        quiet_say "g`created` #{master_script_path}"
       end
 
       def script

data/lib/bashly/commands/init.rb

@@ -9,17 +9,15 @@ module Bashly
 
       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]'
-
       def run
         if Dir.exist?(target_dir) && !Dir.empty?(target_dir)
-          raise InitError, "Directory !txtgrn!#{target_dir}!txtrst! already exists and is not empty"
+          raise InitError, "Directory g`#{target_dir}` already exists and is not empty"
         end
 
         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 "g`created` #{target_dir}/bashly.yml"
+        say 'run m`bashly generate` to create the bash script'
       end
 
     private

data/lib/bashly/commands/preview.rb

@@ -6,8 +6,6 @@ module Bashly
       usage 'bashly preview'
       usage 'bashly preview (-h|--help)'
 
-      environment 'BASHLY_SOURCE_DIR', 'The path containing the bashly configuration and source files [default: src]'
-
       def run
         with_valid_config do
           command = Script::Command.new config

data/lib/bashly/commands/validate.rb

@@ -11,21 +11,13 @@ module Bashly
       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]'
-
       def run
         if args['--verbose']
           lp config
           puts '---'
         end
         validate_config
-        show_deprecations
-        deprecations = config_validator.deprecations
-        if deprecations.empty?
-          say '!txtgrn!OK'
-        else
-          say "!txtred!WARNING!txtrst! Found #{deprecations.count} deprecations"
-        end
+        say 'g`OK`'
       end
     end
   end

data/lib/bashly/concerns/validation_helpers.rb

@@ -2,10 +2,6 @@ module Bashly
   # This is a `ConfigValidator` concern responsible for providing basic
   # assertion methods.
   module ValidationHelpers
-    def deprecations
-      @deprecations ||= []
-    end
-
   protected
 
     def assert(valid, message)
@@ -16,10 +12,6 @@ module Bashly
       assert !invalid, message
     end
 
-    def deprecate(key, **options)
-      deprecations.push Deprecation.new(key, **options)
-    end
-
     def assert_string(key, value)
       assert value.is_a?(String), "#{key} must be a string"
     end

data/lib/bashly/config_validator.rb

@@ -99,6 +99,7 @@ module Bashly
       assert_optional_string "#{key}.default", value['default']
       assert_optional_string "#{key}.validate", value['validate']
 
+      assert_boolean "#{key}.private", value['private']
       assert_boolean "#{key}.repeatable", value['repeatable']
       assert_boolean "#{key}.required", value['required']
       assert_array "#{key}.allowed", value['allowed'], of: :string
@@ -131,10 +132,6 @@ module Bashly
       assert_optional_string "#{key}.default", value['default']
       assert_boolean "#{key}.required", value['required']
       assert_boolean "#{key}.private", value['private']
-
-      if value['private']
-        assert value['default'], "#{key}.private makes no sense without default"
-      end
     end
 
     def assert_command(key, value)
@@ -196,11 +193,6 @@ module Bashly
         refute value['version'], "#{key}.version makes no sense"
         refute value['extensible'], "#{key}.extensible makes no sense"
       end
-
-      # DEPRECATION 0.8.0
-      if value['short']
-        deprecate "#{key}.short", replacement: 'alias', reference: 'https://github.com/DannyBen/bashly/pull/220'
-      end
     end
   end
 end

data/lib/bashly/docs/command.yml

@@ -75,7 +75,7 @@ command.commands:
       help: Register a local repository
 
 command.completions:
-  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add comp`.
+  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add completions`.
   url: https://bashly.dannyb.co/configuration/command/#completions
   example: |-
     commands:

data/lib/bashly/docs/env.yml

@@ -36,7 +36,7 @@ environment_variable.name:
       help: Your API key
 
 environment_variable.private:
-  help: Specify that this environment variable should not be advertised in the usage text. Only makes sense when accompanied by `default`.
+  help: Specify that this environment variable should not be advertised in the usage text.
   url: https://bashly.dannyb.co/configuration/environment-variable/#private
   example: |-
     environment_variables:

data/lib/bashly/docs/flag.yml

@@ -46,7 +46,7 @@ flag.arg:
       help: Clone using SSH
 
 flag.completions:
-  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add comp`. Must be accompanied by `arg`.
+  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add completions`. Must be accompanied by `arg`.
   url: https://bashly.dannyb.co/configuration/flag/#completions
   example: |-
     flags:
@@ -112,6 +112,16 @@ flag.long:
       short: -s
       help: Clone using SSH
 
+flag.private:
+  help: Specify that this flag should not be displayed in the help text.
+  url: https://bashly.dannyb.co/configuration/flag/#private
+  example: |-
+    flags:
+    - long: --legacy
+      short: -l
+      help: Run using the legacy mode
+      private: true
+
 flag.repeatable:
   help: |-
     Specify that this flag can be provided multiple times. When used on a flag with an argument, it will be received as a space-delimited string, which needs to be converted to an array with:

data/lib/bashly/libraries/base.rb

@@ -22,7 +22,7 @@ module Bashly
       end
 
       def config
-        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
+        @config ||= Config.new Settings.config_path
       end
     end
   end

data/lib/bashly/libraries/{completions_function.rb → completions/completions_function.rb}

@@ -12,11 +12,11 @@ module Bashly
 
       def post_install_message
         <<~MESSAGE
-          In order to enable completions in your script, create a command or a flag (for example: !txtgrn!#{command.name} completions!txtrst! or !txtgrn!#{command.name} --completions!txtrst!) that calls the !txtgrn!#{function_name}!txtrst! function.
+          In order to enable completions in your script, create a command or a flag (for example: g`#{command.name} completions` or g`#{command.name} --completions`) that calls the g`#{function_name}` function.
 
           Your users can then run something like this to enable completions:
 
-            !txtpur!$ eval "$(#{command.name} completions)"
+            m`$ eval "$(#{command.name} completions)"`
         MESSAGE
       end
 

data/lib/bashly/libraries/{completions_script.rb → completions/completions_script.rb}

@@ -14,7 +14,7 @@ module Bashly
         <<~MESSAGE
           In order to enable completions, run:
 
-            !txtpur!$ source #{target_path}
+            m`$ source #{target_path}`
         MESSAGE
       end
 

data/lib/bashly/libraries/{completions_yaml.rb → completions/completions_yaml.rb}

@@ -12,7 +12,7 @@ module Bashly
 
       def post_install_message
         <<~MESSAGE
-          This file can be converted to a completions script using the !txtgrn!completely!txtrst! gem.
+          This file can be converted to a completions script using the g`completely` gem.
         MESSAGE
       end