Module: Homebrew::Completions Private
- Defined in:
- completions.rb
Overview
This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.
Helper functions for generating shell completions.
Defined Under Namespace
Classes: Variables
Constant Summary collapse
- COMPLETIONS_DIR =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
(HOMEBREW_REPOSITORY/"completions").freeze
- TEMPLATE_DIR =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
(HOMEBREW_LIBRARY_PATH/"completions").freeze
- SHELLS =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
%w[bash fish zsh].freeze
- COMPLETIONS_EXCLUSION_LIST =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
%w[ instal uninstal update-report ].freeze
- BASH_NAMED_ARGS_COMPLETION_FUNCTION_MAPPING =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
{ formula: "__brew_complete_formulae", installed_formula: "__brew_complete_installed_formulae", outdated_formula: "__brew_complete_outdated_formulae", cask: "__brew_complete_casks", installed_cask: "__brew_complete_installed_casks", outdated_cask: "__brew_complete_outdated_casks", tap: "__brew_complete_tapped", installed_tap: "__brew_complete_tapped", command: "__brew_complete_commands", diagnostic_check: '__brewcomp "${__HOMEBREW_DOCTOR_CHECKS=$(brew doctor --list-checks)}"', file: "__brew_complete_files", }.freeze
- ZSH_NAMED_ARGS_COMPLETION_FUNCTION_MAPPING =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
{ formula: "__brew_formulae", installed_formula: "__brew_installed_formulae", outdated_formula: "__brew_outdated_formulae", cask: "__brew_casks", installed_cask: "__brew_installed_casks", outdated_cask: "__brew_outdated_casks", tap: "__brew_any_tap", installed_tap: "__brew_installed_taps", command: "__brew_commands", diagnostic_check: "__brew_diagnostic_checks", file: "__brew_formulae_or_ruby_files", }.freeze
- FISH_NAMED_ARGS_COMPLETION_FUNCTION_MAPPING =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
{ formula: "__fish_brew_suggest_formulae_all", installed_formula: "__fish_brew_suggest_formulae_installed", outdated_formula: "__fish_brew_suggest_formulae_outdated", cask: "__fish_brew_suggest_casks_all", installed_cask: "__fish_brew_suggest_casks_installed", outdated_cask: "__fish_brew_suggest_casks_outdated", tap: "__fish_brew_suggest_taps_installed", installed_tap: "__fish_brew_suggest_taps_installed", command: "__fish_brew_suggest_commands", diagnostic_check: "__fish_brew_suggest_diagnostic_checks", }.freeze
Class Method Summary collapse
-
.command_gets_completions?(command) ⇒ Boolean
private
-
.command_options(command) ⇒ Hash{String => String}
private
-
.completions_to_link? ⇒ Boolean
private
-
.format_description(description, fish: false) ⇒ String
private
-
.generate_bash_completion_file(commands) ⇒ String
private
-
.generate_bash_subcommand_completion(command) ⇒ String?
private
-
.generate_fish_completion_file(commands) ⇒ String
private
-
.generate_fish_subcommand_completion(command) ⇒ String?
private
-
.generate_zsh_completion_file(commands) ⇒ String
private
-
.generate_zsh_option_exclusions(command, option) ⇒ Object
private
-
.generate_zsh_subcommand_completion(command) ⇒ String?
private
-
.link! ⇒ void
private
-
.link_completions? ⇒ Boolean
private
-
.show_completions_message_if_needed ⇒ void
private
-
.unlink! ⇒ void
private
-
.update_shell_completions! ⇒ void
private
Class Method Details
.command_gets_completions?(command) ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
135 136 137 |
# File 'completions.rb', line 135 def self.command_gets_completions?(command) (command).any? end |
.command_options(command) ⇒ Hash{String => String}
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'completions.rb', line 150 def self.(command) = {} Commands.(command)&.each do |option| next if option.blank? name = option.first desc = option.second if name.start_with? "--[no-]" [name.remove("[no-]")] = desc [name.sub("[no-]", "no-")] = desc else [name] = desc end end end |
.completions_to_link? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
96 97 98 99 100 101 102 103 104 105 106 |
# File 'completions.rb', line 96 def self.completions_to_link? Tap.each do |tap| next if tap.official? SHELLS.each do |shell| return true if (tap.path/"completions/#{shell}").exist? end end false end |
.format_description(description, fish: false) ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
140 141 142 143 144 145 146 147 |
# File 'completions.rb', line 140 def self.format_description(description, fish: false) description = if fish description.gsub("'", "\\\\'") else description.gsub("'", "'\\\\''") end description.gsub(/[<>]/, "").tr("\n", " ").chomp(".") end |
.generate_bash_completion_file(commands) ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'completions.rb', line 201 def self.generate_bash_completion_file(commands) variables = Variables.new( completion_functions: commands.map do |command| generate_bash_subcommand_completion command end.compact, function_mappings: commands.map do |command| next unless command_gets_completions? command "#{command}) _brew_#{Commands.method_name command} ;;" end.compact, ) ERB.new((TEMPLATE_DIR/"bash.erb").read, trim_mode: ">").result(variables.instance_eval { binding }) end |
.generate_bash_subcommand_completion(command) ⇒ String?
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'completions.rb', line 168 def self.generate_bash_subcommand_completion(command) return unless command_gets_completions? command named_completion_string = "" if (types = Commands.named_args_type(command)) named_args_strings, named_args_types = types.partition { |type| type.is_a? String } named_args_types.each do |type| next unless BASH_NAMED_ARGS_COMPLETION_FUNCTION_MAPPING.key? type named_completion_string += "\n #{BASH_NAMED_ARGS_COMPLETION_FUNCTION_MAPPING[type]}" end named_completion_string += "\n __brewcomp \"#{named_args_strings.join(" ")}\"" if named_args_strings.any? end <<~COMPLETION _brew_#{Commands.method_name command}() { local cur="${COMP_WORDS[COMP_CWORD]}" case "${cur}" in -*) __brewcomp " #{(command).keys.sort.join("\n ")} " return ;; *) ;; esac#{named_completion_string} } COMPLETION end |
.generate_fish_completion_file(commands) ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
351 352 353 354 355 356 357 358 359 |
# File 'completions.rb', line 351 def self.generate_fish_completion_file(commands) variables = Variables.new( completion_functions: commands.map do |command| generate_fish_subcommand_completion command end.compact, ) ERB.new((TEMPLATE_DIR/"fish.erb").read, trim_mode: ">").result(variables.instance_eval { binding }) end |
.generate_fish_subcommand_completion(command) ⇒ String?
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
# File 'completions.rb', line 304 def self.generate_fish_subcommand_completion(command) return unless command_gets_completions? command command_description = format_description Commands.command_description(command, short: true), fish: true lines = ["__fish_brew_complete_cmd '#{command}' '#{command_description}'"] = (command).sort.map do |opt, desc| arg_line = "__fish_brew_complete_arg '#{command}' -l #{opt.sub(/^-+/, "")}" arg_line += " -d '#{format_description desc, fish: true}'" if desc.present? arg_line end.compact subcommands = [] named_args = [] if (types = Commands.named_args_type(command)) named_args_strings, named_args_types = types.partition { |type| type.is_a? String } named_args_types.each do |type| next unless FISH_NAMED_ARGS_COMPLETION_FUNCTION_MAPPING.key? type named_arg_function = FISH_NAMED_ARGS_COMPLETION_FUNCTION_MAPPING[type] named_arg_prefix = "__fish_brew_complete_arg '#{command}; and not __fish_seen_argument" formula_option = (command).key?("--formula") cask_option = (command).key?("--cask") named_args << if formula_option && cask_option && type.to_s.end_with?("formula") "#{named_arg_prefix} -l cask -l casks' -a '(#{named_arg_function})'" elsif formula_option && cask_option && type.to_s.end_with?("cask") "#{named_arg_prefix} -l formula -l formulae' -a '(#{named_arg_function})'" else "__fish_brew_complete_arg '#{command}' -a '(#{named_arg_function})'" end end named_args_strings.each do |subcommand| subcommands << "__fish_brew_complete_sub_cmd '#{command}' '#{subcommand}'" end end lines += subcommands + + named_args <<~COMPLETION #{lines.join("\n").chomp} COMPLETION end |
.generate_zsh_completion_file(commands) ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'completions.rb', line 277 def self.generate_zsh_completion_file(commands) variables = Variables.new( aliases: Commands::HOMEBREW_INTERNAL_COMMAND_ALIASES.map do |alias_command, command| alias_command = "'#{alias_command}'" if alias_command.start_with? "-" command = "'#{command}'" if command.start_with? "-" "#{alias_command} #{command}" end.compact, builtin_command_descriptions: commands.map do |command| next if Commands::HOMEBREW_INTERNAL_COMMAND_ALIASES.key? command description = Commands.command_description(command, short: true) next if description.blank? description = format_description description "'#{command}:#{description}'" end.compact, completion_functions: commands.map do |command| generate_zsh_subcommand_completion command end.compact, ) ERB.new((TEMPLATE_DIR/"zsh.erb").read, trim_mode: ">").result(variables.instance_eval { binding }) end |
.generate_zsh_option_exclusions(command, option) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
269 270 271 272 273 274 |
# File 'completions.rb', line 269 def self.generate_zsh_option_exclusions(command, option) conflicts = Commands.option_conflicts(command, option.gsub(/^--/, "")) return "" unless conflicts.presence "(#{conflicts.map { |conflict| "--#{conflict}" }.join(" ")})" end |
.generate_zsh_subcommand_completion(command) ⇒ String?
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'completions.rb', line 217 def self.generate_zsh_subcommand_completion(command) return unless command_gets_completions? command = (command) = [] if (types = Commands.named_args_type(command)) named_args_strings, named_args_types = types.partition { |type| type.is_a? String } named_args_types.each do |type| next unless ZSH_NAMED_ARGS_COMPLETION_FUNCTION_MAPPING.key? type << "- #{type}" opt = "--#{type.to_s.gsub(/(installed|outdated)_/, "")}" if .key?(opt) desc = [opt] if desc.blank? << opt else conflicts = generate_zsh_option_exclusions(command, opt) << "#{conflicts}#{opt}[#{format_description desc}]" end .delete(opt) end << "*::#{type}:#{ZSH_NAMED_ARGS_COMPLETION_FUNCTION_MAPPING[type]}" end if named_args_strings.any? << "- subcommand" << "*::subcommand:(#{named_args_strings.join(" ")})" end end = .sort.map do |opt, desc| next opt if desc.blank? conflicts = generate_zsh_option_exclusions(command, opt) "#{conflicts}#{opt}[#{format_description desc}]" end += <<~COMPLETION # brew #{command} _brew_#{Commands.method_name command}() { _arguments \\ #{.map! { |opt| opt.start_with?("- ") ? opt : "'#{opt}'" }.join(" \\\n ")} } COMPLETION end |
.link! ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
73 74 75 76 77 78 |
# File 'completions.rb', line 73 def self.link! Settings.write :linkcompletions, true Tap.each do |tap| Utils::Link.link_completions tap.path, "brew completions link" end end |
.link_completions? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
91 92 93 |
# File 'completions.rb', line 91 def self.link_completions? Settings.read(:linkcompletions) == "true" end |
.show_completions_message_if_needed ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'completions.rb', line 109 def self. return if Settings.read(:completionsmessageshown) == "true" return unless completions_to_link? ohai "Homebrew completions for external commands are unlinked by default!" puts <<~EOS To opt-in to automatically linking external tap shell completion files, run: brew completions link Then, follow the directions at #{Formatter.url("https://docs.brew.sh/Shell-Completion")} EOS Settings.write :completionsmessageshown, true end |
.unlink! ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
81 82 83 84 85 86 87 88 |
# File 'completions.rb', line 81 def self.unlink! Settings.write :linkcompletions, false Tap.each do |tap| next if tap.official? Utils::Link.unlink_completions tap.path end end |
.update_shell_completions! ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
124 125 126 127 128 129 130 131 132 |
# File 'completions.rb', line 124 def self.update_shell_completions! commands = Commands.commands(external: false, aliases: true).sort puts "Writing completions to #{COMPLETIONS_DIR}" (COMPLETIONS_DIR/"bash/brew").atomic_write generate_bash_completion_file(commands) (COMPLETIONS_DIR/"zsh/_brew").atomic_write generate_zsh_completion_file(commands) (COMPLETIONS_DIR/"fish/brew.fish").atomic_write generate_fish_completion_file(commands) end |