Port Homebrew::DevCmd::Edit
This commit is contained in:
Douglas Eichelberger
parent
21c84553cf
commit
2cc70549d8
@ -1,133 +1,133 @@
|
|||||||
# typed: strict
|
# typed: strict
|
||||||
# frozen_string_literal: true
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
require "abstract_command"
|
||||||
require "formula"
|
require "formula"
|
||||||
require "cli/parser"
|
require "cli/parser"
|
||||||
|
|
||||||
module Homebrew
|
module Homebrew
|
||||||
module_function
|
module DevCmd
|
||||||
|
class Edit < AbstractCommand
|
||||||
|
cmd_args do
|
||||||
|
description <<~EOS
|
||||||
|
Open a <formula>, <cask> or <tap> in the editor set by `EDITOR` or `HOMEBREW_EDITOR`,
|
||||||
|
or open the Homebrew repository for editing if no argument is provided.
|
||||||
|
EOS
|
||||||
|
|
||||||
sig { returns(CLI::Parser) }
|
switch "--formula", "--formulae",
|
||||||
def edit_args
|
description: "Treat all named arguments as formulae."
|
||||||
Homebrew::CLI::Parser.new do
|
switch "--cask", "--casks",
|
||||||
description <<~EOS
|
description: "Treat all named arguments as casks."
|
||||||
Open a <formula>, <cask> or <tap> in the editor set by `EDITOR` or `HOMEBREW_EDITOR`,
|
switch "--print-path",
|
||||||
or open the Homebrew repository for editing if no argument is provided.
|
description: "Print the file path to be edited, without opening an editor."
|
||||||
EOS
|
|
||||||
|
|
||||||
switch "--formula", "--formulae",
|
conflicts "--formula", "--cask"
|
||||||
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, :tap], without_api: true
|
||||||
|
|
||||||
named_args [:formula, :cask, :tap], without_api: true
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
sig { params(path: Pathname).returns(T::Boolean) }
|
|
||||||
def core_formula_path?(path)
|
|
||||||
path.fnmatch?("**/homebrew-core/Formula/**.rb", File::FNM_DOTMATCH)
|
|
||||||
end
|
|
||||||
|
|
||||||
sig { params(path: Pathname).returns(T::Boolean) }
|
|
||||||
def core_cask_path?(path)
|
|
||||||
path.fnmatch?("**/homebrew-cask/Casks/**.rb", File::FNM_DOTMATCH)
|
|
||||||
end
|
|
||||||
|
|
||||||
sig { params(path: Pathname).returns(T::Boolean) }
|
|
||||||
def core_formula_tap?(path)
|
|
||||||
path == CoreTap.instance.path
|
|
||||||
end
|
|
||||||
|
|
||||||
sig { params(path: Pathname).returns(T::Boolean) }
|
|
||||||
def core_cask_tap?(path)
|
|
||||||
path == CoreCaskTap.instance.path
|
|
||||||
end
|
|
||||||
|
|
||||||
sig { params(path: Pathname, cask: T::Boolean).returns(T.noreturn) }
|
|
||||||
def raise_with_message!(path, cask)
|
|
||||||
name = path.basename(".rb").to_s
|
|
||||||
|
|
||||||
if (tap_match = Regexp.new("#{HOMEBREW_TAP_DIR_REGEX.source}$").match(path.to_s))
|
|
||||||
raise TapUnavailableError, CoreTap.instance.name if core_formula_tap?(path)
|
|
||||||
raise TapUnavailableError, CoreCaskTap.instance.name if core_cask_tap?(path)
|
|
||||||
|
|
||||||
raise TapUnavailableError, "#{tap_match[:user]}/#{tap_match[:repo]}"
|
|
||||||
elsif cask || core_cask_path?(path)
|
|
||||||
if !CoreCaskTap.instance.installed? && Homebrew::API::Cask.all_casks.key?(name)
|
|
||||||
command = "brew tap --force #{CoreCaskTap.instance.name}"
|
|
||||||
action = "tap #{CoreCaskTap.instance.name}"
|
|
||||||
else
|
|
||||||
command = "brew create --cask --set-name #{name} $URL"
|
|
||||||
action = "create a new cask"
|
|
||||||
end
|
|
||||||
elsif core_formula_path?(path) &&
|
|
||||||
!CoreTap.instance.installed? &&
|
|
||||||
Homebrew::API::Formula.all_formulae.key?(name)
|
|
||||||
command = "brew tap --force #{CoreTap.instance.name}"
|
|
||||||
action = "tap #{CoreTap.instance.name}"
|
|
||||||
else
|
|
||||||
command = "brew create --set-name #{name} $URL"
|
|
||||||
action = "create a new formula"
|
|
||||||
end
|
|
||||||
|
|
||||||
raise UsageError, <<~EOS
|
|
||||||
#{name} doesn't exist on disk.
|
|
||||||
Run #{Formatter.identifier(command)} to #{action}!
|
|
||||||
EOS
|
|
||||||
end
|
|
||||||
|
|
||||||
sig { void }
|
|
||||||
def edit
|
|
||||||
args = edit_args.parse
|
|
||||||
|
|
||||||
ENV["COLORTERM"] = ENV.fetch("HOMEBREW_COLORTERM", nil)
|
|
||||||
|
|
||||||
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
|
|
||||||
expanded_paths = args.named.to_paths
|
|
||||||
expanded_paths.each do |path|
|
|
||||||
raise_with_message!(path, args.cask?) unless path.exist?
|
|
||||||
end
|
end
|
||||||
|
|
||||||
if expanded_paths.any? do |path|
|
sig { override.void }
|
||||||
(core_formula_path?(path) || core_cask_path?(path) || core_formula_tap?(path) || core_cask_tap?(path)) &&
|
def run
|
||||||
!Homebrew::EnvConfig.no_install_from_api? &&
|
ENV["COLORTERM"] = ENV.fetch("HOMEBREW_COLORTERM", nil)
|
||||||
!Homebrew::EnvConfig.no_env_hints?
|
|
||||||
end
|
unless (HOMEBREW_REPOSITORY/".git").directory?
|
||||||
opoo <<~EOS
|
odie <<~EOS
|
||||||
`brew install` ignores locally edited casks and formulae if
|
Changes will be lost!
|
||||||
HOMEBREW_NO_INSTALL_FROM_API is not set.
|
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
|
||||||
|
expanded_paths = args.named.to_paths
|
||||||
|
expanded_paths.each do |path|
|
||||||
|
raise_with_message!(path, args.cask?) unless path.exist?
|
||||||
|
end
|
||||||
|
|
||||||
|
if expanded_paths.any? do |path|
|
||||||
|
!Homebrew::EnvConfig.no_install_from_api? &&
|
||||||
|
!Homebrew::EnvConfig.no_env_hints? &&
|
||||||
|
(core_formula_path?(path) || core_cask_path?(path) || core_formula_tap?(path) || core_cask_tap?(path))
|
||||||
|
end
|
||||||
|
opoo <<~EOS
|
||||||
|
`brew install` ignores locally edited casks and formulae if
|
||||||
|
HOMEBREW_NO_INSTALL_FROM_API is not set.
|
||||||
|
EOS
|
||||||
|
end
|
||||||
|
expanded_paths
|
||||||
|
end
|
||||||
|
|
||||||
|
if args.print_path?
|
||||||
|
paths.each { puts _1 }
|
||||||
|
return
|
||||||
|
end
|
||||||
|
|
||||||
|
exec_editor(*paths)
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
sig { params(path: Pathname).returns(T::Boolean) }
|
||||||
|
def core_formula_path?(path)
|
||||||
|
path.fnmatch?("**/homebrew-core/Formula/**.rb", File::FNM_DOTMATCH)
|
||||||
|
end
|
||||||
|
|
||||||
|
sig { params(path: Pathname).returns(T::Boolean) }
|
||||||
|
def core_cask_path?(path)
|
||||||
|
path.fnmatch?("**/homebrew-cask/Casks/**.rb", File::FNM_DOTMATCH)
|
||||||
|
end
|
||||||
|
|
||||||
|
sig { params(path: Pathname).returns(T::Boolean) }
|
||||||
|
def core_formula_tap?(path)
|
||||||
|
path == CoreTap.instance.path
|
||||||
|
end
|
||||||
|
|
||||||
|
sig { params(path: Pathname).returns(T::Boolean) }
|
||||||
|
def core_cask_tap?(path)
|
||||||
|
path == CoreCaskTap.instance.path
|
||||||
|
end
|
||||||
|
|
||||||
|
sig { params(path: Pathname, cask: T::Boolean).returns(T.noreturn) }
|
||||||
|
def raise_with_message!(path, cask)
|
||||||
|
name = path.basename(".rb").to_s
|
||||||
|
|
||||||
|
if (tap_match = Regexp.new("#{HOMEBREW_TAP_DIR_REGEX.source}$").match(path.to_s))
|
||||||
|
raise TapUnavailableError, CoreTap.instance.name if core_formula_tap?(path)
|
||||||
|
raise TapUnavailableError, CoreCaskTap.instance.name if core_cask_tap?(path)
|
||||||
|
|
||||||
|
raise TapUnavailableError, "#{tap_match[:user]}/#{tap_match[:repo]}"
|
||||||
|
elsif cask || core_cask_path?(path)
|
||||||
|
if !CoreCaskTap.instance.installed? && Homebrew::API::Cask.all_casks.key?(name)
|
||||||
|
command = "brew tap --force #{CoreCaskTap.instance.name}"
|
||||||
|
action = "tap #{CoreCaskTap.instance.name}"
|
||||||
|
else
|
||||||
|
command = "brew create --cask --set-name #{name} $URL"
|
||||||
|
action = "create a new cask"
|
||||||
|
end
|
||||||
|
elsif core_formula_path?(path) &&
|
||||||
|
!CoreTap.instance.installed? &&
|
||||||
|
Homebrew::API::Formula.all_formulae.key?(name)
|
||||||
|
command = "brew tap --force #{CoreTap.instance.name}"
|
||||||
|
action = "tap #{CoreTap.instance.name}"
|
||||||
|
else
|
||||||
|
command = "brew create --set-name #{name} $URL"
|
||||||
|
action = "create a new formula"
|
||||||
|
end
|
||||||
|
|
||||||
|
raise UsageError, <<~EOS
|
||||||
|
#{name} doesn't exist on disk.
|
||||||
|
Run #{Formatter.identifier(command)} to #{action}!
|
||||||
EOS
|
EOS
|
||||||
end
|
end
|
||||||
expanded_paths
|
|
||||||
end
|
end
|
||||||
|
|
||||||
if args.print_path?
|
|
||||||
paths.each(&method(:puts))
|
|
||||||
return
|
|
||||||
end
|
|
||||||
|
|
||||||
exec_editor(*paths)
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@ -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 "dev-cmd/edit"
|
||||||
|
|
||||||
RSpec.describe "brew edit" do
|
RSpec.describe Homebrew::DevCmd::Edit do
|
||||||
it_behaves_like "parseable arguments"
|
it_behaves_like "parseable arguments"
|
||||||
|
|
||||||
it "opens a given Formula in an editor", :integration_test do
|
it "opens a given Formula in an editor", :integration_test do
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user