bashly 0.9.2 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebf951958bb0478fb95b88273b87ccb2f297d36b655996b79d16c2ffdb32e773
-  data.tar.gz: aa3a9c218e9876fea287f141191baa4d95b40ae8b5569a7418c40911373e43ef
+  metadata.gz: 810dfb8f0b25029420a1479aa38d682a79787716112d9b5f9c816533fc3e97ea
+  data.tar.gz: c6782bd0bf01a475b137487dcdec634645484c877386b1ccaaa8432d53831595
 SHA512:
-  metadata.gz: 468d632281f56529a13770dce48d3bfbfc19433f2d32f52c0741b0d3c3ff80b15ad78b1936897e451d341f74b0d68ed6e5dd753ed4ed155984890b97ef8fbcf9
-  data.tar.gz: 4af3052a3d4b66b647bb461b6300eae17f72cfa61ef419f917fc6a23b881cb0af11dfb37d04628b2afedbf99f080ab04e2a5104d90d4ce148a01ceda1c2c2816
+  metadata.gz: 3c6cb7413b619b50cd76ecfa66d704623780f05f3316e1e9bcb9e7a3c02a4a3b9a9215759e928e32e4d6492993fb5b5cbcb6ba0379bd0fe638f6ab1182b791a4
+  data.tar.gz: e83491e2a1ab364701351a74bbef05377bbe479521fe907b8f9b1dc3fa567be4f5b53f87c4f4d4dd4313e9fff16ab84e07dd5cbfae5ed7ff0f4c2d44b98d69bd

data/lib/bashly/cli.rb

@@ -14,6 +14,7 @@ module Bashly
       runner.route 'validate',  to: Commands::Validate
       runner.route 'generate',  to: Commands::Generate
       runner.route 'add',       to: Commands::Add
+      runner.route 'doc',       to: Commands::Doc
 
       runner
     end

data/lib/bashly/commands/doc.rb

