Feature dynamic autocomplete for target orgs

src/autocomplete/bash-spaces.ts

@@ -14,6 +14,27 @@ _<CLI_BIN>_autocomplete()
 <BASH_COMMANDS_WITH_FLAGS_LIST>
 "
 
+local targetOrgFlags=("--target-org" "-o")
+
+function _isTargetOrgFlag(){
+  local value="$1"
+  for flag in "\${targetOrgFlags[@]}"; do
+    if [[ "$flag" == "$value" ]]; then
+      return 0 # value found
+    fi
+  done
+  return 1 # value not found
+}
+
+function _suggestOrgs(){
+  local orgs="$(sf autocomplete --display-orgs bash 2>/dev/null)"
+
+  if [[ "$cur" != "-"* ]]; then
+    opts=$(printf "%s " "\${orgs[@]}" | grep -i "\${cur}")
+    COMPREPLY=($(compgen -W "$opts"))
+  fi
+}
+
   function __trim_colon_commands()
   {
     # Turn $commands into an array
@@ -38,26 +59,31 @@ _<CLI_BIN>_autocomplete()
   }
 
   if [[ "$cur" != "-"* ]]; then
-    # Command
-    __COMP_WORDS=( "\${COMP_WORDS[@]:1}" )
+    if _isTargetOrgFlag "\${COMP_WORDS[COMP_CWORD-1]}"; then
+      _suggestOrgs
+    else
 
-    # The command typed by the user but separated by colons (e.g. "mycli command subcom" -> "command:subcom")
-    normalizedCommand="$( printf "%s" "$(join_by ":" "\${__COMP_WORDS[@]}")" )"
+      # Command
+      __COMP_WORDS=( "\${COMP_WORDS[@]:1}" )
 
