Module: Homebrew::Style Private
- Defined in:
- style.rb
Overview
This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.
Helper module for running RuboCop.
Defined Under Namespace
Classes: LineLocation, Offense, Offenses
Constant Summary collapse
- RUBOCOP =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
(HOMEBREW_LIBRARY_PATH/"utils/rubocop.rb").freeze
Class Method Summary collapse
-
.check_style_and_print(files, **options) ⇒ Object
private
Checks style for a list of files, printing simple RuboCop output.
-
.check_style_impl(files, output_type, fix: false, except_cops: nil, only_cops: nil, display_cop_names: false, reset_cache: false, debug: false, verbose: false) ⇒ Object
private
-
.check_style_json(files, **options) ⇒ Object
private
Checks style for a list of files, returning results as an Offenses object parsed from its JSON output.
-
.json_result!(result) ⇒ Object
private
-
.run_rubocop(files, output_type, fix: false, except_cops: nil, only_cops: nil, display_cop_names: false, reset_cache: false, debug: false, verbose: false) ⇒ Object
private
-
.run_shellcheck(files, output_type, fix: false) ⇒ Object
private
-
.run_shfmt(files, fix: false) ⇒ Object
private
-
.shell_scripts ⇒ Object
private
-
.shellcheck ⇒ Object
private
-
.shfmt ⇒ Object
private
Class Method Details
.check_style_and_print(files, **options) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Checks style for a list of files, printing simple RuboCop output. Returns true if violations were found, false otherwise.
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# File 'style.rb', line 15 def check_style_and_print(files, **) success = check_style_impl(files, :print, **) if ENV["GITHUB_ACTIONS"] && !success check_style_json(files, **).each do |path, offenses| offenses.each do |o| line = o.location.line column = o.location.line annotation = GitHub::Actions::Annotation.new(:error, o., file: path, line: line, column: column) puts annotation if annotation.relevant? end end end success end |
.check_style_impl(files, output_type, fix: false, except_cops: nil, only_cops: nil, display_cop_names: false, reset_cache: false, debug: false, verbose: false) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
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 |
# File 'style.rb', line 39 def check_style_impl(files, output_type, fix: false, except_cops: nil, only_cops: nil, display_cop_names: false, reset_cache: false, debug: false, verbose: false) raise ArgumentError, "Invalid output type: #{output_type.inspect}" if [:print, :json].exclude?(output_type) shell_files, ruby_files = Array(files).map(&method(:Pathname)) .partition { |f| f.realpath == HOMEBREW_BREW_FILE.realpath || f.extname == ".sh" } rubocop_result = if shell_files.any? && ruby_files.none? (output_type == :json) ? [] : true else run_rubocop(ruby_files, output_type, fix: fix, except_cops: except_cops, only_cops: only_cops, display_cop_names: display_cop_names, reset_cache: reset_cache, debug: debug, verbose: verbose) end shellcheck_result = if ruby_files.any? && shell_files.none? (output_type == :json) ? [] : true else run_shellcheck(shell_files, output_type, fix: fix) end shfmt_result = if ruby_files.any? && shell_files.none? true else run_shfmt(shell_files, fix: fix) end if output_type == :json Offenses.new(rubocop_result + shellcheck_result) else rubocop_result && shellcheck_result && shfmt_result end end |
.check_style_json(files, **options) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Checks style for a list of files, returning results as an Offenses object parsed from its JSON output.
35 36 37 |
# File 'style.rb', line 35 def check_style_json(files, **) check_style_impl(files, :json, **) end |
.json_result!(result) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
251 252 253 254 255 256 257 258 |
# File 'style.rb', line 251 def json_result!(result) # An exit status of 1 just means violations were found; other numbers mean # execution errors. # JSON needs to be at least 2 characters. result.assert_success! if !(0..1).cover?(result.status.exitstatus) || result.stdout.length < 2 JSON.parse(result.stdout) end |
.run_rubocop(files, output_type, fix: false, except_cops: nil, only_cops: nil, display_cop_names: false, reset_cache: false, debug: false, verbose: false) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'style.rb', line 83 def run_rubocop(files, output_type, fix: false, except_cops: nil, only_cops: nil, display_cop_names: false, reset_cache: false, debug: false, verbose: false) Homebrew.install_bundler_gems! require "warnings" Warnings.ignore :parser_syntax do require "rubocop" end require "rubocops/all" args = %w[ --force-exclusion ] args << if fix "--autocorrect-all" else "--parallel" end args += ["--extra-details"] if verbose args += ["--display-cop-names"] if display_cop_names || verbose if except_cops except_cops.map! { |cop| RuboCop::Cop::Cop.registry.qualified_cop_name(cop.to_s, "") } cops_to_exclude = 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 only_cops only_cops.map! { |cop| RuboCop::Cop::Cop.registry.qualified_cop_name(cop.to_s, "") } cops_to_include = only_cops.select do |cop| RuboCop::Cop::Cop.registry.names.include?(cop) || RuboCop::Cop::Cop.registry.departments.include?(cop.to_sym) end odie "RuboCops #{only_cops.join(",")} were not found" if cops_to_include.empty? args << "--only" << cops_to_include.join(",") end files&.map!(&:expand_path) if files.blank? || files == [HOMEBREW_REPOSITORY] files = [HOMEBREW_LIBRARY_PATH] elsif files.none? { |f| f.to_s.start_with? HOMEBREW_LIBRARY_PATH } config = if files.any? { |f| (f/"spec").exist? } HOMEBREW_LIBRARY/".rubocop_rspec.yml" else HOMEBREW_LIBRARY/".rubocop.yml" end args << "--config" << config end args += files cache_env = { "XDG_CACHE_HOME" => "#{HOMEBREW_CACHE}/style" } FileUtils.rm_rf cache_env["XDG_CACHE_HOME"] if reset_cache ruby_args = HOMEBREW_RUBY_EXEC_ARGS.dup case output_type when :print args << "--debug" if debug # Don't show the default formatter's progress dots # on CI or if only checking a single file. args << "--format" << "clang" if ENV["CI"] || files.count { |f| !f.directory? } == 1 args << "--color" if Tty.color? system cache_env, *ruby_args, "--", RUBOCOP, *args $CHILD_STATUS.success? when :json result = system_command ruby_args.shift, args: [*ruby_args, "--", RUBOCOP, "--format", "json", *args], env: cache_env json = json_result!(result) json["files"] end end |
.run_shellcheck(files, output_type, fix: false) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'style.rb', line 168 def run_shellcheck(files, output_type, fix: false) files = shell_scripts if files.blank? files = files.map(&:realpath) # use absolute file paths args = [ "--shell=bash", "--enable=all", "--external-sources", "--source-path=#{HOMEBREW_LIBRARY}", "--", *files, ] if fix # patch options: # -g 0 (--get=0) : suppress environment variable `PATCH_GET` # -f (--force) : we know what we are doing, force apply patches # -d / (--directory=/) : change to root directory, since we use absolute file paths # -p0 (--strip=0) : do not strip path prefixes, since we are at root directory # NOTE: we use short flags where for compatibility patch_command = %w[patch -g 0 -f -d / -p0] patches = system_command(shellcheck, args: ["--format=diff", *args]).stdout Utils.safe_popen_write(*patch_command) { |p| p.write(patches) } if patches.present? end case output_type when :print system shellcheck, "--format=tty", *args $CHILD_STATUS.success? when :json result = system_command shellcheck, args: ["--format=json", *args] json = json_result!(result) # Convert to same format as RuboCop offenses. severity_hash = { "style" => "refactor", "info" => "convention" } json.group_by { |v| v["file"] } .map do |k, v| { "path" => k, "offenses" => v.map do |o| o.delete("file") o["cop_name"] = "SC#{o.delete("code")}" level = o.delete("level") o["severity"] = severity_hash.fetch(level, level) line = o.delete("line") column = o.delete("column") o["corrected"] = false o["correctable"] = o.delete("fix").present? o["location"] = { "start_line" => line, "start_column" => column, "last_line" => o.delete("endLine"), "last_column" => o.delete("endColumn"), "line" => line, "column" => column, } o end, } end end end |
.run_shfmt(files, fix: false) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'style.rb', line 238 def run_shfmt(files, fix: false) files = shell_scripts if files.blank? # Do not format completions and Dockerfile files.delete(HOMEBREW_REPOSITORY/"completions/bash/brew") files.delete(HOMEBREW_REPOSITORY/"Dockerfile") args = ["--language-dialect", "bash", "--indent", "2", "--case-indent", "--", *files] args.unshift("--write") if fix # need to add before "--" system shfmt, *args $CHILD_STATUS.success? end |
.shell_scripts ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'style.rb', line 260 def shell_scripts [ HOMEBREW_BREW_FILE, HOMEBREW_REPOSITORY/"completions/bash/brew", HOMEBREW_REPOSITORY/"Dockerfile", *HOMEBREW_REPOSITORY.glob(".devcontainer/**/*.sh"), *HOMEBREW_REPOSITORY.glob("package/scripts/*"), *HOMEBREW_LIBRARY.glob("Homebrew/**/*.sh").reject { |path| path.to_s.include?("/vendor/") }, *HOMEBREW_LIBRARY.glob("Homebrew/shims/**/*").map(&:realpath).uniq .reject(&:directory?) .reject { |path| path.basename.to_s == "cc" } .select do |path| %r{^#! ?/bin/(?:ba)?sh( |$)}.match?(path.read(13)) end, *HOMEBREW_LIBRARY.glob("Homebrew/{dev-,}cmd/*.sh"), *HOMEBREW_LIBRARY.glob("Homebrew/{cask/,}utils/*.sh"), ] end |
.shellcheck ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
279 280 281 282 |
# File 'style.rb', line 279 def shellcheck ensure_formula_installed!("shellcheck", latest: true, reason: "shell style checks").opt_bin/"shellcheck" end |
.shfmt ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
284 285 286 287 288 |
# File 'style.rb', line 284 def shfmt ensure_formula_installed!("shfmt", latest: true, reason: "formatting shell scripts") HOMEBREW_LIBRARY/"Homebrew/utils/shfmt.sh" end |