Merge pull request #22352 from Homebrew/omit-alias-completions

Omit aliases from completions

Author: MikeMcQuaid

Library/Homebrew/commands.rb

@@ -190,7 +190,7 @@ def self.find_commands(path)
   def self.rebuild_internal_commands_completion_list
     require "completions"
 
-    cmds = internal_commands + internal_developer_commands + internal_commands_aliases
+    cmds = internal_commands + internal_developer_commands
     cmds.reject! { |cmd| Homebrew::Completions::COMPLETIONS_EXCLUSION_LIST.include? cmd }
 
     file = HOMEBREW_REPOSITORY/"completions/internal_commands_list.txt"
@@ -204,7 +204,7 @@ def self.rebuild_commands_completion_list
     # Ensure that the cache exists so we can build the commands list
     HOMEBREW_CACHE.mkpath
 
-    cmds = commands(aliases: true) - Homebrew::Completions::COMPLETIONS_EXCLUSION_LIST
+    cmds = commands - Homebrew::Completions::COMPLETIONS_EXCLUSION_LIST
 
     all_commands_file = HOMEBREW_CACHE/"all_commands_list.txt"
     external_commands_file = HOMEBREW_CACHE/"external_commands_list.txt"

Library/Homebrew/completions.rb

@@ -124,7 +124,7 @@ def self.show_completions_message_if_needed
 
     sig { void }
     def self.update_shell_completions!
-      commands = Commands.commands(external: false, aliases: true).sort
+      commands = Commands.commands(external: false).sort
 
       puts "Writing completions to #{COMPLETIONS_DIR}"
 
@@ -283,7 +283,12 @@ def self.generate_bash_subcommand_completion(command)
 
     sig { params(commands: T::Array[String]).returns(String) }
     def self.generate_bash_completion_file(commands)
+      commands -= Commands.internal_commands_aliases
+
       variables = Variables.new(
+        aliases:              Commands::HOMEBREW_INTERNAL_COMMAND_ALIASES.map do |alias_cmd, command|
+          "#{alias_cmd}) echo \"#{command}\" ;;"
+        end,
         completion_functions: commands.filter_map do |command|
           generate_bash_subcommand_completion command
         end,
@@ -449,6 +454,8 @@ def self.generate_zsh_option_exclusions(command, option)
 
     sig { params(commands: T::Array[String]).returns(String) }
     def self.generate_zsh_completion_file(commands)
+      commands -= Commands.internal_commands_aliases
+
       variables = Variables.new(
         aliases:                      Commands::HOMEBREW_INTERNAL_COMMAND_ALIASES.filter_map do |alias_cmd, command|
           alias_cmd = "'#{alias_cmd}'" if alias_cmd.start_with? "-"
@@ -482,7 +489,8 @@ def self.generate_fish_subcommand_completion(command)
       return generate_fish_nested_subcommand_completion(command, subcommands) if subcommands.present?
 
       command_description = format_description Commands.command_description(command, short: true).to_s, fish: true
-      lines = if COMPLETIONS_EXCLUSION_LIST.include?(command)
+      lines = if COMPLETIONS_EXCLUSION_LIST.include?(command) ||
+                 Commands::HOMEBREW_INTERNAL_COMMAND_ALIASES.key?(command)
         []
       else
         ["__fish_brew_complete_cmd '#{command}' '#{command_description}'"]
@@ -571,7 +579,8 @@ def self.generate_fish_named_args(command, types, subcommand: nil)
     sig { params(command: String, subcommands: T::Array[Homebrew::CLI::Parser::Subcommand]).returns(String) }
     def self.generate_fish_nested_subcommand_completion(command, subcommands)
       command_description = format_description Commands.command_description(command, short: true).to_s, fish: true
-      lines = if COMPLETIONS_EXCLUSION_LIST.include?(command)
+      lines = if COMPLETIONS_EXCLUSION_LIST.include?(command) ||
+                 Commands::HOMEBREW_INTERNAL_COMMAND_ALIASES.key?(command)
         []
       else
         ["__fish_brew_complete_cmd '#{command}' '#{command_description}'"]
@@ -615,7 +624,12 @@ def self.generate_fish_nested_subcommand_completion(command, subcommands)
 
     sig { params(commands: T::Array[String]).returns(String) }
     def self.generate_fish_completion_file(commands)
+      commands -= Commands.internal_commands_aliases
+
       variables = Variables.new(
+        aliases:              Commands::HOMEBREW_INTERNAL_COMMAND_ALIASES.map do |alias_cmd, command|
+          "        case '#{alias_cmd}'\n            echo '#{command}'"
+        end,
         completion_functions: commands.filter_map do |command|
           generate_fish_subcommand_completion command
         end,

Library/Homebrew/completions/bash.erb

@@ -113,7 +113,6 @@ __brew_complete_commands() {
 
   local cur="${COMP_WORDS[COMP_CWORD]}"
   local cmds
-  local -a cmd_aliases
 
   if [[ -n ${__HOMEBREW_COMMANDS} ]]
   then
@@ -125,9 +124,11 @@ __brew_complete_commands() {
   then
     cmds="$(< "${HOMEBREW_REPOSITORY}/completions/internal_commands_list.txt")"
   fi
-  while read -r alias; do cmd_aliases+=("${alias}"); done < <(compgen -W "$(__brew_list_aliases)")
-  [[ -n ${cmd_aliases[*]+"${cmd_aliases[*]}"} ]] && cmds+=" ${cmd_aliases[*]} alias unalias"
-  while read -r line; do COMPREPLY+=("${line}"); done < <(compgen -W "${cmds}" -- "${cur}")
+  while read -r line
+  do
+    [[ $(__brew_internal_command_alias "${line}") == "${line}" ]] || continue
+    COMPREPLY+=("${line}")
+  done < <(compgen -W "${cmds}" -- "${cur}")
   export __HOMEBREW_COMMANDS=${cmds}
 }
 
@@ -136,6 +137,13 @@ __brew_complete_files() {
   command -v compopt &> /dev/null && compopt -o default
 }
 
+__brew_internal_command_alias() {
+  case "$1" in
+    <%= aliases.join("\n    ") + "\n" %>
+    *) echo "$1" ;;
+  esac
+}
+
 # https://github.com/Homebrew/homebrew-aliases
 __brew_list_aliases() {
   local aliases_dir="${HOME}/.brew-aliases"
@@ -186,6 +194,8 @@ _brew() {
     return
   fi
 
+  cmd="$(__brew_internal_command_alias "${cmd}")"
+
   # subcommands have their own completion functions
   case "${cmd}" in
     <%= function_mappings.join("\n    ").concat("\n") %>

Library/Homebrew/completions/fish.erb

@@ -38,6 +38,14 @@ function __fish_brew_args -d "Returns a list of all arguments given to brew"
     end
 end
 
+function __fish_brew_expand_alias -a cmd -d "Expands a Homebrew command alias"
+    switch $cmd
+<%= aliases.join("\n") + "\n" %>
+        case '*'
+            echo $cmd
+    end
+end
+
 function __fish_brew_opts -d "Only arguments starting with a dash (options)"
     string match --all -- '-*' (__fish_brew_args)
 end
@@ -52,11 +60,12 @@ end
 function __fish_brew_command -d "Helps matching the first argument of brew"
     set args (__fish_brew_args)
     set -q args[1]; or return 1
+    set -l cmd (__fish_brew_expand_alias $args[1])
 
     if count $argv
-        contains -- $args[1] $argv
+        contains -- $cmd $argv
     else
-        echo $args[1]
+        echo $cmd
     end
 end
 
@@ -147,11 +156,16 @@ function __fish_brew_suggest_taps_installed -d "List all available taps"
     | string replace (brew --repo)/Library/Taps/ ""
 end
 
-function __fish_brew_suggest_commands -d "Lists all commands names, including aliases"
+function __fish_brew_suggest_commands -d "Lists all command names"
+    set -l commands
     if test -f (brew --cache)/all_commands_list.txt
-        cat (brew --cache)/all_commands_list.txt
+        set commands (cat (brew --cache)/all_commands_list.txt)
     else
-        cat (brew --repo)/completions/internal_commands_list.txt
+        set commands (cat (brew --repo)/completions/internal_commands_list.txt)
+    end
+    for command in $commands
+        set -l expanded_command (__fish_brew_expand_alias $command)
+        test "$expanded_command" = "$command"; and echo $command
     end
 end
 

Library/Homebrew/test/commands_spec.rb

@@ -77,6 +77,34 @@
     end
   end
 
+  describe "::rebuild_internal_commands_completion_list" do
+    it "omits internal command aliases" do
+      mktmpdir do |repository|
+        stub_const("HOMEBREW_REPOSITORY", repository)
+        (repository/"completions").mkpath
+
+        described_class.rebuild_internal_commands_completion_list
+
+        commands = (repository/"completions/internal_commands_list.txt").read.lines(chomp: true)
+        expect(commands & described_class.internal_commands_aliases).to be_empty
+      end
+    end
+  end
+
+  describe "::rebuild_commands_completion_list" do
+    it "omits internal command aliases from the cached command list" do
+      mktmpdir do |cache|
+        stub_const("HOMEBREW_CACHE", cache)
+        allow(described_class).to receive(:external_commands).and_return(["external"])
+
+        described_class.rebuild_commands_completion_list
+
+        commands = (cache/"all_commands_list.txt").read.lines(chomp: true)
+        expect(commands & described_class.internal_commands_aliases).to be_empty
+      end
+    end
+  end
+
   describe "::path" do
     specify "returns the path for an internal command" do
       expect(described_class.path("rbcmd")).to eq(Commands::HOMEBREW_CMD_PATH/"rbcmd.rb")

Library/Homebrew/test/completions_spec.rb

@@ -396,6 +396,17 @@ def stub_nested_completion_command(command, subcommands)
         expect(file).to match(/^ {4}update\) _brew_update ;;/)
         expect(file).to match(/^complete -o bashdefault -o default -F _brew brew$/)
       end
+
+      it "doesn't add aliases to command completions" do
+        file = described_class.generate_bash_completion_file(%w[install missing up update])
+        expect(file).not_to include("cmd_aliases")
+        expect(file).not_to match(/^_brew_up\(\) {$/)
+        expect(file).not_to match(/^ {4}up\) _brew_up ;;/)
+        expect(file).to include('[[ $(__brew_internal_command_alias "${line}") == "${line}" ]] || continue')
+        expect(file).to include('cmd="$(__brew_internal_command_alias "${cmd}")"')
+        expect(file).to match(/^ {4}up\) echo "update" ;;$/)
+        expect(file).to match(/^ {4}update\) _brew_update ;;$/)
+      end
     end
 
     describe ".generate_zsh_subcommand_completion" do
@@ -461,6 +472,15 @@ def stub_nested_completion_command(command, subcommands)
         expect(completion).to include("info|i)")
         expect(completion).to include("*:service:__brew_services")
       end
+
+      it "doesn't generate alias completion functions" do
+        file = described_class.generate_zsh_completion_file(%w[up update])
+        expect(file).not_to match(/^# brew up$/)
+        expect(file).not_to match(/^_brew_up\(\) {$/)
+        expect(file).to match(/^    up update$/)
+        expect(file).to include('command="${aliases[$command_or_alias]:-$command_or_alias}"')
+        expect(file).to include('local completion_func="_brew_${command//-/_}"')
+      end
     end
 
     describe ".generate_zsh_completion_file" do
@@ -546,6 +566,16 @@ def stub_nested_completion_command(command, subcommands)
         expect(file).to match(/^__fish_brew_complete_cmd 'missing' 'Check the given formula kegs for .*'$/)
         expect(file).to match(/^__fish_brew_complete_cmd 'update' 'Fetch the newest version of Homebrew .*'$/)
       end
+
+      it "omits aliases from command completions" do
+        file = described_class.generate_fish_completion_file(%w[up update])
+        expect(file).not_to match(/^__fish_brew_complete_cmd 'up'/)
+        expect(file).not_to match(/^__fish_brew_complete_arg 'up'/)
+        expect(file).to match(/^        case 'up'$/)
+        expect(file).to match(/^            echo 'update'$/)
+        expect(file).to include("set -l cmd (__fish_brew_expand_alias $args[1])")
+        expect(file).to match(/^__fish_brew_complete_cmd 'update'/)
+      end
     end
   end
 end