completely 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8b8cc9f26134e125f8d8ec1d24081bdd3c22217e916c9233b00b471381fadc6
-  data.tar.gz: a161403557ba173302233a3f4c3a4b61b084157f648709b1c79627f48aac9c97
+  metadata.gz: 54ee6b84395ab00c6d0fdde61065b9843b178947a7569cea41cead7b149ef55b
+  data.tar.gz: 3dd72641e530c42b0642b5861f1b38c219b5931846ed2da7fb20648563954094
 SHA512:
-  metadata.gz: 22d3aa7b9db836ed7977d8888f46412184ea05d8de95632476275b6a33905308556d240014e816a01c47d9d56a35dd3181aec02eec149996587803db3fc47699
-  data.tar.gz: a0796eedf218a01c54ba31cdb63a7a9db747ec83eb5f37726fcd67e9b201291b3f6856b28a0323310bbaf613dec3f710a2d667b6ee02751d38d391e20c079287
+  metadata.gz: b8f2ffa6f7f8303e827c8bb894accf1d97ae0e012f46d495dcfab280836ffd5ae8aa0418b95450a41642bb1fcabb9b2ee2d54ef037f88e43f048a6014ae4acff
+  data.tar.gz: 94f01f524b7ffc8bf5ca910594e203f1579bccc0910795ca2a74cf64af5838dab1b023a250f017da9c0c2798c68ac71149657c14a3f587a32a30268843fdd815

data/README.md

@@ -32,15 +32,18 @@ $ gem install completely
 The `completely` command line works with a simple YAML configuration file as
 input, and generates a bash completions script as output.
 
-The configuration file is built like this:
+The configuration file is built of blocks that look like this:
 
 ```yaml
 pattern:
-  - --argument
-  - --param
-  - command
+- --argument
+- --param
+- command
 ```
 
+Each pattern contains an array of words (or functions) that will be suggested
+for the auto complete process.
+
 You can save a sample YAML file by running:
 
 ```
@@ -61,6 +64,7 @@ mygit status:
 - --help
 - --verbose
 - --branch
+- $(git branch 2> /dev/null)
 
 mygit init:
 - --bare
@@ -97,19 +101,23 @@ $ completely --help
 
 ### Suggesting files, directories and other bash built-ins
 
-You may have noticed that the sample file contains two special entries:
+In addition to specifying a simple array of completion words, you may use
+the special syntax `<..>` to suggest more advanced functions.
 
-- `<file>`
-- `<directory>`
+```yaml
+pattern:
+- <file>
+- <directory>
+```
 
-These patterns will add the list of files and directories
+These suggestions will add the list of files and directories
 (when `<file>` is used) or just directories (when `<directory>` is used) to
 the list of suggestions.
 
-You may add any of the below keywords to add additional suggestions:
+You may use any of the below keywords to add additional suggestions:
 
-| Keyword     | Meaning
-|-------------|---------------------
+| Keyword       | Meaning
+|---------------|---------------------
 | `<alias>`     | Alias names
 | `<arrayvar>`  | Array variable names
 | `<binding>`   | Readline key binding names
@@ -137,6 +145,20 @@ For those interested in the technical details, any word between `<...>` will
 simply be added using the [`compgen -A action`][compgen] function, so you can 
 in fact use any of its supported arguments.
 
+### Suggesting custom dynamic suggestions
+
+You can also use any command that outputs a whitespace-delimited list as a
+suggestions list, by wrapping it in `$(..)`. For example, in order to add git
+branches to your suggestions, use the following:
+
+```yaml
+mygit:
+- $(git branch 2> /dev/null)
+```
+
+The `2> /dev/null` is used so that if the command is executed in a directory
+without a git repository, it will still behave as expected.
+
 
 ## Using the generated completion scripts
 
@@ -182,4 +204,4 @@ to contribute, feel free to [open an issue][issues].
 
 [issues]: https://github.com/DannyBen/completely/issues
 [compgen]: https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion-Builtins.html
-[bashly]: https://github.com/DannyBen/bashly
+[bashly]: https://bashly.dannyb.co/

data/lib/completely/command.rb

@@ -37,6 +37,7 @@ module Completely
 
     def preview_command
       puts script
+      syntax_warning unless completions.valid?
     end
     
     def generate_command
@@ -44,6 +45,7 @@ module Completely
       output = wrap ? wrapper_function(wrap) : script
       File.write output_path, output
       say "Saved !txtpur!#{output_path}"
+      syntax_warning unless completions.valid?
     end
 
   private
@@ -76,5 +78,10 @@ module Completely
       @completions ||= Completions.load(config_path, function_name: args['--function'])
     end
 
+    def syntax_warning
+      say! "\n!txtred!WARNING:\nYour configuration is invalid."
+      say! "!txtred!All patterns must start with the same word."
+    end
+
   end
 end

data/lib/completely/completions.rb

@@ -19,6 +19,10 @@ module Completely
       @patterns ||= patterns!
     end
 
+    def valid?
+      pattern_prefixes.uniq.count == 1
+    end
+
     def script
       ERB.new(template, trim_mode: '%-').result(binding)
     end
@@ -58,5 +62,9 @@ module Completely
       @function_name ||= "_#{command}_completions"
     end
 
+    def pattern_prefixes
+      patterns.map &:prefix
+    end
+
   end
 end

data/lib/completely/pattern.rb

@@ -26,8 +26,16 @@ module Completely
       end
     end
 
+    def prefix
+      text.split(' ')[0]
+    end
+
+    def text_without_prefix
+      text.split(' ')[1..-1].join ' '
+    end
+
     def compgen
-      @comgen ||= compgen!
+      @compgen ||= compgen!
     end
 
   private

data/lib/completely/sample.yaml

@@ -9,6 +9,7 @@ mygit status:
 - --help
 - --verbose
 - --branch
+- $(git branch 2> /dev/null)
 
 mygit init:
 - --bare

data/lib/completely/template.erb

@@ -5,11 +5,12 @@
 # Modifying it manually is not recommended
 <%= function_name %>() {
   local cur=${COMP_WORDS[COMP_CWORD]}
+  local comp_line="${COMP_WORDS[*]:1}"
 
-  case "$COMP_LINE" in
+  case "$comp_line" in
 % patterns.each do |pattern|
 % next if pattern.empty?
-    '<%= pattern.text %>'*) COMPREPLY=($(compgen <%= pattern.compgen %> -- "$cur")) ;;
+    '<%= pattern.text_without_prefix %>'*) COMPREPLY=($(compgen <%= pattern.compgen %> -- "$cur")) ;;
 % end
   esac
 }

data/lib/completely/version.rb

@@ -1,3 +1,3 @@
 module Completely
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: Bash Completions Generator