bashly 0.9.5 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34993542fcfa09d73fa8a1e0a0dceff571612efd1fa93211d3656279301c6f95
-  data.tar.gz: '04218807cb6464dd9cfb5bcf2d8e3b442b67885cd44d91942b5e3f900a3c29b6'
+  metadata.gz: b23af9b1533c906c685ef6f62620bb32b55fb45599e354e85548e800d7ecf832
+  data.tar.gz: e65e8f10fefd0b2945c9c31459ee427b9688a5d8565880ddbce3021d2b8b1c6a
 SHA512:
-  metadata.gz: f03c2c3cb8a8fa45c12fcc9a06c5d12a21303b2917c0ada24b60e6895606eac42b5fcfb411702aa24e8bc0885e454f7ad8f4b874294888fb673b323178bbcd81
-  data.tar.gz: 1c1e28ac06bbc58d573d9b4e2270cde6628059af9ac4377c4c1c8393f488646ccfcb3cc2d8abc8b1e2332219720a8340b2f15b6e829f66725a27024d772e3d5e
+  metadata.gz: 4c82c7e9a804e2d95d1a4179aaf96948c7f9e8150f64ace8d8b87b990a5157f22def814289f2aebb82869fafdd38fb03fc3aeec4fc752ff836c37efe0e53e389
+  data.tar.gz: b82bc5d7be814046b42fc959238f3a455d3f1f9c17fa0d2a5e1a3cd2e516db64db33ed9d62afcdfef8368f33a7c3b5a4b65ac58bd9d3aa308aacc1130e9983de

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

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/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'
@@ -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,16 +93,25 @@ 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 "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

data/lib/bashly/commands/init.rb

@@ -9,8 +9,6 @@ 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 g`#{target_dir}` already exists and is not empty"

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 'g`OK`'
-        else
-          say "r`WARNING` 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/{help.rb → help/help.rb}

@@ -29,7 +29,7 @@ module Bashly
     private
 
       def help_command
-        asset_content('templates/help/help_command.sh') % { name: command.name }
+        asset_content('libraries/help/help_command.sh') % { name: command.name }
       end
     end
   end

data/lib/bashly/libraries/libraries.yml

@@ -0,0 +1,85 @@
+colors:
+  help: Add standard functions for printing colorful and formatted text to the lib directory.
+  files:
+    - source: "colors/colors.sh"
+      target: "%{user_lib_dir}/colors.%{user_ext}"
+
+completions: 
+  help: Generate a bash completions function.
+  usage: '[PATH]'
+  handler: Bashly::Libraries::CompletionsFunction
+
+completions_script:
+  help: Generate a standalone bash completions script.
+  usage: '[PATH]'
+  handler: Bashly::Libraries::CompletionsScript
+
+completions_yaml:
+  help: Generate a completions YAML configuration for Completely.
+  usage: '[PATH]'
+  handler: Bashly::Libraries::CompletionsYAML
+
+config:
+  help: Add standard functions for handling INI files to the lib directory.
+  files:
+    - source: "config/config.sh"
+      target: "%{user_lib_dir}/config.%{user_ext}"
+
+help:
+  help: Add a help command, in addition to the standard --help flag.
+  handler: Bashly::Libraries::Help
+
+lib:
+  help: |-
+    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.
+  files:
+    - source: "lib/sample_function.sh"
+      target: "%{user_lib_dir}/sample_function.%{user_ext}"
+
+settings:
+  help: Copy a sample settings.yml file to your project, allowing you to customize some bashly options.
+  skip_src_check: true
+  files:
+    - source: "settings/settings.yml"
+      target: "settings.yml"
+
+strings:
+  help: Copy an additional configuration file to your project, allowing you to customize all the tips and error strings.
+  files:
+    - source: "strings/strings.yml"
+      target: "%{user_source_dir}/bashly-strings.yml"
+
+test:
+  help: Add approval testing.
+  files:
+    - source: "test/approvals.bash"
+      target: "%{user_target_dir}/test/approvals.bash"
+    - source: "test/approve"
+      target: "%{user_target_dir}/test/approve"
+
+  post_install_message: |
+    Edit your tests in g`test/approve` and then run:
+
+      m`$ test/approve`
+
+    Docs: bu`https://github.com/DannyBen/approvals.bash`
+
+validations:
+  help: Add argument validation functions to the lib directory.
+  files:
+    - source: "validations/validate_dir_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_dir_exists.%{user_ext}"
+    - source: "validations/validate_file_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_file_exists.%{user_ext}"
+    - source: "validations/validate_integer.sh"
+      target: "%{user_lib_dir}/validations/validate_integer.%{user_ext}"
+    - source: "validations/validate_not_empty.sh"
+      target: "%{user_lib_dir}/validations/validate_not_empty.%{user_ext}"
+
+yaml:
+  help: Add standard functions for reading YAML files.
+  files:
+    - source: "yaml/yaml.sh"
+      target: "%{user_lib_dir}/yaml.%{user_ext}"