-    # The command hirarchy, with colons, leading up to the last subcommand entered (e.g. "mycli com subcommand subsubcom" -> "com:subcommand:")
-    colonPrefix="\${normalizedCommand%"\${normalizedCommand##*:}"}"
+      # The command typed by the user but separated by colons (e.g. "mycli command subcom" -> "command:subcom")
+      normalizedCommand="$( printf "%s" "$(join_by ":" "\${__COMP_WORDS[@]}")" )"
 
-    if [[ -z "$normalizedCommand" ]]; then
-      # If there is no normalizedCommand yet the user hasn't typed in a full command
-      # So we should trim all subcommands & flags from $commands so we can suggest all top level commands
-      opts=$(printf "%s " "\${commands[@]}" | grep -Eo '^[a-zA-Z0-9_-]+')
-    else
-      # Filter $commands to just the ones that match the $normalizedCommand and turn into an array
-      commands=( $(compgen -W "$commands" -- "\${normalizedCommand}") )
-      # Trim higher level and subcommands from the subcommands to suggest
-      __trim_colon_commands "$colonPrefix"
+      # The command hirarchy, with colons, leading up to the last subcommand entered (e.g. "mycli com subcommand subsubcom" -> "com:subcommand:")
+      colonPrefix="\${normalizedCommand%"\${normalizedCommand##*:}"}"
+
+      if [[ -z "$normalizedCommand" ]]; then
+        # If there is no normalizedCommand yet the user hasn't typed in a full command
+        # So we should trim all subcommands & flags from $commands so we can suggest all top level commands
+        opts=$(printf "%s " "\${commands[@]}" | grep -Eo '^[a-zA-Z0-9_-]+')
+      else
+        # Filter $commands to just the ones that match the $normalizedCommand and turn into an array
+        commands=( $(compgen -W "$commands" -- "\${normalizedCommand}") )
+        # Trim higher level and subcommands from the subcommands to suggest
+        __trim_colon_commands "$colonPrefix"
 
-      opts=$(printf "%s " "\${commands[@]}") # | grep -Eo '^[a-zA-Z0-9_-]+'
+        opts=$(printf "%s " "\${commands[@]}") # | grep -Eo '^[a-zA-Z0-9_-]+'
+      fi
     fi
   else 
     # Flag
@@ -69,9 +95,15 @@ _<CLI_BIN>_autocomplete()
     # The line below finds the command in $commands using grep
     # Then, using sed, it removes everything from the found command before the --flags (e.g. "command:subcommand:subsubcom --flag1 --flag2" -> "--flag1 --flag2")
     opts=$(printf "%s " "\${commands[@]}" | grep "\${normalizedCommand}" | sed -n "s/^\${normalizedCommand} //p")
+
+    if _isTargetOrgFlag "\${COMP_WORDS[COMP_CWORD]}"; then
+      _suggestOrgs
+    fi
   fi
 
-  COMPREPLY=($(compgen -W "$opts" -- "\${cur}"))
+  if [[ -z "$COMPREPLY" ]]; then
+    COMPREPLY=($(compgen -W "$opts" -- "\${cur}"))
+  fi
 }
 
 complete -F _<CLI_BIN>_autocomplete <CLI_BIN>

src/autocomplete/bash.ts

@@ -10,8 +10,33 @@ _<CLI_BIN>_autocomplete()
 <BASH_COMMANDS_WITH_FLAGS_LIST>
 "
 
+local targetOrgFlags=("--target-org" "-o")
+
+function _isTargetOrgFlag(){
+  local value="$1"
+  for flag in "\${targetOrgFlags[@]}"; do
+    if [[ "$flag" == "$value" ]]; then
+      return 0 # value found
+    fi
+  done
+  return 1 # value not found
+}
+
+function _suggestOrgs(){
+  local orgs="$(sf autocomplete --display-orgs bash 2>/dev/null)"
+
   if [[ "$cur" != "-"* ]]; then
-    opts=$(printf "$commands" | grep -Eo '^[a-zA-Z0-9:_-]+')
+    opts=$(printf "%s " "\${orgs[@]}" | grep -i "\${cur}")
+    COMPREPLY=($(compgen -W "$opts"))
+  fi
+}
+
+  if [[ "$cur" != "-"* ]]; then
+    if _isTargetOrgFlag "\${COMP_WORDS[COMP_CWORD-1]}"; then
+      _suggestOrgs
+    else
+      opts=$(printf "$commands" | grep -Eo '^[a-zA-Z0-9:_-]+')
+    fi
   else
     local __COMP_WORDS
     if [[ \${COMP_WORDS[2]} == ":" ]]; then
@@ -22,9 +47,16 @@ _<CLI_BIN>_autocomplete()
       __COMP_WORDS="\${COMP_WORDS[@]:1:1}"
     fi
     opts=$(printf "$commands" | grep "\${__COMP_WORDS}" | sed -n "s/^\${__COMP_WORDS} //p")
+
+    if _isTargetOrgFlag "\${COMP_WORDS[COMP_CWORD]}"; then
+      _suggestOrgs
+    fi
   fi
   _get_comp_words_by_ref -n : cur
-  COMPREPLY=( $(compgen -W "\${opts}" -- \${cur}) )
+
+  if [[ -z "$COMPREPLY" ]]; then
+    COMPREPLY=( $(compgen -W "\${opts}" -- \${cur}) )
+  fi
   __ltrim_colon_completions "$cur"
   return 0
 

src/autocomplete/powershell.ts

@@ -126,6 +126,45 @@ ${hashtables.join('\n')}
 using namespace System.Management.Automation
 using namespace System.Management.Automation.Language
 
+function orgs(){
+  $orglist=sf autocomplete --display-orgs
+  return $orglist
+}
+
+$targetOrgFlags=@{
+  "long" = "--target-org"
+  "short" = "-o"
+}
+
+function containsTargetOrgFlag {
+  param (
+      [Parameter(Mandatory=$true)]
+      [array]$items,
+
+      [Parameter(Mandatory=$true)]
+      [hashtable]$targetOrgFlags
+  )
+
+  foreach ($item in $items) {
+      if ($item -like $targetOrgFlags['long']+"*" -Or $item -like $targetOrgFlags['short']+"*") {return $true}
+  }
+  return $false
+}
+
+function getTargetOrgFlag {
+  param (
+      [Parameter(Mandatory=$true)]
+      [array]$line,
+
+      [Parameter(Mandatory=$true)]
+      [hashtable]$targetOrgFlags
+  )
+
+  if($line -contains $targetOrgFlags['long']) {return $targetOrgFlags['long']}
+  if($line -contains $targetOrgFlags['short']) {return $targetOrgFlags['short']} 
+  return ""
+}
+
 $scriptblock = {
     param($WordToComplete, $CommandAst, $CursorPosition)
 
@@ -194,6 +233,13 @@ $scriptblock = {
           # Complete flags
           # \`cli config list -<TAB>\`
           if ($WordToComplete -like '-*') {
+            if(containsTargetOrgFlag @($CurrentLine[-1]) $targetOrgFlags){
+              $targetOrgFlag=getTargetOrgFlag $CurrentLine $targetOrgFlags
+
+              orgs | Where-Object { $search = $CurrentLine[-1].replace($targetOrgFlag, "").Trim(); return ($search -eq "" ? $true : $_ -like "*$search*") } | Sort-Object | ForEach-Object {
+                New-Object -Type CompletionResult -ArgumentList "$_", $_, 'ParameterValue', 'Custom completion description'
+              }
+            }else{
               $NextArg._command.flags.GetEnumerator() | Sort-Object -Property key
                   | Where-Object {
                       # Filter out already used flags (unless \`flag.multiple = true\`).
@@ -206,21 +252,29 @@ $scriptblock = {
                           "ParameterValue",
                           "$($NextArg._command.flags[$_.Key].summary ?? " ")"
                   }
+            }
           } else {
               # This could be a coTopic. We remove the "_command" hashtable
               # from $NextArg and check if there's a command under the current partial ID.
               $NextArg.remove("_command")
-
-              if ($NextArg.keys -gt 0) {
-                  $NextArg.GetEnumerator() | Where-Object {
-                      $_.Key.StartsWith("$WordToComplete")
-                    } | Sort-Object -Property key | ForEach-Object {
-                    New-Object -Type CompletionResult -ArgumentList \`
-                      $($Mode -eq "MenuComplete" ? "$($_.Key) " : "$($_.Key)"),
-                      $_.Key,
-                      "ParameterValue",
-                      "$($NextArg[$_.Key]._summary ?? " ")"
-                  }
+              $targetOrgFlag=getTargetOrgFlag $CurrentLine $targetOrgFlags
+
+              if(containsTargetOrgFlag @($CurrentLine[-1], $CurrentLine[-2]) $targetOrgFlags){
+                orgs | Where-Object { $search = $CurrentLine[-1].replace($targetOrgFlag, "").Trim(); return ($search -eq "" ? $true : $_ -like "*$search*") } | Sort-Object | ForEach-Object {
+                  New-Object -Type CompletionResult -ArgumentList "$_", $_, 'ParameterValue', 'Custom completion description'
+                }
+              }else{
+                if ($NextArg.keys -gt 0) {
+                    $NextArg.GetEnumerator() | Where-Object {
+                        $_.Key.StartsWith("$WordToComplete")
+                      } | Sort-Object -Property key | ForEach-Object {
+                      New-Object -Type CompletionResult -ArgumentList \`
+                        $($Mode -eq "MenuComplete" ? "$($_.Key) " : "$($_.Key)"),
+                        $_.Key,
+                        "ParameterValue",
+                        "$($NextArg[$_.Key]._summary ?? " ")"
+                    }
+                }
               }
           }
       } else {

src/autocomplete/zsh.ts

@@ -1,5 +1,6 @@
 import {Command, Config, Interfaces} from '@oclif/core'
 import * as ejs from 'ejs'
+import {execSync} from 'node:child_process'
 import * as util from 'node:util'
 
 const argTemplate = '        "%s")\n          %s\n        ;;\n'
@@ -26,12 +27,15 @@ export default class ZshCompWithSpaces {
 
   private commands: CommandCompletion[]
 
+  private orgs: string[]
+
   private topics: Topic[]
 
-  constructor(config: Config) {
+  constructor(config: Config, orgs?: string[]) {
     this.config = config
     this.topics = this.getTopics()
     this.commands = this.getCommands()
+    this.orgs = orgs || this.getOrgs()
   }
 
   public generate(): string {
@@ -84,6 +88,11 @@ export default class ZshCompWithSpaces {
     return `#compdef ${this.config.bin}
 ${this.config.binAliases?.map((a) => `compdef ${a}=${this.config.bin}`).join('\n') ?? ''}
 
+_orgs(){
+  local orgs=(\${(@f)$(sf autocomplete --display-orgs zsh 2>/dev/null)})
+  _describe -t orgs 'orgs' orgs && return 0
+}
+
 ${this.topics.map((t) => this.genZshTopicCompFun(t.name)).join('\n')}
 
 _${this.config.bin}() {
@@ -124,6 +133,10 @@ _${this.config.bin}
     return this._coTopics
   }
 
+  private genOrgs(): string {
+    return this.orgs.join('\n')
+  }
+
   private genZshFlagArgumentsBlock(flags?: CommandFlags): string {
     // if a command doesn't have flags make it only complete files
     // also add comp for the global `--help` flag.
@@ -159,7 +172,11 @@ _${this.config.bin}
 
           flagSpec += `"[${flagSummary}]`
 
-          flagSpec += f.options ? `:${f.name} options:(${f.options?.join(' ')})"` : ':file:_files"'
+          flagSpec += f.options
+            ? `:${f.name} options:(${f.options?.join(' ')})"`
+            : f.name === 'target-org'
+              ? ':org:_orgs"'
+              : ':file:_files"'
         } else {
           if (f.multiple) {
             // this flag can be present multiple times on the line
@@ -168,7 +185,11 @@ _${this.config.bin}
 
           flagSpec += `--${f.name}"[${flagSummary}]:`
 
-          flagSpec += f.options ? `${f.name} options:(${f.options.join(' ')})"` : 'file:_files"'
+          flagSpec += f.options
+            ? `${f.name} options:(${f.options.join(' ')})"`
+            : f.name === 'target-org'
+              ? ':org:_orgs"'
+              : ':file:_files"'
         }
       } else if (f.char) {
         // Flag.Boolean
@@ -379,6 +400,17 @@ _${this.config.bin}
     return cmds
   }
 
+  private getOrgs(): string[] {
+    const orgsJson = JSON.parse(execSync('sf org list auth --json 2>/dev/null').toString())
+    const result: string[] = []
+    for (const element of orgsJson.result) {
+      if (element.alias) result.push(element.alias)
+      else result.push(element.username)
+    }
+
+    return result.sort()
+  }
+
   private getTopics(): Topic[] {
     const topics = this.config.topics
       .filter((topic: Interfaces.Topic) => {

src/commands/autocomplete/create.ts

@@ -199,7 +199,12 @@ export default class Create extends AutocompleteBase {
         const isOption = f.type === 'option'
         const name = isBoolean ? flag : `${flag}=-`
         const multiple = isOption && f.multiple ? '*' : ''
-        const valueCmpl = isBoolean ? '' : ':'
+        let valueCmpl = isBoolean ? '' : ':'
+
+        if (name === 'target-org=-') {
+          valueCmpl += `array_values:((\${(@)$(_orgs)}))`
+        }
+
         const completion = `${multiple}--${name}[${sanitizeDescription(f.summary || f.description)}]${valueCmpl}`
         return `"${completion}"`
       })
@@ -229,6 +234,11 @@ _${cliBin} () {
   local _cur=\${words[CURRENT]}
   local -a _command_flags=()
 
+  _orgs(){
+    local orgs=(\${(@f)$(sf autocomplete --display-orgs zsh 2>/dev/null)})
+    echo "$orgs"
+  }
+
   ## public cli commands & flags
   local -a _all_commands=(
 ${allCommandsMeta}