bashly 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fe733a46c8634cc39b4c792b177ca9ac7610a8d408714fa482b3c0ad15fc10f
-  data.tar.gz: 908960de1cb2d682ff801630e0f6667a42df171612ed6a92aee72bcc369cc0e2
+  metadata.gz: 3a6c888335f32b6223149d91ed739e189ffbc6921afec05ff709380c76387338
+  data.tar.gz: b964b4ac7a5fa86f8766b350a3240ee00882be5cfc574e97f001a832a506e342
 SHA512:
-  metadata.gz: 9e0dcf39faf63d5d798fac7ed41768994ec6715a58b898e390ec2a6019948497d314c08bc8ce1041fb5f1a105884a04d759e258085fdcf7fbbe87af1c4a7a4e0
-  data.tar.gz: 83279b0a7df6eb6f3c2a779bbc54221e9cad58e6e08c4a207f1d592aa12329cc488d7169b682191be02474f098dbfda0f3d6ad6cd03e3a91e1bf793bb29fcdc3
+  metadata.gz: e1e2757a735e55ffc4d4b27633d6df020184521ed8eb6377c0f26f8edd7442d28fb2a3c56c056de4558aab2204f7d522e15df6374f1962fcbaf26226f590d22b
+  data.tar.gz: a8aa77fba152f005136ff8ee8aacdc7236f15975042c4066f6d94e7e400133e2ca4137ffbbe9bc6f458c2aae2784aa956721d9179862cd78bf95ec6f99f39bd3

data/README.md

@@ -349,50 +349,29 @@ functionality to your script in one of three ways:
 
 The bash completions generation is completely automatic, and you will have to 
 rerun the `bashly add comp *` command whenever you change your `bashly.yml` 
-script.
+file.
 
 In addition to suggesting subcommands and flags, you can instruct bashly to
-also suggest files, directories, users and more. To do this, add another option
-in your `bashly.yml` on the command you wish to alter:
+also suggest files, directories, users, git branches and more. To do this,
+add another option in your `bashly.yml` on the command you wish to alter:
 
 ```yaml
 # bashly.yml
 commands:
 - name: upload
   help: Upload a file
-  completions: [directory, user]
+  completions:
+  - <directory>
+  - <user>
+  - $(git branch 2> /dev/null)
 
 ```
 
-Valid completion additions are:
-
-| Keyword     | Meaning
-|-------------|---------------------
-| `alias`     | Alias names
-| `arrayvar`  | Array variable names
-| `binding`   | Readline key binding names
-| `builtin`   | Names of shell builtin commands
-| `command`   | Command names
-| `directory` | Directory names
-| `disabled`  | Names of disabled shell builtins
-| `enabled`   | Names of enabled shell builtins
-| `export`    | Names of exported shell variables
-| `file`      | File names
-| `function`  | Names of shell functions
-| `group`     | Group names
-| `helptopic` | Help topics as accepted by the help builtin
-| `hostname`  | Hostnames, as taken from the file specified by the HOSTFILE shell variable
-| `job`       | Job names
-| `keyword`   | Shell reserved words
-| `running`   | Names of running jobs
-| `service`   | Service names
-| `signal`    | Signal names
-| `stopped`   | Names of stopped jobs
-| `user`      | User names
-| `variable`  | Names of all shell variables
-
-Note that these are taken from the [Programmable Completion Builtin][compgen], 
-and will simply be added using the `compgen -A action` command.
+- Anything between `<...>` will be added using the `compgen -A action` flag.
+- Anything else, will be appended to the `compgen -W` flag.
+
+For more information about these custom completions, see the documentation for
+the [completely][completely] gem.
 
 
 ## Real World Examples

data/lib/bashly/concerns/completions.rb

@@ -31,18 +31,15 @@ module Bashly
       flags.map(&:name) + flags.map(&:short)
     end
 
-    def completion_actions
-      completions ? completions.map { |c| "<#{c}>" } : []
-    end
-
     def completion_words(with_version: false)
       trivial_flags = %w[--help -h]
       trivial_flags += %w[--version -v] if with_version
       all = (
         command_names + trivial_flags +
-        completion_flag_names + completion_actions
+        completion_flag_names
       )
 
+      all += completions if completions
       all.compact.uniq.sort
     end
 

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Danny Ben Shitrit