complete flag completion implementation

Author: DannyBen

lib/bashly/views/command/completion_flag_candidates.gtx

@@ -1,9 +1,17 @@
 if fixed_flags? || public_flags.any?
   > if [[ $completion_current == -* ]]; then
   if fixed_flags?
-    >   completion_flag_candidates --help "$completion_current" --help -h
+    if short_flag_exist? '-h'
+      >   completion_flag_candidates --help "$completion_current" --help
+    else
+      >   completion_flag_candidates --help "$completion_current" --help -h
+    end
     if root_command?
-      >   completion_flag_candidates --version "$completion_current" --version -v
+      if short_flag_exist? '-v'
+        >   completion_flag_candidates --version "$completion_current" --version
+      else
+        >   completion_flag_candidates --version "$completion_current" --version -v
+      end
     end
   end
   public_flags.each do |flag|

lib/bashly/views/command/completion_function.gtx

@@ -8,6 +8,9 @@ end
 if args.any?(&:unique)
   >   local -A completion_used_arguments=()
 end
+if flags.any?(&:unique)
+  >   local -A completion_used_flag_values=()
+end
 >   shift
 >
 = render(:completion_word_filter).indent 2

lib/bashly/views/command/completion_word_filter.gtx

@@ -8,12 +8,20 @@ public_commands.each do |command|
   >       ;;
 end
 if fixed_flags?
-  >     --help | -h)
+  if short_flag_exist? '-h'
+    >     --help)
+  else
+    >     --help | -h)
+  end
   >       completion_blocked_flags["--help"]=1
   >       shift
   >       ;;
   if root_command?
-    >     --version | -v)
+    if short_flag_exist? '-v'
+      >     --version)
+    else
+      >     --version | -v)
+    end
     >       completion_blocked_flags["--version"]=1
     >       shift
     >       ;;

lib/bashly/views/flag/completion_filter_arg.gtx

@@ -3,5 +3,8 @@
 = render(:completion_value_candidates).indent 2
 >   return
 > fi
+if unique
+  > completion_used_flag_values["{{ name }}:$1"]=1
+end
 > shift
 = render :completion_filter_block

lib/bashly/views/flag/completion_value_candidates.gtx

@@ -4,5 +4,14 @@ if allowed
     >   "{{ value }}"
   end
   > )
-  > completion_candidates "$completion_current" "${completion_values[@]}"
+  if unique
+    > local completion_value
+    > for completion_value in "${completion_values[@]}"; do
+    >   if [[ -z "${completion_used_flag_values["{{ name }}:$completion_value"]:-}" ]]; then
+    >     completion_candidates "$completion_current" "$completion_value"
+    >   fi
+    > done
+  else
+    > completion_candidates "$completion_current" "${completion_values[@]}"
+  end
 end

spec/fixtures/completions/core/examples.yml

@@ -128,6 +128,18 @@ unique positional argument prefix:
   words: [release, stable, e]
   expected: [edge]
 
+unique flag value:
+  words: [release, --label, blue, --label, '']
+  expected: [green, canary]
+
+unique flag value prefix:
+  words: [release, --label, blue, --label, c]
+  expected: [canary]
+
+unique repeatable flag remains:
+  words: [release, --label, blue, '--']
+  expected: [--help, --label]
+
 private command is not reachable:
   words: [internal, '']
   expected: []

spec/fixtures/completions/core/src/bashly.yml

@@ -33,6 +33,9 @@ commands:
       short: -c
       negatable: true
       help: Enable color output
+    - long: --secret
+      help: Internal flag that must not be suggested
+      private: true
   - name: stop
     alias: down
     help: Stop a server
@@ -79,6 +82,14 @@ commands:
 
 - name: release
   help: Release to channels
+  flags:
+  - long: --label
+    short: -l
+    arg: label
+    allowed: [blue, green, canary]
+    help: Labels to apply
+    repeatable: true
+    unique: true
   args:
   - name: channel
     allowed: [stable, beta, edge]

spec/fixtures/completions/global-flags/examples.yml

@@ -0,0 +1,27 @@
+global flag names:
+  words: ['--']
+  expected: [--help, --version, --profile, --verbose, --host]
+
+global short flag names:
+  words: ['-']
+  expected: [--help, --version, --profile, -p, --verbose, -v, --host, -h]
+
+global flag allowed values:
+  words: [--profile, pro]
+  expected: [production]
+
+command after global flag:
+  words: [--profile, production, '']
+  expected: [deploy]
+
+local flags after global flag and command:
+  words: [--profile, production, deploy, '--']
+  expected: [--help, --force]
+
+custom version short flag remains repeatable:
+  words: [-v, '--']
+  expected: [--help, --version, --profile, --verbose, --host]
+
+custom help short flag accepts its value:
+  words: [-h, us]
+  expected: [user]

spec/fixtures/completions/global-flags/src/bashly.yml

@@ -0,0 +1,27 @@
+name: cli
+help: Global flag completion fixture
+version: 0.1.0
+
+flags:
+- long: --profile
+  short: -p
+  arg: profile
+  allowed: [development, production]
+  help: Select a profile
+- long: --verbose
+  short: -v
+  repeatable: true
+  help: Increase verbosity
+- long: --host
+  short: -h
+  arg: host
+  allowed: [user, admin]
+  help: Select a host
+
+commands:
+- name: deploy
+  help: Deploy the application
+  flags:
+  - long: --force
+    short: -f
+    help: Force the deployment