brew/Library/Homebrew/dev-cmd/edit.rb

# typed: strict
# frozen_string_literal: true

require "formula"
require "cli/parser"

module Homebrew
  module_function

  sig { returns(CLI::Parser) }
  def edit_args
    Homebrew::CLI::Parser.new do
      description <<~EOS
        Open a <formula> or <cask> in the editor set by `EDITOR` or `HOMEBREW_EDITOR`,
        or open the Homebrew repository for editing if no formula is provided.
      EOS

      switch "--formula", "--formulae",
             description: "Treat all named arguments as formulae."
      switch "--cask", "--casks",
             description: "Treat all named arguments as casks."
      switch "--print-path",
             description: "Print the file path to be edited, without opening an editor."

      conflicts "--formula", "--cask"

      named_args [:formula, :cask], without_api: true
    end
  end

  sig { void }
  def edit
    args = edit_args.parse

    unless (HOMEBREW_REPOSITORY/".git").directory?
      odie <<~EOS
        Changes will be lost!
        The first time you `brew update`, all local changes will be lost; you should
        thus `brew update` before you `brew edit`!
      EOS
    end

    paths = if args.named.empty?
      # Sublime requires opting into the project editing path,
      # as opposed to VS Code which will infer from the .vscode path
      if which_editor(silent: true) == "subl"
        ["--project", "#{HOMEBREW_REPOSITORY}/.sublime/homebrew.sublime-project"]
      else
        # If no formulae are listed, open the project root in an editor.
        [HOMEBREW_REPOSITORY]
      end
    else
      args.named.to_paths.select do |path|
        next path if path.exist?

        not_exist_message = if args.cask?
          "#{path.basename(".rb")} doesn't exist on disk."
        else
          "#{path} doesn't exist on disk."
        end

        message = if args.cask?
          <<~EOS
            #{not_exist_message}
            Run #{Formatter.identifier("brew create --cask --set-name #{path.basename(".rb")} $URL")} \
            to create a new cask!
          EOS
        else
          <<~EOS
            #{not_exist_message}
            Run #{Formatter.identifier("brew create --set-name #{path.basename} $URL")} \
            to create a new formula!
          EOS
        end
        raise UsageError, message
      end.presence
    end

    if !Homebrew::EnvConfig.no_install_from_api? && !Homebrew::EnvConfig.no_env_hints?
      paths.each do |path|
        next if !path.fnmatch?("**/homebrew-core/Formula/*.rb") && !path.fnmatch?("**/homebrew-cask/Casks/*.rb")

        opoo <<~EOS
          Unless `HOMEBREW_NO_INSTALL_FROM_API` is set when running
          `brew install`, it will ignore your locally edited formula.
        EOS
        break
      end
    end

    if args.print_path?
      paths.each(&method(:puts))
      return
    end

    exec_editor(*paths)
  end
end