admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

brew audit: add --display-filename format option for easy grepping (#221)

Browse Source
This commit is contained in:
Andrew Janke 2016-05-11 09:19:45 -07:00
parent 5f06312916
commit 63ea9295cf
3 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Library/Homebrew/cmd/audit.rb
View File

@ -1,4 +1,4 @@
#: * `audit` [`--strict`] [`--online`] [`--display-cop-names`] [<formulae>]: #: * `audit` [`--strict`] [`--online`] [`--display-cop-names`] [`--display-filename`] [<formulae>]:
#: Check <formulae> for Homebrew coding style violations. This should be #: Check <formulae> for Homebrew coding style violations. This should be
#: run before submitting a new formula. #: run before submitting a new formula.
#: #:
@ -13,6 +13,9 @@
#: If `--display-cop-names` is passed, the RuboCop cop name for each violation #: If `--display-cop-names` is passed, the RuboCop cop name for each violation
#: is included in the output. #: is included in the output.
#: #:
#: If `--display-filename` is passed, every line of output is prefixed with the
#: name of the file or formula being audited, to make the output easy to grep.
#:
#: `audit` exits with a non-zero status if any errors are found. This is useful, #: `audit` exits with a non-zero status if any errors are found. This is useful,
#: for instance, for implementing pre-commit hooks. #: for instance, for implementing pre-commit hooks.
@ -69,8 +72,12 @@ module Homebrew
formula_count += 1 formula_count += 1
problem_count += fa.problems.size problem_count += fa.problems.size
problem_lines = fa.problems.map { |p| " * #{p.chomp.gsub("\n", "\n ")}" } problem_lines = fa.problems.map { |p| "* #{p.chomp.gsub("\n", "\n ")}" }
puts "#{f.full_name}:", problem_lines if ARGV.include? "--display-filename"
puts problem_lines.map { |s| "#{f.path}: #{s}"}
else
puts "#{f.full_name}:", problem_lines.map { |s| " #{s}"}
end
end end
unless problem_count.zero? unless problem_count.zero?

5
share/doc/homebrew/brew.1.html
View File

@ -39,7 +39,7 @@ If no search term is given, all locally available formulae are listed.</p></dd>
Read more at <a href="https://git.io/brew-analytics" data-bare-link="true">https://git.io/brew-analytics</a>.</p></dd> Read more at <a href="https://git.io/brew-analytics" data-bare-link="true">https://git.io/brew-analytics</a>.</p></dd>
<dt><code>analytics</code> (<code>on</code>|<code>off</code>)</dt><dd><p>Turn on/off Homebrew's analytics.</p></dd> <dt><code>analytics</code> (<code>on</code>|<code>off</code>)</dt><dd><p>Turn on/off Homebrew's analytics.</p></dd>
<dt><code>analytics</code> <code>regenerate-uuid</code></dt><dd><p>Regenerate UUID used in Homebrew's analytics.</p></dd> <dt><code>analytics</code> <code>regenerate-uuid</code></dt><dd><p>Regenerate UUID used in Homebrew's analytics.</p></dd>
<dt><code>audit</code> [<code>--strict</code>] [<code>--online</code>] [<code>--display-cop-names</code>] [<var>formulae</var>]</dt><dd><p>Check <var>formulae</var> for Homebrew coding style violations. This should be <dt><code>audit</code> [<code>--strict</code>] [<code>--online</code>] [<code>--display-cop-names</code>] [<code>--display-filename</code>] [<var>formulae</var>]</dt><dd><p>Check <var>formulae</var> for Homebrew coding style violations. This should be
run before submitting a new formula.</p> run before submitting a new formula.</p>
<p>If no <var>formulae</var> are provided, all of them are checked.</p> <p>If no <var>formulae</var> are provided, all of them are checked.</p>
@ -53,6 +53,9 @@ connection are run. This should be used when creating for new formulae.</p>
<p>If <code>--display-cop-names</code> is passed, the RuboCop cop name for each violation <p>If <code>--display-cop-names</code> is passed, the RuboCop cop name for each violation
is included in the output.</p> is included in the output.</p>
<p>If <code>--display-filename</code> is passed, every line of output is prefixed with the
name of the file or formula being audited, to make the output easy to grep.</p>
<p><code>audit</code> exits with a non-zero status if any errors are found. This is useful, <p><code>audit</code> exits with a non-zero status if any errors are found. This is useful,
for instance, for implementing pre-commit hooks.</p></dd> for instance, for implementing pre-commit hooks.</p></dd>
<dt><code>cat</code> <var>formula</var></dt><dd><p>Display the source to <var>formula</var>.</p></dd> <dt><code>cat</code> <var>formula</var></dt><dd><p>Display the source to <var>formula</var>.</p></dd>

5
share/man/man1/brew.1
View File

@ -56,7 +56,7 @@ Turn on/off Homebrew\'s analytics\.
Regenerate UUID used in Homebrew\'s analytics\. Regenerate UUID used in Homebrew\'s analytics\.
. .
.TP .TP
\fBaudit\fR [\fB\-\-strict\fR] [\fB\-\-online\fR] [\fB\-\-display\-cop\-names\fR] [\fIformulae\fR] \fBaudit\fR [\fB\-\-strict\fR] [\fB\-\-online\fR] [\fB\-\-display\-cop\-names\fR] [\fB\-\-display\-filename\fR] [\fIformulae\fR]
Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\.
. .
.IP .IP
@ -72,6 +72,9 @@ If \fB\-\-online\fR is passed, additional slower checks that require a network c
If \fB\-\-display\-cop\-names\fR is passed, the RuboCop cop name for each violation is included in the output\. If \fB\-\-display\-cop\-names\fR is passed, the RuboCop cop name for each violation is included in the output\.
. .
.IP .IP
If \fB\-\-display\-filename\fR is passed, every line of output is prefixed with the name of the file or formula being audited, to make the output easy to grep\.
.
.IP
\fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\. \fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\.
. .
.TP .TP