Module: Homebrew::Style

Defined in:
brew/Library/Homebrew/style.rb

Defined Under Namespace

Classes: RubocopLineLocation, RubocopOffense, RubocopResults

Class Method Summary collapse

Class Method Details

.check_style_and_print(files, options = {}) ⇒ Object

Checks style for a list of files, printing simple RuboCop output. Returns true if violations were found, false otherwise.



9
10
11
# File 'brew/Library/Homebrew/style.rb', line 9

def check_style_and_print(files, options = {})
  check_style_impl(files, :print, options)
end

.check_style_impl(files, output_type, options = {}) ⇒ Object



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'brew/Library/Homebrew/style.rb', line 19

def check_style_impl(files, output_type, options = {})
  fix = options[:fix]

  Homebrew.install_bundler_gems!
  require "rubocop"
  require "rubocops"

  args = %w[
    --force-exclusion
  ]
  if fix
    args << "--auto-correct"
  else
    args << "--parallel"
  end

  args += ["--extra-details", "--display-cop-names"] if ARGV.verbose?

  if options[:except_cops]
    options[:except_cops].map! { |cop| RuboCop::Cop::Cop.registry.qualified_cop_name(cop.to_s, "") }
    cops_to_exclude = options[:except_cops].select do |cop|
      RuboCop::Cop::Cop.registry.names.include?(cop) ||
        RuboCop::Cop::Cop.registry.departments.include?(cop.to_sym)
    end

    args << "--except" << cops_to_exclude.join(",") unless cops_to_exclude.empty?
  elsif options[:only_cops]
    options[:only_cops].map! { |cop| RuboCop::Cop::Cop.registry.qualified_cop_name(cop.to_s, "") }
    cops_to_include = options[:only_cops].select do |cop|
      RuboCop::Cop::Cop.registry.names.include?(cop) ||
        RuboCop::Cop::Cop.registry.departments.include?(cop.to_sym)
    end

    odie "RuboCops #{options[:only_cops].join(",")} were not found" if cops_to_include.empty?

    args << "--only" << cops_to_include.join(",")
  end

  has_non_formula = Array(files).any? do |file|
    File.expand_path(file).start_with? HOMEBREW_LIBRARY_PATH
  end

  if files && !has_non_formula
    config = if files.first && File.exist?("#{files.first}/spec")
      HOMEBREW_LIBRARY/".rubocop_rspec.yml"
    else
      HOMEBREW_LIBRARY/".rubocop_audit.yml"
    end
    args << "--config" << config
  end

  if files.nil?
    args << HOMEBREW_LIBRARY_PATH
  else
    args += files
  end

  cache_env = { "XDG_CACHE_HOME" => "#{HOMEBREW_CACHE}/style" }

  rubocop_success = false

  case output_type
  when :print
    args << "--debug" if ARGV.debug?
    args << "--display-cop-names" if ARGV.include? "--display-cop-names"
    args << "--format" << "simple" if files
    system(cache_env, "rubocop", *args)
    rubocop_success = $CHILD_STATUS.success?
  when :json
    json, err, status =
      Open3.capture3(cache_env, "rubocop",
                     "--format", "json", *args)
    # exit status of 1 just means violations were found; other numbers mean
    # execution errors.
    # exitstatus can also be nil if RuboCop process crashes, e.g. due to
    # native extension problems.
    # JSON needs to be at least 2 characters.
    if !(0..1).cover?(status.exitstatus) || json.to_s.length < 2
      raise "Error running `rubocop --format json #{args.join " "}`\n#{err}"
    end

    return RubocopResults.new(JSON.parse(json))
  else
    raise "Invalid output_type for check_style_impl: #{output_type}"
  end

  return !rubocop_success if files.present? || !has_non_formula

  shellcheck   = which("shellcheck")
  shellcheck ||= which("shellcheck", ENV["HOMEBREW_PATH"])
  shellcheck ||= begin
    ohai "Installing `shellcheck` for shell style checks..."
    system HOMEBREW_BREW_FILE, "install", "shellcheck"
    which("shellcheck") || which("shellcheck", ENV["HOMEBREW_PATH"])
  end
  unless shellcheck
    opoo "Could not find or install `shellcheck`! Not checking shell style."
    return !rubocop_success
  end

  shell_files = [
    HOMEBREW_BREW_FILE,
    *Pathname.glob("#{HOMEBREW_LIBRARY}/Homebrew/*.sh"),
    *Pathname.glob("#{HOMEBREW_LIBRARY}/Homebrew/cmd/*.sh"),
    *Pathname.glob("#{HOMEBREW_LIBRARY}/Homebrew/utils/*.sh"),
  ].select(&:exist?)
  # TODO: check, fix completions here too.
  # TODO: consider using ShellCheck JSON output
  shellcheck_success = system shellcheck, "--shell=bash", *shell_files
  !rubocop_success || !shellcheck_success
end

.check_style_json(files, options = {}) ⇒ Object

Checks style for a list of files, returning results as a RubocopResults object parsed from its JSON output.



15
16
17
# File 'brew/Library/Homebrew/style.rb', line 15

def check_style_json(files, options = {})
  check_style_impl(files, :json, options)
end