data/lib/bashly/{templates → libraries/settings}/settings.yml

@@ -5,10 +5,16 @@
 # When setting environment variables, you can use:
 # - "0", "false" or "no" to represent false
 # - "1", "true" or "yes" to represent true
+#
+# If you wish to change the path to this file, set the environment variable
+# BASHLY_SETTINGS_PATH.
 
-# The path containing the bashly configuration and source files
+# The path containing the bashly source files
 source_dir: src
 
+# Tha path to bashly.yml
+config_path: "%{source_dir}/bashly.yml"
+
 # The path to use for creating the bash script
 target_dir: .
 

data/lib/bashly/library.rb

@@ -1,25 +1,12 @@
 module Bashly
   class Library
-    class << self
-      def exist?(name)
-        config.has_key? name.to_s
-      end
-
-      def config
-        @config ||= YAML.properly_load_file config_path
-      end
-
-      def config_path
-        @config_path ||= File.expand_path 'libraries.yml', __dir__
-      end
-    end
-
-    include AssetHelper
-    attr_reader :name, :args
+    attr_reader :path, :config, :upgrade_string
+    attr_accessor :args
 
-    def initialize(name, *args)
-      @name = name.to_s
-      @args = args
+    def initialize(path, config, upgrade_string: nil)
+      @path = path.to_s
+      @config = config
+      @upgrade_string = upgrade_string
     end
 
     def files
@@ -28,8 +15,10 @@ module Bashly
 
       else
         config['files'].map do |file|
-          { path:    file['target'] % target_file_args,
-            content: asset_content(file['source']) }
+          {
+            path:    file['target'] % target_file_args,
+            content: file_contents("#{path}/#{file['source']}"),
+          }
         end
       end
     end
@@ -49,13 +38,13 @@ module Bashly
   private
 
     def custom_handler
-      return nil unless config.is_a? Symbol
+      return nil unless config['handler']
 
-      @custom_handler ||= Bashly::Libraries.const_get(config).new(*args)
+      @custom_handler ||= Module.const_get(config['handler']).new(*args)
     end
 
-    def config
-      @config ||= self.class.config[name]
+    def file_contents(path)
+      File.read(path).sub('[@bashly-upgrade]', "[@bashly-upgrade #{upgrade_string}]")
     end
 
     def target_file_args

data/lib/bashly/library_source.rb

