brew/Library/Homebrew/cmd/cleanup.rb

# typed: strict
# frozen_string_literal: true

require "abstract_command"
require "cleanup"

module Homebrew
  module Cmd
    class CleanupCmd < AbstractCommand
      cmd_args do
        days = Homebrew::EnvConfig::ENVS[:HOMEBREW_CLEANUP_MAX_AGE_DAYS]&.dig(:default)
        description <<~EOS
          Remove stale lock files and outdated downloads for all formulae and casks,
          and remove old versions of installed formulae. If arguments are specified,
          only do this for the given formulae and casks. Removes all downloads more than
          #{days} days old. This can be adjusted with `$HOMEBREW_CLEANUP_MAX_AGE_DAYS`.
        EOS
        flag   "--prune=",
               description: "Remove all cache files older than specified <days>. " \
                            "If you want to remove everything, use `--prune=all`."
        switch "-n", "--dry-run",
               description: "Show what would be removed, but do not actually remove anything."
        switch "-s", "--scrub",
               description: "Scrub the cache, including downloads for even the latest versions. " \
                            "Note that downloads for any installed formulae or casks will still not be deleted. " \
                            "If you want to delete those too: `rm -rf \"$(brew --cache)\"`"
        switch "--prune-prefix",
               description: "Only prune the symlinks and directories from the prefix and remove no other files."

        named_args [:formula, :cask]
      end

      sig { override.void }
      def run
        days = args.prune.presence&.then do |prune|
          case prune
          when /\A\d+\Z/
            prune.to_i
          when "all"
            0
          else
            raise UsageError, "`--prune` expects an integer or `all`."
          end
        end

        cleanup = Cleanup.new(*args.named, dry_run: args.dry_run?, scrub: args.s?, days:)
        if args.prune_prefix?
          cleanup.prune_prefix_symlinks_and_directories
          return
        end

        cleanup.clean!(quiet: args.quiet?, periodic: false)

        unless cleanup.disk_cleanup_size.zero?
          disk_space = disk_usage_readable(cleanup.disk_cleanup_size)
          if args.dry_run?
            ohai "This operation would free approximately #{disk_space} of disk space."
          else
            ohai "This operation has freed approximately #{disk_space} of disk space."
          end
        end

        return if cleanup.unremovable_kegs.empty?

        ofail <<~EOS
          Could not cleanup old kegs! Fix your permissions on:
            #{cleanup.unremovable_kegs.join "\n  "}
        EOS
      end
    end
  end
end