Port Homebrew::DevCmd::StyleCmd
This commit is contained in:
parent
1436b06e90
commit
0d04f198d2
@ -1,75 +1,74 @@
|
|||||||
# typed: true
|
# typed: strict
|
||||||
# frozen_string_literal: true
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
require "abstract_command"
|
||||||
require "json"
|
require "json"
|
||||||
require "open3"
|
require "open3"
|
||||||
require "style"
|
require "style"
|
||||||
require "cli/parser"
|
require "cli/parser"
|
||||||
|
|
||||||
module Homebrew
|
module Homebrew
|
||||||
module_function
|
module DevCmd
|
||||||
|
class StyleCmd < AbstractCommand
|
||||||
|
cmd_args do
|
||||||
|
description <<~EOS
|
||||||
|
Check formulae or files for conformance to Homebrew style guidelines.
|
||||||
|
|
||||||
sig { returns(CLI::Parser) }
|
Lists of <file>, <tap> and <formula> may not be combined. If none are
|
||||||
def style_args
|
provided, `style` will run style checks on the whole Homebrew library,
|
||||||
Homebrew::CLI::Parser.new do
|
including core code and all formulae.
|
||||||
description <<~EOS
|
EOS
|
||||||
Check formulae or files for conformance to Homebrew style guidelines.
|
switch "--fix",
|
||||||
|
description: "Fix style violations automatically using RuboCop's auto-correct feature."
|
||||||
|
switch "--display-cop-names",
|
||||||
|
description: "Include the RuboCop cop name for each violation in the output.",
|
||||||
|
hidden: true
|
||||||
|
switch "--reset-cache",
|
||||||
|
description: "Reset the RuboCop cache."
|
||||||
|
switch "--formula", "--formulae",
|
||||||
|
description: "Treat all named arguments as formulae."
|
||||||
|
switch "--cask", "--casks",
|
||||||
|
description: "Treat all named arguments as casks."
|
||||||
|
comma_array "--only-cops",
|
||||||
|
description: "Specify a comma-separated <cops> list to check for violations of only the " \
|
||||||
|
"listed RuboCop cops."
|
||||||
|
comma_array "--except-cops",
|
||||||
|
description: "Specify a comma-separated <cops> list to skip checking for violations of the " \
|
||||||
|
"listed RuboCop cops."
|
||||||
|
|
||||||
Lists of <file>, <tap> and <formula> may not be combined. If none are
|
conflicts "--formula", "--cask"
|
||||||
provided, `style` will run style checks on the whole Homebrew library,
|
conflicts "--only-cops", "--except-cops"
|
||||||
including core code and all formulae.
|
|
||||||
EOS
|
|
||||||
switch "--fix",
|
|
||||||
description: "Fix style violations automatically using RuboCop's auto-correct feature."
|
|
||||||
switch "--display-cop-names",
|
|
||||||
description: "Include the RuboCop cop name for each violation in the output.",
|
|
||||||
hidden: true
|
|
||||||
switch "--reset-cache",
|
|
||||||
description: "Reset the RuboCop cache."
|
|
||||||
switch "--formula", "--formulae",
|
|
||||||
description: "Treat all named arguments as formulae."
|
|
||||||
switch "--cask", "--casks",
|
|
||||||
description: "Treat all named arguments as casks."
|
|
||||||
comma_array "--only-cops",
|
|
||||||
description: "Specify a comma-separated <cops> list to check for violations of only the " \
|
|
||||||
"listed RuboCop cops."
|
|
||||||
comma_array "--except-cops",
|
|
||||||
description: "Specify a comma-separated <cops> list to skip checking for violations of the " \
|
|
||||||
"listed RuboCop cops."
|
|
||||||
|
|
||||||
conflicts "--formula", "--cask"
|
named_args [:file, :tap, :formula, :cask], without_api: true
|
||||||
conflicts "--only-cops", "--except-cops"
|
end
|
||||||
|
|
||||||
named_args [:file, :tap, :formula, :cask], without_api: true
|
sig { override.void }
|
||||||
|
def run
|
||||||
|
target = if args.no_named?
|
||||||
|
nil
|
||||||
|
else
|
||||||
|
args.named.to_paths
|
||||||
|
end
|
||||||
|
|
||||||
|
only_cops = args.only_cops
|
||||||
|
except_cops = args.except_cops
|
||||||
|
|
||||||
|
options = {
|
||||||
|
fix: args.fix?,
|
||||||
|
reset_cache: args.reset_cache?,
|
||||||
|
debug: args.debug?,
|
||||||
|
verbose: args.verbose?,
|
||||||
|
}
|
||||||
|
if only_cops
|
||||||
|
options[:only_cops] = only_cops
|
||||||
|
elsif except_cops
|
||||||
|
options[:except_cops] = except_cops
|
||||||
|
else
|
||||||
|
options[:except_cops] = %w[FormulaAuditStrict]
|
||||||
|
end
|
||||||
|
|
||||||
|
Homebrew.failed = !Style.check_style_and_print(target, **options)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def style
|
|
||||||
args = style_args.parse
|
|
||||||
|
|
||||||
target = if args.no_named?
|
|
||||||
nil
|
|
||||||
else
|
|
||||||
args.named.to_paths
|
|
||||||
end
|
|
||||||
|
|
||||||
only_cops = args.only_cops
|
|
||||||
except_cops = args.except_cops
|
|
||||||
|
|
||||||
options = {
|
|
||||||
fix: args.fix?,
|
|
||||||
reset_cache: args.reset_cache?,
|
|
||||||
debug: args.debug?,
|
|
||||||
verbose: args.verbose?,
|
|
||||||
}
|
|
||||||
if only_cops
|
|
||||||
options[:only_cops] = only_cops
|
|
||||||
elsif except_cops
|
|
||||||
options[:except_cops] = except_cops
|
|
||||||
else
|
|
||||||
options[:except_cops] = %w[FormulaAuditStrict]
|
|
||||||
end
|
|
||||||
|
|
||||||
Homebrew.failed = !Style.check_style_and_print(target, **options)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@ -1,7 +1,8 @@
|
|||||||
# frozen_string_literal: true
|
# frozen_string_literal: true
|
||||||
|
|
||||||
require "cmd/shared_examples/args_parse"
|
require "cmd/shared_examples/args_parse"
|
||||||
|
require "dev-cmd/style"
|
||||||
|
|
||||||
RSpec.describe "brew style" do
|
RSpec.describe Homebrew::DevCmd::StyleCmd do
|
||||||
it_behaves_like "parseable arguments"
|
it_behaves_like "parseable arguments"
|
||||||
end
|
end
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user