@@ -0,0 +1,84 @@
+require 'fileutils'
+
+module Bashly
+  class LibrarySource
+    attr_reader :uri
+
+    def initialize(uri = nil)
+      @uri = uri || File.expand_path('libraries', __dir__)
+      transform_github_uri if /^github(:|-)/.match? @uri
+    end
+
+    def git?
+      /^(git|github|github-ssh):/.match? uri
+    end
+
+    def config
+      @config ||= YAML.properly_load_file config_path
+    end
+
+    def libraries
+      config.to_h do |name, spec|
+        upgrade_string = "#{uri};#{name}"
+        [name.to_sym, Library.new(path, spec, upgrade_string: upgrade_string)]
+      end
+    end
+
+    def config_path
+      @config_path ||= if File.exist?("#{path}/libraries.yml")
+        "#{path}/libraries.yml"
+      else
+        raise "Cannot find #{path}/libraries.yml"
+      end
+    end
+
+    def cleanup
+      FileUtils.rm_rf(File.join(Dir.tmpdir, 'bashly-libs-*'))
+    end
+
+  private
+
+    def path
+      @path ||= if uri.start_with? 'git:'
+        git_clone
+      else
+        uri
+      end
+    end
+
+    def git_clone
+      dir = Dir.mktmpdir 'bashly-libs-'
+      safe_run "git clone --quiet #{git_specs[:url]} #{dir}"
+      safe_run %[git -C "#{dir}" checkout --quiet #{git_specs[:ref]}] if git_specs[:ref]
+
+      "#{dir}#{git_specs[:path]}"
+    end
+
+    def git_specs
+      @git_specs ||= begin
+        parts = uri.match(%r{git:(?<url>.*\.git)(?:/)?(?<path>/[^@]+)?@?(?<ref>.*)})
+        raise 'Invalid source' unless parts
+
+        url = parts[:url]
+        raise 'Invalid git URL' unless url
+
+        path = parts[:path]
+        ref = parts[:ref].empty? ? nil : parts[:ref]
+
+        { url: url, path: path, ref: ref }
+      end
+    end
+
+    def safe_run(cmd)
+      raise "Failed running command:\nm`#{cmd}`" unless system cmd
+    end
+
+    def transform_github_uri
+      if (matches = uri.match(%r{github-ssh:(?<user>[^/]+)/(?<repo>[^/]+)(?<rest>.*)}))
+        @uri = "git:git@github.com:#{matches[:user]}/#{matches[:repo]}.git#{matches[:rest]}"
+      elsif (matches = uri.match(%r{github:(?<user>[^/]+)/(?<repo>[^/]+)(?<rest>.*)}))
+        @uri = "git:https://github.com/#{matches[:user]}/#{matches[:repo]}.git#{matches[:rest]}"
+      end
+    end
+  end
+end

data/lib/bashly/message_strings.rb

@@ -13,7 +13,7 @@ module Bashly
   private
 
     def values!
-      defaults = YAML.properly_load_file asset('templates/strings.yml')
+      defaults = YAML.properly_load_file asset('libraries/strings/strings.yml')
       defaults.merge project_strings
     end
 

data/lib/bashly/script/command.rb

@@ -11,9 +11,7 @@ module Bashly
             extensible expose filename filters flags
             footer function group help name
             private version
-            short
           ]
-          # DEPRECATION 0.8.0
         end
       end
 
@@ -36,8 +34,6 @@ module Bashly
 
       # Returns an array of alternative aliases if any
       def alt
-        # DEPRECATION 0.8.0
-        options['alias'] ||= options['short']
         return [] unless options['alias']
 
         options['alias'].is_a?(String) ? [options['alias']] : options['alias']
@@ -217,6 +213,16 @@ module Bashly
         commands.reject(&:private)
       end
 
+      # Returns only environment variables that are not private
+      def public_environment_variables
+        environment_variables.reject(&:private)
+      end
+
+      # Returns only flags that are not private
+      def public_flags
+        flags.reject(&:private)
+      end
+
       # Returns true if one of the args is repeatable
       def repeatable_arg_exist?
         args.select(&:repeatable).any?

data/lib/bashly/script/flag.rb

@@ -7,7 +7,7 @@ module Bashly
         def option_keys
           @option_keys ||= %i[
             allowed arg completions conflicts default help long repeatable
-            required short validate
+            required short validate private
           ]
         end
       end

data/lib/bashly/settings.rb

@@ -3,13 +3,26 @@ module Bashly
     class << self
       include AssetHelper
 
-      attr_writer :compact_short_flags, :lib_dir, :partials_extension,
-        :source_dir, :strict, :tab_indent, :target_dir, :usage_colors
+      attr_writer(
+        :compact_short_flags,
+        :config_path,
+        :lib_dir,
+        :partials_extension,
+        :source_dir,
+        :strict,
+        :tab_indent,
+        :target_dir,
+        :usage_colors
+      )
 
       def compact_short_flags
         @compact_short_flags ||= get :compact_short_flags
       end
 
+      def config_path
+        @config_path ||= get(:config_path) % { source_dir: source_dir }
+      end
+
       def env
         @env ||= get(:env)&.to_sym
       end
@@ -74,7 +87,11 @@ module Bashly
       end
 
       def user_settings
-        @user_settings ||= File.exist?('settings.yml') ? Config.new('settings.yml') : {}
+        @user_settings ||= File.exist?(user_settings_path) ? Config.new(user_settings_path) : {}
+      end
+
+      def user_settings_path
+        ENV['BASHLY_SETTINGS_PATH'] || 'settings.yml'
       end
 
       def defsult_settings
@@ -82,7 +99,7 @@ module Bashly
       end
 
       def default_settings_path
-        asset 'templates/settings.yml'
+        asset 'libraries/settings/settings.yml'
       end
     end
   end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '0.9.5'
+  VERSION = '1.0.0.rc1'
 end

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

@@ -3,10 +3,10 @@
 > if [[ -n $long_usage ]]; then
 >   printf "%s\n" "{{ strings[:options].color(:caption) }}"
 >
+= render(:usage_flags).indent 2 if public_flags.any?
 = render(:usage_fixed_flags).indent 2
-= render(:usage_flags).indent 2 if flags.any?
 = render(:usage_args).indent 2 if args.any? or catch_all.help
-= render(:usage_environment_variables).indent 2 if environment_variables.any?
+= render(:usage_environment_variables).indent 2 if public_environment_variables.any?
 = render(:usage_examples).indent 2 if examples
 = render(:footer).indent 2 if footer
 >

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

@@ -3,7 +3,7 @@
 > printf "%s\n" "{{ strings[:environment_variables].color(:caption) }}"
 > 
 
-environment_variables.reject(&:private).each do |env_var|
+public_environment_variables.each do |env_var|
   = env_var.render :usage
 end
 

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

@@ -1,6 +1,6 @@
 = view_marker
 
-flags.each do |flag|
+public_flags.each do |flag|
   = flag.render :usage
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -138,7 +138,6 @@ files:
 - lib/bashly/concerns/validation_helpers.rb
 - lib/bashly/config.rb
 - lib/bashly/config_validator.rb
-- lib/bashly/deprecation.rb
 - lib/bashly/docs/arg.yml
 - lib/bashly/docs/command.yml
 - lib/bashly/docs/env.yml
@@ -148,13 +147,27 @@ files:
 - lib/bashly/extensions/file.rb
 - lib/bashly/extensions/string.rb
 - lib/bashly/extensions/yaml.rb
-- lib/bashly/libraries.yml
 - lib/bashly/libraries/base.rb
-- lib/bashly/libraries/completions_function.rb
-- lib/bashly/libraries/completions_script.rb
-- lib/bashly/libraries/completions_yaml.rb
-- lib/bashly/libraries/help.rb
+- lib/bashly/libraries/colors/colors.sh
+- lib/bashly/libraries/completions/completions_function.rb
+- lib/bashly/libraries/completions/completions_script.rb
+- lib/bashly/libraries/completions/completions_yaml.rb
+- lib/bashly/libraries/config/config.sh
+- lib/bashly/libraries/help/help.rb
+- lib/bashly/libraries/help/help_command.sh
+- lib/bashly/libraries/lib/sample_function.sh
+- lib/bashly/libraries/libraries.yml
+- lib/bashly/libraries/settings/settings.yml
+- lib/bashly/libraries/strings/strings.yml
+- lib/bashly/libraries/test/approvals.bash
+- lib/bashly/libraries/test/approve
+- lib/bashly/libraries/validations/validate_dir_exists.sh
+- lib/bashly/libraries/validations/validate_file_exists.sh
+- lib/bashly/libraries/validations/validate_integer.sh
+- lib/bashly/libraries/validations/validate_not_empty.sh
+- lib/bashly/libraries/yaml/yaml.sh
 - lib/bashly/library.rb
