bashly 0.8.8 → 0.8.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d91ebd35f74173621d545d29ff7ea404341638c7b06aa0610cb1ab10dfba93a
-  data.tar.gz: 81b1516fd118e2f985d5fd6b88cfa07db8f3b01eb91895d069587de26586bb1d
+  metadata.gz: 93a8d1b32e641bee6713b57ed0cd3e970c8806273f02f900909553dd391d5b43
+  data.tar.gz: 4024323aa10f725b947d9b59c4019724bd26a58945ff1436102d57130a677442
 SHA512:
-  metadata.gz: f366a6add6ae9c750f07c219393f613dc381e7ade0f18e94fef716364fbcecdbcac7cb8f5cdaf2101ea2c2f0040dab72303e740d87508750f627b71e4dbca39f
-  data.tar.gz: 3327229305d123a6ea878846035fb4fbb0e33a6d7f6fd81ee3e203b1c89cd29d36cc36822908c31faa5fa97edba98a69db941fece386849aeafbdfef4cdea978
+  metadata.gz: 81a26b1e7eb07c45f596db2b3f787af3580cfdc9be9490b7b361670decdf582b3eeb996a889f8409631ea4f9470cb81812d73655727189844b833849e543bbb5
+  data.tar.gz: 3d52eb5364d947bfe5e8a9e3efa626d10da75ddd68f1dff3c279aca4f830f4ef52e17b6b65a95f2b4dfcba1927fecbcc5c9445d6f0e02dc472834f48bcb9284e

data/lib/bashly/commands/validate.rb

@@ -3,12 +3,18 @@ module Bashly
     class Validate < Base
       help "Scan the configuration file for errors"
 
-      usage "bashly validate"
+      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."
+
       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

data/lib/bashly/config_validator.rb

@@ -119,6 +119,7 @@ module Bashly
       assert_optional_string "#{key}.footer", value['footer']
       assert_optional_string "#{key}.group", value['group']
       assert_optional_string "#{key}.filename", value['filename']
+      assert_optional_string "#{key}.function", value['function']
 
       assert_boolean "#{key}.private", value['private']
       assert_boolean "#{key}.default", value['default']
@@ -126,6 +127,7 @@ module Bashly
       assert_version "#{key}.version", value['version']
       assert_catch_all "#{key}.catch_all", value['catch_all']
       assert_string_or_array "#{key}.alias", value['alias']
+      assert_string_or_array "#{key}.examples", value['examples']
       assert_extensible "#{key}.extensible", value['extensible']
       
       assert_array "#{key}.args", value['args'], of: :arg
@@ -135,13 +137,16 @@ module Bashly
       assert_array "#{key}.dependencies", value['dependencies'], of: :string
       assert_array "#{key}.filters", value['filters'], of: :string
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
-      assert_array "#{key}.examples", value['examples'], of: :string
 
       assert_uniq "#{key}.commands", value['commands'], ['name', 'alias']
       assert_uniq "#{key}.flags", value['flags'], 'long'
       assert_uniq "#{key}.flags", value['flags'], 'short'
       assert_uniq "#{key}.args", value['args'], 'name'
 
+      if value['function']
+        assert value['function'].match(/^[a-z0-9_]+$/), "#{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

data/lib/bashly/script/command.rb

@@ -9,7 +9,7 @@ module Bashly
             alias args catch_all commands completions
             default dependencies environment_variables examples
             extensible expose filename filters flags
-            footer group help name
+            footer function group help name
             private version
             short
           ]
@@ -152,6 +152,12 @@ module Bashly
         end
       end
 
+      # Returns an array of examples
+      def examples
+        return nil unless options["examples"]
+        options["examples"].is_a?(Array) ? options['examples'] : [options['examples']]
+      end
+
       # Returns the bash filename that is expected to hold the user code
       # for this command
       def filename
@@ -168,7 +174,7 @@ module Bashly
 
       # Returns a unique name, suitable to be used in a bash function
       def function_name
-        full_name.to_underscore
+        options['function'] || full_name.to_underscore
       end
 
       # Returns the name of the command, including its parent name (in case

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.8.8"
+  VERSION = "0.8.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.8.10
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-08 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: completely
@@ -53,21 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: mister_bin
+  name: filewatcher
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: requires
+  name: lp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -81,19 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: filewatcher
+  name: mister_bin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: requires
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: Generate bash command line tools using YAML configuration
 email: db@dannyben.com
 executables: