bashly 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c219a4bf3f32f47434d1a855a620ea62caaafe336a8647e8ef84529eb7023b8
-  data.tar.gz: d18b7f6bdfeb43fc4a27fb9e5f617d1c0c9c6f5783f5c7dc1df8f6eff575c8ab
+  metadata.gz: 58a2804698490f003611b4f607614fef9995bea16f426c6d56d527d78b770a29
+  data.tar.gz: 24a4c1d97b45332e424fc6932092225bab7b3ade618f5eec5e9c187ca91389ac
 SHA512:
-  metadata.gz: 38cf3b1d1c49c447f0e2817b57cb03362e528cefe22dc0f4d9c1dcfcb7b52859c034bc012bfb7ec769b6c94801c102bfe74d9c336e0dbc8ee060027c10b1b242
-  data.tar.gz: e64ced05cc15cd4cb66cc2dc6696cb522db87843c9fc8826d69500cfb1aafb8aa3ad13ccf36bca806ce262cece7c30763229d82f297bbf471ee71ca5807eaaec
+  metadata.gz: 0e62c14ede0d0295e01411cd946859a21413e50b43313f850ea494c4ed5dafe6f402b914dfc8f682c3abc8e38d9004917dbd654d78f8983b961f2f35228e97e4
+  data.tar.gz: '00309d231db02bb61fe7d9ae2c95d9d615888830a6a95c2815cda9e8b08fa4dd73e6ccc0f0127bf46a467deee4888297975f421a2a1e0c80fa5b23d871124726'

data/lib/bashly/cli.rb

@@ -9,13 +9,14 @@ module Bashly
         header: 'Bashly - Bash CLI Generator',
         footer: "Help: m`bashly COMMAND --help`\nDocs: bu`https://bashly.dannyb.co`"
 
-      runner.route 'init',      to: Commands::Init
-      runner.route 'preview',   to: Commands::Preview
-      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.route 'shell',     to: Commands::Shell unless ENV['BASHLY_SHELL']
+      runner.route 'init',        to: Commands::Init
+      runner.route 'preview',     to: Commands::Preview
+      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.route 'completions', to: Commands::Completions
+      runner.route 'shell',       to: Commands::Shell unless ENV['BASHLY_SHELL']
 
       runner
     end

data/lib/bashly/commands/completions.rb

@@ -0,0 +1,56 @@
+module Bashly
+  module Commands
+    class Completions < Base
+      summary 'Install bash completions for bashly itself'
+      help 'Display the bash completions script or install it directly to your bash completions directory'
+
+      usage 'bashly completions [--install --uninstall]'
+      usage 'bashly completions (-h|--help)'
+
+      option '-i --install', 'Install the completions script to your bash completions directory'
+      option '-u --uninstall', 'Uninstall the completions script from your bash completions directory'
+
+      def run
+        if args['--install']
+          install_completions
+        elsif args['--uninstall']
+          uninstall_completions
+        else
+          puts script
+        end
+      end
+
+      def installer
+        @installer ||= Completely::Installer.new program: 'bashly', script_path: script_path
+      end
+
+    private
+
+      def install_completions
+        success = installer.install force: true
+        raise Error, "Failed running command:\nnb`#{installer.install_command_string}`" unless success
+
+        say 'Completions installed'
+        say "Source: m`#{installer.script_path}`"
+        say "Target: m`#{installer.target_path}`"
+        say 'Restart your session for the changes to take effect'
+      end
+
+      def uninstall_completions
+        success = installer.uninstall
+        raise Error, "Failed running command:\nnb`#{installer.uninstall_command_string}`" unless success
+
+        say 'Completions uninstalled'
+        say 'Restart your session for the changes to take effect'
+      end
+
+      def script_path
+        @script_path ||= asset('completions/bashly-completions.bash')
+      end
+
+      def script
+        @script ||= asset_content('completions/bashly-completions.bash')
+      end
+    end
+  end
+end

data/lib/bashly/commands/generate.rb

@@ -42,10 +42,8 @@ module Bashly
         Filewatcher.new([Settings.source_dir]).watch do
           reset
           generate
-
         rescue Bashly::ConfigurationError => e
           say! "rib` #{e.class} `\n#{e.message}"
-
         ensure
           quiet_say "g`waiting`\n"
         end

data/lib/bashly/commands/shell.rb

@@ -19,7 +19,7 @@ module Bashly
           terminal = MisterBin::Terminal.new runner, {
             autocomplete: autocomplete,
             show_usage:   true,
-            prompt:       "\n\e[33m\e[1mbashly\e[0m > ",
+            prompt:       "\n$> bashly ",
           }
 
           terminal.on('help') { runner.run %w[--help] }

data/lib/bashly/completions/README.md

@@ -0,0 +1,24 @@
+# Completions for bashly executable
+
+This directory contains templates for generating bash completions.
+
+## For developers
+
+From the root directory of the repository, run `run completions`. This will:
+
+1. Read the `completely.yaml.gtx` template
+2. Write the `completely.yaml` file (to allow testing with completely)
+3. Generate the `bashly-completions.bash` file
+4. Copy it to the completions directory with `sudo`
+
+Note that for production use, only the `bashly-completions.bash` is used.
+
+## For users
+
+Install completions in one of two ways:
+
+1. Run `bashly completions --install`. This will make a best effort to copy
+   the completions script to your completions directory.
+2. If the above fails, run `bashly completions > out.bash`, then copy the file
+   manually to your completions directory (or simply get the
+   `bashly-completions.bash` from this directory).

data/lib/bashly/completions/bashly-completions.bash

@@ -0,0 +1,115 @@
+# bashly completion                                        -*- shell-script -*-
+
+# This bash completions script was generated by
+# completely (https://github.com/dannyben/completely)
+# Modifying it manually is not recommended
+
+_bashly_completions_filter() {
+  local words="$1"
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local result=()
+
+  if [[ "${cur:0:1}" == "-" ]]; then
+    echo "$words"
+  
+  else
+    for word in $words; do
+      [[ "${word:0:1}" != "-" ]] && result+=("$word")
+    done
+
+    echo "${result[*]}"
+
+  fi
+}
+
+_bashly_completions() {
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local compwords=("${COMP_WORDS[@]:1:$COMP_CWORD-1}")
+  local compline="${compwords[*]}"
+
+  case "$compline" in
+    'generate'*'--env')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "development production")" -- "$cur" )
+      ;;
+
+    'generate'*'-e')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "development production")" -- "$cur" )
+      ;;
+
+    'completions'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --install -i")" -- "$cur" )
+      ;;
+
+    'validate'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --verbose -v")" -- "$cur" )
+      ;;
+
+    'generate'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --env --force --quiet --upgrade --watch --wrap -e -f -q -r -u -w")" -- "$cur" )
+      ;;
+
+    'preview'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h")" -- "$cur" )
+      ;;
+
+    'g'*'--env')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "development production")" -- "$cur" )
+      ;;
+
+    'shell'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h")" -- "$cur" )
+      ;;
+
+    'init'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --minimal -m")" -- "$cur" )
+      ;;
+
+    'g'*'-e')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "development production")" -- "$cur" )
+      ;;
+
+    'add'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --force --list --source -f -l -s colors completions completions_script completions_yaml config help hooks lib settings strings test validations yaml")" -- "$cur" )
+      ;;
+
+    'doc'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --index -i arg arg.allowed arg.default arg.help arg.name arg.repeatable arg.required arg.validate command command.alias command.args command.catch_all command.commands command.completions command.default command.dependencies command.environment_variables command.examples command.expose command.extensible command.filename command.filters command.flags command.footer command.function command.group command.help command.name command.private command.version environment_variable environment_variable.default environment_variable.help environment_variable.name environment_variable.private environment_variable.required flag flag.allowed flag.arg flag.completions flag.conflicts flag.default flag.help flag.long flag.private flag.repeatable flag.required flag.short flag.validate")" -- "$cur" )
+      ;;
+
+    'i'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --minimal -m")" -- "$cur" )
+      ;;
+
+    'p'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h")" -- "$cur" )
+      ;;
+
+    'v'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --verbose -v")" -- "$cur" )
+      ;;
+
+    'g'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --env --force --quiet --upgrade --watch --wrap -e -f -q -r -u -w")" -- "$cur" )
+      ;;
+
+    'a'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --force --list --source -f -l -s colors completions completions_script completions_yaml config help hooks lib settings strings test validations yaml")" -- "$cur" )
+      ;;
+
+    'c'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --install -i")" -- "$cur" )
+      ;;
+
+    's'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h")" -- "$cur" )
+      ;;
+
+    *)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_bashly_completions_filter "--help -h --version -v init preview validate generate add doc completions shell")" -- "$cur" )
+      ;;
+
+  esac
+} &&
+complete -F _bashly_completions bashly
+
+# ex: filetype=sh

data/lib/bashly/completions/completely.yaml