+- lib/bashly/library_source.rb
 - lib/bashly/message_strings.rb
 - lib/bashly/refinements/compose_refinements.rb
 - lib/bashly/script/argument.rb
@@ -166,20 +179,7 @@ files:
 - lib/bashly/script/wrapper.rb
 - lib/bashly/settings.rb
 - lib/bashly/templates/bashly.yml
-- lib/bashly/templates/help/help_command.sh
-- lib/bashly/templates/lib/colors.sh
-- lib/bashly/templates/lib/config.sh
-- lib/bashly/templates/lib/sample_function.sh
-- lib/bashly/templates/lib/validations/validate_dir_exists.sh
-- lib/bashly/templates/lib/validations/validate_file_exists.sh
-- lib/bashly/templates/lib/validations/validate_integer.sh
-- lib/bashly/templates/lib/validations/validate_not_empty.sh
-- lib/bashly/templates/lib/yaml.sh
 - lib/bashly/templates/minimal.yml
-- lib/bashly/templates/settings.yml
-- lib/bashly/templates/strings.yml
-- lib/bashly/templates/test/approvals.bash
-- lib/bashly/templates/test/approve
 - lib/bashly/version.rb
 - lib/bashly/views/README.md
 - lib/bashly/views/argument/usage.gtx
@@ -254,11 +254,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator

data/lib/bashly/deprecation.rb

@@ -1,27 +0,0 @@
-module Bashly
-  class Deprecation
-    attr_reader :old, :replacement, :reference
-
-    def initialize(old, replacement: nil, reference: nil)
-      @old = old
-      @replacement = replacement
-      @reference = reference
-    end
-
-    def message
-      result = ['Deprecation Warning:', "r`#{old}` is deprecated"]
-      result.push "use g`#{replacement}` instead" if replacement
-      result.push "see bu`#{reference}`" if reference
-
-      result.map { |line| "r`▐` #{line}" }.join("\n")
-    end
-
-    def to_h
-      {
-        old:         old,
-        replacement: replacement,
-        reference:   reference,
-      }
-    end
-  end
-end

data/lib/bashly/libraries.yml

@@ -1,60 +0,0 @@
-colors:
-  files:
-    - source: "templates/lib/colors.sh"
-      target: "%{user_lib_dir}/colors.%{user_ext}"
-
-completions: :CompletionsFunction
-completions_script: :CompletionsScript
-completions_yaml: :CompletionsYAML
-
-config:
-  files:
-    - source: "templates/lib/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.%{user_ext}"
-
-settings:
-  files:
-    - source: "templates/settings.yml"
-      target: "settings.yml"
-
-strings:
-  files:
-    - source: "templates/strings.yml"
-      target: "%{user_source_dir}/bashly-strings.yml"
-
-test:
-  files:
-    - source: "templates/test/approvals.bash"
-      target: "%{user_target_dir}/test/approvals.bash"
-    - source: "templates/test/approve"
-      target: "%{user_target_dir}/test/approve"
-
-  post_install_message: |
-    Edit your tests in g`test/approve` and then run:
-
-      m`$ test/approve`
-
-    Docs: bu`https://github.com/DannyBen/approvals.bash`
-
-validations:
-  files:
-    - source: "templates/lib/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.%{user_ext}"
-    - source: "templates/lib/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.%{user_ext}"
-
-yaml:
-  files:
-    - source: "templates/lib/yaml.sh"
-      target: "%{user_lib_dir}/yaml.%{user_ext}"