@@ -0,0 +1,90 @@
+module Bashly
+  module Commands
+    class Doc < Base
+      summary 'Show bashly reference documentation'
+      help 'This command displays bite-sized help for all the bashly configuration options in the terminal.'
+
+      usage 'bashly doc [SEARCH] [--index]'
+      usage 'bashly doc (-h|--help)'
+
+      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
+        if args['--index']
+          puts data.keys
+        else
+          show
+        end
+      end
+
+    private
+
+      def show
+        data.each do |key, info|
+          show_key key
+          show_help info['help']
+          show_example info['example'] if info['example']
+          show_url info['url'] if info['url']
+        end
+      end
+
+      def show_key(key)
+        say "!txtgrn!#{key}"
+        say ''
+      end
+
+      def show_url(url)
+        say "  See !undblu!#{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!')
+        say example
+        say ''
+      end
+
+      def show_help(help)
+        help = word_wrap "  #{help}"
+        help.gsub!(/`([^`]+)`/, '!txtgrn!\1!txtrst!')
+        say help
+        say ''
+      end
+
+      def data
+        return raw_data unless 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'] }
+        return result if result.any?
+
+        raise Error, 'No match'
+      end
+
+      def raw_data
+        @raw_data ||= begin
+          result = {}
+          Dir["#{docs_dir}/*.yml"].sort.each do |path|
+            result.merge! YAML.load_file(path)
+          end
+          result
+        end
+      end
+
+      def docs_dir
+        @docs_dir ||= File.expand_path '../docs', __dir__
+      end
+    end
+  end
+end

data/lib/bashly/commands/validate.rb

@@ -1,3 +1,5 @@
+require 'lp'
+
 module Bashly
   module Commands
     class Validate < Base

data/lib/bashly/docs/arg.yml

@@ -0,0 +1,94 @@
+arg:
+  help: Define positional arguments.
+  url: https://bashly.dannyb.co/configuration/argument/
+  example: |-
+    args:
+    - name: user
+      help: AWS Username.
+      required: true
+
+    - name: role
+      help: User role.
+      default: admin
+      allowed:
+      - admin
+      - guest
+
+arg.allowed:
+  help: Specify a list of allowed values. Can be used in conjunction with `default` and `required`.
+  url: https://bashly.dannyb.co/configuration/argument/#allowed
+  example: |-
+    args:
+    - name: region
+      help: Region to connect to
+      
+      # allowed + required
+      allowed: [eu, us]
+      required: true
+
+    - name: environment
+      help: Environment to connect to
+      
+      # allowed + default
+      allowed: [stage, production, development]
+      default: development
+
+arg.default:
+  help: Specify the value to apply when not provided by the user.
+  url: https://bashly.dannyb.co/configuration/argument/#default
+  example: |-
+    args:
+    - name: images
+      help: Image files to convert.
+      default: "*.jpg"
+
+arg.help:
+  help: Specify the help message for this argument.
+  url: https://bashly.dannyb.co/configuration/argument/#help
+  example: |-
+    args:
+    - name: user
+      help: AWS Username.
+      required: true
+
+arg.name:
+  help: Specify the lowercase name of the argument.
+  url: https://bashly.dannyb.co/configuration/argument/#name
+  example: |-
+    args:
+    - name: user
+      help: AWS Username.
+      required: true
+
+arg.repeatable:
+  help: |-
+    Specify that this argument can be provided multiple times.
+
+    The argument below will be received as a space-delimited string which needs to be converted to an array with:
+    `eval "data=(${args[file]})"`
+
+  url: https://bashly.dannyb.co/configuration/argument/#repeatable
+  example: |-
+    args:
+    - name: file
+      help: One or more files to process
+      required: true
+      repeatable: true
+
+arg.required:
+  help: Specify that this argument is required.
+  url: https://bashly.dannyb.co/configuration/argument/#required
+  example: |-
+    args:
+    - name: region
+      help: Region to connect to
+      required: true
+
+arg.validate:
+  help: Apply custom validation functions.
+
+  url: https://bashly.dannyb.co/configuration/argument/#validate
+  example: |-
+    args:
+    - name: path
+      validate: file_exists

data/lib/bashly/docs/command.yml

@@ -0,0 +1,310 @@
+command:
+  help: Define the root command, or any sub-command.
+  url: https://bashly.dannyb.co/configuration/command/
+  example: |-
+    name: rush
+    help: Personal package manager
+    version: 0.6.5
+
+    commands:
+    - name: add
+      alias: a
+      help: Register a local repository
+      args:
+      - name: repo
+        required: true
+        help: Repository name.
+
+command.alias:
+  help: Specify one or more aliases for this sub-command.
+  url: https://bashly.dannyb.co/configuration/command/#alias
+  example: |-
+    # Define a single alias
+    command:
+      name: download
+      alias: d
+
+    # Define multiple aliases
+    command:
+      name: download
+      alias: [d, pull]
+
+    # Run this command with anything that starts with 's'.
+    command:
+      name: server
+      alias: s*
+
+command.args:
+  help: Define a list of positional arguments. See `arg` for reference.
+  url: https://bashly.dannyb.co/configuration/command/#args
+  example: |-
+    args:
+    - name: repo
+      required: true
+      help: Repository name.
+
+command.catch_all:
+  help: Specify that this command should allow for additional arbitrary arguments or flags.
+  url: https://bashly.dannyb.co/configuration/command/#catch_all
+  example: |-
+    commands:
+    - name: download
+      help: Download one or more URLs
+      
+      # Set to 'true' to simply enable this option
+      catch_all: true
+
+    - name: upload
+      help: Upload one or more files
+
+      # Use this extended syntax in order to also provide a usage label
+      # for these arguments, as well as specifying that at least one is
+      # required.
+      catch_all:
+        label: Files
+        help: Files to upload
+        required: true
+
+command.commands:
+  help: Define a list of sub-commands. See `command` for reference.
+  url: https://bashly.dannyb.co/configuration/command/#commands
+  example: |-
+    commands:
+    - name: add
+      alias: a
+      help: Register a local repository
+
+command.completions:
+  help: Specify a list of additional completion suggestions when used in conjunction with `bashly add comp`.
+  url: https://bashly.dannyb.co/configuration/command/#completions
+  example: |-
+    commands:
+    - name: view
+      help: View a directory, system user or a git branch
+      completions:
+      - <directory>
+      - <user>
+      - $(git branch 2> /dev/null)
+
+command.default:
+  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
+    # recognized.
+    commands:
+    - name: upload
+      help: Upload a file
+      default: true
+
+    # This command will execute when the command line is not
+    # recognized, or when it is empty.
+    commands:
+    - name: all
+      help: Run all tests
+      default: force
+
+command.dependencies:
+  help: Specify a list of required external commands that are needed to run this command.
+  url: https://bashly.dannyb.co/configuration/command/#dependencies
+  example: |-
+    # Array syntax
+    dependencies:
+    - docker
+    - curl
+
+    # Hash syntax, to provide additional help message
+    dependencies:
+      docker: see https://docker.com for installation instructions
+      git: "install by running: sudo apt install git"
+  
+command.environment_variables:
+  help: Define a list of environment variables. See `environment_variable` for reference.
+  url: https://bashly.dannyb.co/configuration/command/#environment_variables
+  example: |-
+    environment_variables:
+    - name: config_path
+      help: Location of the config file
+      default: ~/config.ini
+    - name: api_key
+      help: Your API key
+      required: true
+
+command.examples:
+  help: Define one or more example messages. 
+  url: https://bashly.dannyb.co/configuration/command/#examples
+  example: |-
+    # Use an array of examples for simple one-liners.
+    examples:
+    - cli download example.com
+    - cli download example.com ./output -f
+
+    # 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: |-
+      Upload a file
+      $ cli upload profile.png -u admin -p s3cr3t
+
+      Upload a file (you will be prompted to provide a password)
+      $ cli upload profile.png --user admin
+
+command.expose:
+  help: Specify that the sub-commands of this command should be visible when showing the usage of its parent.
+  url: https://bashly.dannyb.co/configuration/command/#expose
+  example: |-
+    name: cli
+    commands:
+    - name: config
+      help: Config management commands
+
+      # Set to 'true' to show both 'config edit' and 'config show' when
+      # running 'cli --help'
+      expose: true
+      commands:
+      - name: edit
+        help: Edit config file
+      - name: show
+        help: Show config file
+
+    - name: server
+      help: Server management commands
+      
+      # Set to 'always' to also show the usage of the sub-commands when
+      # running 'cli' without arguments.
+      expose: always
+
+      commands:
+      - name: start
+        help: Start the server
+      - name: stop
+        help: Stop the server
+
+command.extensible:
+  help: Specify that this command can be extended by external means.
+  url: https://bashly.dannyb.co/configuration/command/#extensible
+  example: |-
+    name: mygit
+    help: Wrapper for git
+    version: 0.1.0
+
+    # Set to 'true' to allow extending it by creating executables in the
+    # path named 'mygit-*'.
+    extensible: true
+
+    # Set to another executable name to delegate all unknown commands
+    # to it.
+    extensible: git
+
+command.filename:
+  help: Specify the path (relative to src) to the partial source code file.
+  url: https://bashly.dannyb.co/configuration/command/#filename
+  example: |-
+    commands:
+    - name: connect
+      help: Connect to server
+      filename: admin_commands/list.sh
+
+command.filters:
+  help: Specify a list of custom filter functions that will prevent the command from running unless certain conditions are met.
+  url: https://bashly.dannyb.co/configuration/command/#filters
+  example: |-
+    commands:
+    - name: container
+      help: Perform actions on a docker container
+
+      # When the command is executed, your script will look for a function
+      # named 'filter_docker_running' and execute it. If it prints a string,
+      # it will be considered an error and the command execution will be
+      # halted.
+      filters:
+      - docker_running
+
+    # Example function (put somewhere in src/lib)
+    filter_docker_running() {
+      docker info >/dev/null 2>&1 || echo "Docker must be running"
+    }
+
+command.flags:
+  help: Define a list of option flags. See `flag` for reference.
+  url: https://bashly.dannyb.co/configuration/command/#flags
+  example: |-
+    flags:
+    - long: --purge
+      short: -p
+      help: Also remove the local directory.
+
+command.footer:
+  help: Specify a message to show at the bottom of the help text.
+  url: https://bashly.dannyb.co/configuration/command/#footer
+  example: |-
+    footer: For further help visit https://my.docs-site.com
+
+command.function:
+  help: Specify a different base function name for this command.
+  url: https://bashly.dannyb.co/configuration/command/#function
+  example: |-
+    commands:
+    - name: container-start
+      help: Start a new container (deprecated)
+
+      # Override the name of the internal functions bashly uses. This is
+      # needed in this case since the command 'container-start' and the
+      # nested command 'container start' will have the same underlying
+      # function name otherwise.
+      function: deprecated_container_start
+      footer: This command is deprecated, use 'container start' instead
+
+    - name: container
+      help: Container commands
+      commands:
+      - name: start
+        help: Start a new container
+
+command.group:
+  help: Specify the group that this command belongs to.
+  url: https://bashly.dannyb.co/configuration/command/#group
+  example: |-
+    command:
+      name: start
+      help: Start the server
+      group: Server
+
+command.help:
+  help: Specify the help text to show when displaying usage.
+  url: https://bashly.dannyb.co/configuration/command/#help
+  example: |-
+    name: docker
+    help: Runtime for containers
+
+    commands:
+    - name: images
+      help: Manage images
+
+command.name:
+  help: Specify the name of the command. This option is required.
+  url: https://bashly.dannyb.co/configuration/command/#name
+  example: |-
+    name: docker
+    help: Runtime for containers
+
+    commands:
+    - name: images
+      help: Manage images
+
+command.private:
+  help: Specify that this command should not be displayed in the help text.
+  url: https://bashly.dannyb.co/configuration/command/#private
+  example: |-
+    commands:
+    - name: completions
+      help: Send bash completions
+      private: true
+
+command.version:
+  help: Specify the version to show when running with `--version`.
+  url: https://bashly.dannyb.co/configuration/command/#version
+  example: |-
+    name: rush
+    help: Personal package manager
+    version: 0.6.5

data/lib/bashly/docs/env.yml

@@ -0,0 +1,54 @@
+environment_variable:
+  help: Define environment variables that will be in use in your script.
+  url: https://bashly.dannyb.co/configuration/environment-variable/
+  example: |-
+    environment_variables:
+    - name: config_path
+      help: Location of the config file
+      default: ~/config.ini
+    - name: api_key
+      help: Your API key
+      required: true
+
+environment_variable.default:
+  help: Specify the value to apply when not provided by the user.
+  url: https://bashly.dannyb.co/configuration/environment-variable/#default
+  example: |-
+    environment_variables:
+    - name: config_path
+      help: Location of the config file
+      default: ~/config.ini
+
+environment_variable.help:
+  help: Specify the help message for this variable.
+  url: https://bashly.dannyb.co/configuration/environment-variable/#help
+  example: |-
+    environment_variables:
+    - name: api_key
+      help: Your API key
+
+environment_variable.name:
+  help: Specify the lowercase name of the variable.
+  url: https://bashly.dannyb.co/configuration/environment-variable/#name
+  example: |-
+    environment_variables:
+    - name: api_key
+      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`.
+  url: https://bashly.dannyb.co/configuration/environment-variable/#private
+  example: |-
+    environment_variables:
+    - name: editor
+      help: Editor to use
+      default: vim
+      private: true
+
+environment_variable.required:
+  help: Specify that this variable is required.
+  url: https://bashly.dannyb.co/configuration/environment-variable/#required
+  example: |-
+    - name: api_key
+      help: Your API key
+      required: true