@@ -0,0 +1,155 @@
+bashly:
+- --help
+- -h
+- --version
+- -v
+- init
+- preview
+- validate
+- generate
+- add
+- doc
+- completions
+- shell
+
+bashly init: &init
+- --help
+- -h
+- --minimal
+- -m
+
+bashly i: *init
+
+bashly preview: &preview
+- --help
+- -h
+
+bashly p: *preview
+
+bashly validate: &validate
+- --help
+- -h
+- --verbose
+- -v
+
+bashly v: *validate
+
+bashly generate: &generate
+- --help
+- -h
+- --env
+- --force
+- --quiet
+- --upgrade
+- --watch
+- --wrap
+- -e
+- -f
+- -q
+- -r
+- -u
+- -w
+
+bashly g: *generate
+
+bashly generate*--env: &env
+- development
+- production
+
+bashly generate*-e: *env
+bashly g*--env: *env
+bashly g*-e: *env
+
+bashly add: &add
+- --help
+- -h
+- --force
+- --list
+- --source
+- -f
+- -l
+- -s
+- colors
+- completions
+- completions_script
+- completions_yaml
+- config
+- help
+- hooks
+- lib
+- settings
+- strings
+- test
+- validations
+- yaml
+
+bashly a: *add
+
+bashly doc: &doc
+- --help
+- -h
+- --index
+- -i
+- arg
+- arg.allowed
+- arg.default
+- arg.help
+- arg.name
+- arg.repeatable
+- arg.required
+- arg.validate
+- command
+- command.alias
+- command.args
+- command.catch_all
+- command.commands
+- command.completions
+- command.default
+- command.dependencies
+- command.environment_variables
+- command.examples
+- command.expose
+- command.extensible
+- command.filename
+- command.filters
+- command.flags
+- command.footer
+- command.function
+- command.group
+- command.help
+- command.name
+- command.private
+- command.version
+- environment_variable
+- environment_variable.default
+- environment_variable.help
+- environment_variable.name
+- environment_variable.private
+- environment_variable.required
+- flag
+- flag.allowed
+- flag.arg
+- flag.completions
+- flag.conflicts
+- flag.default
+- flag.help
+- flag.long
+- flag.private
+- flag.repeatable
+- flag.required
+- flag.short
+- flag.validate
+
+bashly completions: &completions
+- --help
+- -h
+- --install
+- -i
+
+bashly c: *completions
+
+bashly shell: &shell
+- --help
+- -h
+
+bashly s: *shell

data/lib/bashly/completions/completely.yaml.gtx

@@ -0,0 +1,85 @@
+> bashly:
+= help_flags
+> - --version
+> - -v
+commands.each do |command|
+  = "- #{command}"
+end
+> 
+> bashly init: &init
+= help_flags
+> - --minimal
+> - -m
+> 
+> bashly i: *init
+> 
+> bashly preview: &preview
+= help_flags
+> 
+> bashly p: *preview
+> 
+> bashly validate: &validate
+= help_flags
+> - --verbose
+> - -v
+> 
+> bashly v: *validate
+> 
+> bashly generate: &generate
+= help_flags
+> - --env
+> - --force
+> - --quiet
+> - --upgrade
+> - --watch
+> - --wrap
+> - -e
+> - -f
+> - -q
+> - -r
+> - -u
+> - -w
+> 
+> bashly g: *generate
+> 
+> bashly generate*--env: &env
+> - development
+> - production
+> 
+> bashly generate*-e: *env
+> bashly g*--env: *env
+> bashly g*-e: *env
+> 
+> bashly add: &add
+= help_flags
+> - --force
+> - --list
+> - --source
+> - -f
+> - -l
+> - -s
+libs.each do |lib|
+  = "- #{lib}"
+end
+> 
+> bashly a: *add
+> 
+> bashly doc: &doc
+= help_flags
+> - --index
+> - -i
+docs.each do |doc|
+  = "- #{doc}"
+end
+>
+> bashly completions: &completions
+= help_flags
+> - --install
+> - -i
+> 
+> bashly c: *completions
+>
+> bashly shell: &shell
+= help_flags
+> 
+> bashly s: *shell

data/lib/bashly/script/command.rb

@@ -240,7 +240,7 @@ module Bashly
 
       # Returns true if one of the args is repeatable
       def repeatable_arg_exist?
-        args.select(&:repeatable).any?
+        args.any?(&:repeatable)
       end
 
       # Returns an array of all the required Arguments
@@ -265,7 +265,7 @@ module Bashly
 
       # Returns true if one of the flags matches the provided short code
       def short_flag_exist?(flag)
-        flags.select { |f| f.short == flag }.any?
+        flags.any? { |f| f.short == flag }
       end
 
       # Returns the summary string

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-02 00:00:00.000000000 Z
+date: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: filewatcher
   requirement: !ruby/object:Gem::Requirement
@@ -127,12 +127,17 @@ files:
 - lib/bashly/cli.rb
 - lib/bashly/commands/add.rb
 - lib/bashly/commands/base.rb
+- lib/bashly/commands/completions.rb
 - lib/bashly/commands/doc.rb
 - lib/bashly/commands/generate.rb
 - lib/bashly/commands/init.rb
 - lib/bashly/commands/preview.rb
 - lib/bashly/commands/shell.rb
 - lib/bashly/commands/validate.rb
+- lib/bashly/completions/README.md
+- lib/bashly/completions/bashly-completions.bash
+- lib/bashly/completions/completely.yaml
+- lib/bashly/completions/completely.yaml.gtx
 - lib/bashly/concerns/asset_helper.rb
 - lib/bashly/concerns/completions.rb
 - lib/bashly/concerns/renderable.rb
@@ -263,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.14
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator