Port Homebrew::Cmd::Tap

This commit is contained in:
Douglas Eichelberger 2024-04-01 11:42:17 -07:00
parent be42d46d49
commit 841cfd9fdc
2 changed files with 66 additions and 67 deletions

View File

@ -1,77 +1,75 @@
# typed: true # typed: strict
# frozen_string_literal: true # frozen_string_literal: true
require "cli/parser" require "abstract_command"
module Homebrew module Homebrew
module_function module Cmd
class TapCmd < AbstractCommand
cmd_args do
usage_banner "`tap` [<options>] [<user>`/`<repo>] [<URL>]"
description <<~EOS
Tap a formula repository.
If no arguments are provided, list all installed taps.
sig { returns(CLI::Parser) } With <URL> unspecified, tap a formula repository from GitHub using HTTPS.
def tap_args Since so many taps are hosted on GitHub, this command is a shortcut for
Homebrew::CLI::Parser.new do `brew tap` <user>`/`<repo> `https://github.com/`<user>`/homebrew-`<repo>.
usage_banner "`tap` [<options>] [<user>`/`<repo>] [<URL>]"
description <<~EOS
Tap a formula repository.
If no arguments are provided, list all installed taps.
With <URL> unspecified, tap a formula repository from GitHub using HTTPS. With <URL> specified, tap a formula repository from anywhere, using
Since so many taps are hosted on GitHub, this command is a shortcut for any transport protocol that `git`(1) handles. The one-argument form of `tap`
`brew tap` <user>`/`<repo> `https://github.com/`<user>`/homebrew-`<repo>. simplifies but also limits. This two-argument command makes no
assumptions, so taps can be cloned from places other than GitHub and
using protocols other than HTTPS, e.g. SSH, git, HTTP, FTP(S), rsync.
EOS
switch "--full",
description: "Convert a shallow clone to a full clone without untapping. Taps are only cloned as " \
"shallow clones if `--shallow` was originally passed.",
replacement: false,
disable: true
switch "--shallow",
description: "Fetch tap as a shallow clone rather than a full clone. Useful for continuous " \
"integration.",
replacement: false,
disable: true
switch "--[no-]force-auto-update",
hidden: true
switch "--custom-remote",
description: "Install or change a tap with a custom remote. Useful for mirrors."
switch "--repair",
description: "Migrate tapped formulae from symlink-based to directory-based structure."
switch "--eval-all",
description: "Evaluate all the formulae, casks and aliases in the new tap to check validity. " \
"Implied if `HOMEBREW_EVAL_ALL` is set."
switch "--force",
description: "Force install core taps even under API mode."
With <URL> specified, tap a formula repository from anywhere, using named_args :tap, max: 2
any transport protocol that `git`(1) handles. The one-argument form of `tap`
simplifies but also limits. This two-argument command makes no
assumptions, so taps can be cloned from places other than GitHub and
using protocols other than HTTPS, e.g. SSH, git, HTTP, FTP(S), rsync.
EOS
switch "--full",
description: "Convert a shallow clone to a full clone without untapping. Taps are only cloned as " \
"shallow clones if `--shallow` was originally passed.",
replacement: false,
disable: true
switch "--shallow",
description: "Fetch tap as a shallow clone rather than a full clone. Useful for continuous integration.",
replacement: false,
disable: true
switch "--[no-]force-auto-update",
hidden: true
switch "--custom-remote",
description: "Install or change a tap with a custom remote. Useful for mirrors."
switch "--repair",
description: "Migrate tapped formulae from symlink-based to directory-based structure."
switch "--eval-all",
description: "Evaluate all the formulae, casks and aliases in the new tap to check validity. " \
"Implied if `HOMEBREW_EVAL_ALL` is set."
switch "--force",
description: "Force install core taps even under API mode."
named_args :tap, max: 2
end
end
sig { void }
def tap
args = tap_args.parse
if args.repair?
Tap.installed.each do |tap|
tap.link_completions_and_manpages
tap.fix_remote_configuration
end end
elsif args.no_named?
puts Tap.installed.sort_by(&:name) sig { override.void }
else def run
tap = Tap.fetch(args.named.first) if args.repair?
begin Tap.installed.each do |tap|
tap.install clone_target: args.named.second, tap.link_completions_and_manpages
custom_remote: args.custom_remote?, tap.fix_remote_configuration
quiet: args.quiet?, end
verify: args.eval_all? || Homebrew::EnvConfig.eval_all?, elsif args.no_named?
force: args.force? puts Tap.installed.sort_by(&:name)
rescue TapRemoteMismatchError, TapNoCustomRemoteError => e else
odie e tap = Tap.fetch(args.named.first)
rescue TapAlreadyTappedError begin
nil tap.install clone_target: args.named.second,
custom_remote: args.custom_remote?,
quiet: args.quiet?,
verify: args.eval_all? || Homebrew::EnvConfig.eval_all?,
force: args.force?
rescue TapRemoteMismatchError, TapNoCustomRemoteError => e
odie e
rescue TapAlreadyTappedError
nil
end
end
end end
end end
end end

View File

@ -1,8 +1,9 @@
# frozen_string_literal: true # frozen_string_literal: true
require "cmd/shared_examples/args_parse" require "cmd/shared_examples/args_parse"
require "cmd/tap"
RSpec.describe "brew tap" do RSpec.describe Homebrew::Cmd::TapCmd do
it_behaves_like "parseable arguments" it_behaves_like "parseable arguments"
it "taps a given Tap", :integration_test do it "taps a given Tap", :integration_test do