brew/Library/Homebrew/cmd/tap.rb

# typed: strict
# frozen_string_literal: true

require "abstract_command"
require "tap"

module Homebrew
  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.

          With <URL> unspecified, tap a formula repository from GitHub using HTTPS.
          Since so many taps are hosted on GitHub, this command is a shortcut for
          `brew tap` <user>`/`<repo> `https://github.com/`<user>`/homebrew-`<repo>.

          With <URL> specified, tap a formula repository from anywhere, using
          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 "-f", "--force",
               description: "Force install core taps even under API mode."

        named_args :tap, max: 2
      end

      sig { override.void }
      def run
        if args.repair?
          Tap.installed.each do |tap|
            tap.link_completions_and_manpages
            tap.fix_remote_configuration
          end
        elsif args.no_named?
          puts Tap.installed.sort_by(&:name)
        else
          tap = Tap.fetch(args.named.fetch(0))
          begin
            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