data/lib/bashly/docs/flag.yml

@@ -0,0 +1,163 @@
+flag:
+  help: Define option flags.
+  url: https://bashly.dannyb.co/configuration/flag/
+  example: |-
+    flags:
+    - long: --ssh
+      short: -s
+      help: Clone using SSH
+
+    - long: --user
+      short: -u
+      arg: name
+      help: Repository user name
+      required: true
+
+flag.allowed:
+  help: Specify a list of allowed values. Can be used in conjunction with `default` and `required`, and must be accompanied by `arg`.
+  url: https://bashly.dannyb.co/configuration/flag/#allowed
+  example: |-
+    flags:
+    - long: --user
+      short: -u
+      arg: name
+      help: User name
+      
+      # allowed + required
+      allowed: [user, admin]
+      required: true
+
+    - long: --protocol
+      short: -p
+      arg: type
+      help: Protocol to connect with
+      
+      # allowed + default
+      allowed: [ftp, ssh, http]
+      default: ssh
+
+flag.arg:
+  help: Specify the name of the argument for this flag, in case it requires any.
+  url: https://bashly.dannyb.co/configuration/flag/#arg
+  example: |-
+    flags:
+    - long: --ssh
+      short: -s
+      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`.
+  url: https://bashly.dannyb.co/configuration/flag/#completions
+  example: |-
+    flags:
+    - long: --user
+      arg: username
+      completions:
+      - <user>
+    
+    # Anything in the 'allowed' option is automatically added as a completion.
+    - long: --protocol
+      arg: protocol
+      allowed:
+      - ssh
+      - telnet
+
+flag.conflicts:
+  help: Specify that this flag is mutually exclusive with one or more other flags. Use the long name of these conflicting flags.
+  url: https://bashly.dannyb.co/configuration/flag/#conflicts
+  example: |-
+    flags:
+    - long: --cache
+      help: Enable cache
+      
+      # Running --cache with --no-cache is not permitted
+      conflicts: [--no-cache]
+    
+    - long: --no-cache
+      help: Disable cache
+      
+      # Running --no-cache with --cache or with --fast is not permitted
+      conflicts: [--cache, --fast]
+    
+    - long: --fast
+      help: Run faster
+      
+      # Make sure to add the conflicting flags on both sides of the conflict
+      conflicts: [--no-cache]
+
+flag.default:
+  help: Specify the value to apply when not provided by the user.
+  url: https://bashly.dannyb.co/configuration/flag/#default
+  example: |-
+    flags:
+    - long: --environment
+      arg: name
+      help: Set environment name
+      default: production
+
+flag.help:
+  help: Specify the help message for this flag.
+  url: https://bashly.dannyb.co/configuration/flag/#help
+  example: |-
+    flags:
+    - long: --cache
+      help: Enable cache
+
+flag.long:
+  help: Specify the long form of the flag, including the -- prefix. Either `long` or `short` is required.
+  url: https://bashly.dannyb.co/configuration/flag/#long
+  example: |-
+    flags:
+    - long: --ssh
+      short: -s
+      help: Clone using SSH
+
+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:
+    `eval "data=(${args[--data]})"`
+
+  url: https://bashly.dannyb.co/configuration/flag/#repeatable
+  example: |-
+    flags:
+    - long: --data
+      short: -d
+      arg: data
+      help: Provide data values
+      required: true
+      repeatable: true
+
+    - long: --verbose
+      short: -v
+      help: Set verbosity level
+      repeatable: true
+
+flag.required:
+  help: Specify that this flag is required.
+  url: https://bashly.dannyb.co/configuration/flag/#required
+  example: |-
+    args:
+    - long: --user
+      arg: name
+      help: Repository user name
+      required: true
+
+flag.short:
+  help: Specify the short form of the flag, including the - prefix. Either `long` or `short` is required.
+  url: https://bashly.dannyb.co/configuration/flag/#short
+  example: |-
+    - long: --user
+      short: -u
+      arg: name
+      help: Repository user name
+
+flag.validate:
+  help: Apply custom validation functions. Must be accompanied by `arg`.
+
+  url: https://bashly.dannyb.co/configuration/flag/#validate
+  example: |-
+   flags:
+   - long: --config
+     arg: path
+     help: Load configuration from a file
+     validate: file_exists

data/lib/bashly/extensions/string.rb

@@ -37,4 +37,12 @@ class String
       "\t" * (::Regexp.last_match(1).size / tabstop)
     end
   end
+
+  def color(marker)
+    color = Bashly::Settings.usage_colors[marker.to_s]
+    return self unless color
+
+    text, spaces = match(/(.*?)(\s*)$/).captures
+    %[$(#{color} "#{text}")#{spaces}]
+  end
 end

data/lib/bashly/settings.rb

@@ -4,7 +4,7 @@ module Bashly
       include AssetHelper
 
       attr_writer :compact_short_flags, :lib_dir, :partials_extension,
-        :source_dir, :strict, :tab_indent, :target_dir
+        :source_dir, :strict, :tab_indent, :target_dir, :usage_colors
 
       def compact_short_flags
         @compact_short_flags ||= get :compact_short_flags
@@ -50,6 +50,10 @@ module Bashly
         @target_dir ||= get :target_dir
       end
 
+      def usage_colors
+        @usage_colors ||= get :usage_colors
+      end
+
     private
 
       def get(key)

data/lib/bashly/templates/settings.yml

@@ -33,3 +33,15 @@ env: development
 
 # The extension to use when reading/writing partial script snippets.
 partials_extension: sh
+
+# Display various usage elements in color by providing the name of the color
+# function. The value for each property is a name of a function that is
+# available in your script, for example: `green` or `bold`.
+# You can run `bashly add colors` to add a standard colors library.
+# This option cannot be set via environment variables.
+usage_colors:
+  caption: ~
+  command: ~
+  arg: ~
+  flag: ~
+  environment_variable: ~

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '0.9.2'
+  VERSION = '0.9.4'
 end

data/lib/bashly/views/argument/usage.gtx

@@ -1,6 +1,6 @@
 = view_marker
 
-> echo "  {{ label }}"
+> printf "  %s\n" "{{ label.color(:arg) }}"
 > printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
 
 if allowed

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

@@ -1,7 +1,7 @@
 = view_marker
 
 > if [[ -n $long_usage ]]; then
->   printf "{{ strings[:options] }}\n"
+>   printf "%s\n" "{{ strings[:options].color(:caption) }}"
 >
 = render(:usage_fixed_flags).indent 2
 = render(:usage_flags).indent 2 if flags.any?

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

@@ -11,8 +11,16 @@ unless global_flags?
 end
 
 >
->     -?*)
+if catch_all.enabled?
+>     --)
+>       shift
+>       other_args+=("$@")
+>       break
+>       ;;
+>
+end
 
+>     -?*)
 if catch_all.enabled?
   >       other_args+=("$1")
   >       shift

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

@@ -25,7 +25,7 @@ if alt&.any?
 end
 
 >
->   printf "{{ strings[:usage] }}\n"
+>   printf "%s\n" "{{ strings[:usage].color(:caption) }}"
 >   printf "  {{ usage_string }}\n"
 
 if commands.any?

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

@@ -1,6 +1,6 @@
 = view_marker
 
-> printf "{{ strings[:arguments] }}\n"
+> printf "%s\n" "{{ strings[:arguments].color(:caption) }}"
 
 if args.any?
   >

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

@@ -3,13 +3,13 @@
 maxlen = command_help_data.values.map(&:keys).flatten.map(&:size).max
 
 command_help_data.each do |group, commands|
-  > printf "{{ group }}\n"
+  > printf "%s\n" "{{ group.color(:caption) }}"
 
   commands.each do |command, info|
     if info[:help_only]
-      > [[ -n $long_usage ]] && echo "  {{ command.ljust maxlen }}   {{ info[:summary] }}"
+      > [[ -n $long_usage ]] && printf "  %s   {{ info[:summary] }}\n" "{{ command.ljust(maxlen).color(:command) }}"
     else
-      > echo "  {{ command.ljust maxlen }}   {{ info[:summary] }}"
+      > printf "  %s   {{ info[:summary] }}\n" "{{ command.ljust(maxlen).color(:command) }}"
     end
   end
 

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

@@ -1,6 +1,6 @@
 = view_marker
 
-> printf "{{ strings[:environment_variables] }}\n"
+> printf "%s\n" "{{ strings[:environment_variables].color(:caption) }}"
 > 
 
 environment_variables.reject(&:private).each do |env_var|

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

@@ -1,6 +1,6 @@
 = view_marker
 
-> printf "{{ strings[:examples] }}\n"
+> printf "%s\n" "{{ strings[:examples].color(:caption) }}"
 
 examples.each do |example|
   > printf "{{ example.wrap(78).indent(2).sanitize_for_print }}\n"

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

@@ -1,11 +1,20 @@
 = view_marker
 
-= short_flag_exist?("-h") ? 'echo "  --help"' : 'echo "  --help, -h"'
+if short_flag_exist?("-h")
+  > printf "  %s\n" "{{ '--help'.color(:flag) }}"
+else
+  > printf "  %s\n" "{{ '--help, -h'.color(:flag) }}"
+end
+
 > printf "    {{ strings[:help_flag_text] }}\n"
 > echo
 
 if root_command?
-  = short_flag_exist?("-v") ? 'echo "  --version"' : 'echo "  --version, -v"'
+  if short_flag_exist?("-v")
+    > printf "  %s\n" "{{ '--version'.color(:flag) }}"
+  else
+    > printf "  %s\n" "{{ '--version, -v'.color(:flag) }}"
+  end
   > printf "    {{ strings[:version_flag_text] }}\n"
   > echo
 end

data/lib/bashly/views/environment_variable/usage.gtx

@@ -1,6 +1,6 @@
 = view_marker
 
-> echo "  {{ usage_string extended: true }}"
+> printf "  %s\n" "{{ usage_string(extended: true).color(:environment_variable) }}"
 > printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
 
 if default

data/lib/bashly/views/flag/usage.gtx

@@ -1,6 +1,6 @@
 = view_marker
 
-> echo "  {{ usage_string extended: true }}"
+> printf "  %s\n" "{{ usage_string(extended: true).color(:flag) }}"
 > printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
 
 if allowed

data/lib/bashly.rb

@@ -6,7 +6,6 @@ if ENV['BYEBUG']
 end
 
 requires 'bashly/concerns'
-
 requires 'bashly/extensions'
 requires 'bashly/settings'
 requires 'bashly/exceptions'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2022-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: completely
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
 description: Generate bash command line tools using YAML configuration
 email: db@dannyben.com
 executables:
@@ -121,6 +121,7 @@ files:
 - lib/bashly/cli.rb
 - lib/bashly/commands/add.rb
 - lib/bashly/commands/base.rb
+- lib/bashly/commands/doc.rb
 - lib/bashly/commands/generate.rb
 - lib/bashly/commands/init.rb
 - lib/bashly/commands/preview.rb
@@ -132,6 +133,10 @@ files:
 - 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
+- lib/bashly/docs/flag.yml
 - lib/bashly/exceptions.rb
 - lib/bashly/extensions/array.rb
 - lib/bashly/extensions/file.rb
@@ -247,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.0
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator