fix specs

Author: DannyBen

lib/bashly/commands/doc.rb

@@ -7,11 +7,12 @@ class Doc < Base
       usage 'bashly doc [SEARCH] [--index]'
       usage 'bashly doc (-h|--help)'
 
-      option "-i --index", "Show option keys only"
+      option '-i --index', 'Show option keys only'
       param 'SEARCH', 'Search for options that match this text'
 
       example 'bashly doc command'
       example 'bashly doc command.flags'
+      example 'bashly doc flag. -i'
       example 'bashly doc catch_all'
 
       def run
@@ -46,7 +47,7 @@ def show_url(url)
       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*- )/, '!txtylw!\1!txtrst!')
         example.gsub!(/^(\s*#.+)/, '!txtpur!\1!txtrst!')
         say example
         say ''
@@ -61,15 +62,14 @@ def show_help(help)
 
       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'] }
+        result = raw_data.select { |k, _v| k.include? args['SEARCH'] }
         return result if result.any?
 
-        say! "!txtred!No match"
-        exit 1
+        raise Error, "No match"
       end
 
       def raw_data
@@ -83,7 +83,7 @@ def raw_data
       end
 
       def docs_dir
-        @docs_dir ||= File.expand_path "../docs", __dir__
+        @docs_dir ||= File.expand_path '../docs', __dir__
       end
     end
   end

lib/bashly/docs/command.yml

@@ -29,7 +29,7 @@ command.alias:
       name: download
       alias: [d, pull]
 
-    # Run this commnad with anything that starts with 's'.
+    # Run this command with anything that starts with 's'.
     command:
       name: server
       alias: s*
@@ -58,7 +58,7 @@ command.catch_all:
       help: Upload one or more files
 
       # Use this extended syntax in order to also provide a usage label
-      # for these arguemnts, as well as specifying that at least one is
+      # for these arguments, as well as specifying that at least one is
       # required.
       catch_all:
         label: Files
@@ -87,7 +87,7 @@ command.completions:
       - $(git branch 2> /dev/null)
 
 command.default:
-  help: Specify that this sub-command will be executed implicitely.
+  help: Specify that this sub-command will be executed implicitly.
   url: https://bashly.dannyb.co/configuration/command/#default
   example: |-
     # This command will execute when the command line is not
@@ -139,7 +139,7 @@ command.examples:
     - cli download example.com
     - cli download example.com ./output -f
 
-    # Use a multiline string when you need more control.
+    # Use a multi-line string when you need more control.
     # Note the use of the '|-' marker that tells YAML to use the
     # string as is, including the newlines it contains.
     examples: |-
@@ -271,7 +271,7 @@ command.group:
       group: Server
 
 command.help:
-  help: Specify the help text to show when showing uwags.
+  help: Specify the help text to show when displaying usage.
   url: https://bashly.dannyb.co/configuration/command/#help
   example: |-
     name: docker

spec/approvals/cli/commands

@@ -6,6 +6,7 @@ Commands:
   validate  Scan the configuration file for errors
   generate  Generate the bash script and required files
   add       Add extra features and customization to your script
+  doc       Show bashly reference documentation
 
 Help: bashly COMMAND --help
 Docs: https://bashly.dannyb.co

spec/approvals/cli/doc/env_Var

@@ -0,0 +1,14 @@
+environment_variable
+
+  Define environment variables that will be in use in your script.
+
+    environment_variables:
+    - name: config_path
+      help: Location of the config file
+      default: ~/config.ini
+    - name: api_key
+      help: Your API key
+      required: true
+
+  See https://bashly.dannyb.co/configuration/environment-variable/
+