Merge pull request #134 from DannyBen/add/whitelist-to-completions

Automatically add allowed arguments to completions

Author: DannyBen

lib/bashly/concerns/completions.rb

@@ -31,12 +31,16 @@ def completion_flag_names
       flags.map(&:name) + flags.map(&:short)
     end
 
+    def completion_allowed_args
+      flags.map(&:allowed).flatten + args.map(&:allowed).flatten
+    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_flag_names + completion_allowed_args
       )
 
       all += completions if completions

spec/approvals/completions/whitelist

@@ -0,0 +1,17 @@
+---
+download:
+- "--help"
+- "--method"
+- "--role"
+- "--version"
+- "-h"
+- "-v"
+- '22'
+- '3000'
+- '80'
+- admin
+- get
+- https
+- post
+- ssh
+- user

spec/bashly/concerns/completions_spec.rb

@@ -38,4 +38,15 @@
       end
     end
   end
+
+  context "with a command that uses whitelist args" do
+    let(:fixture) { :completions_whitelist }
+
+    describe '#completion_data' do
+      it "returns a data structure that includes thw whitelist" do
+        expect(subject.completion_data.to_yaml)
+          .to match_approval("completions/whitelist")
+      end
+    end
+  end
 end

spec/fixtures/models/commands.yml

@@ -161,5 +161,20 @@
       - long: --verbose
         short: -v
 
+:completions_whitelist:
+  name: download
+  args:
+  - name: protocol
+    allowed: [https, ssh]
+  - name: port
+    allowed: ["80", "22", "3000"]
+  flags:
+  - long: --role
+    arg: name
+    allowed: [user, admin]
+  - long: --method
+    arg: name
+    allowed: [get, post]
+
 :custom_header:
   name: check