Skip to content
Snippets Groups Projects
Commit 405613a0 authored by Adam Vandenberg's avatar Adam Vandenberg
Browse files

brew-audit - add check for tabs.

Add a new mode "brew audit --warn" that performs stricter checks
that might not need to be fixed.

Currently this includes a check for using tabs instead of spaces
for indentation; Homebrew style is "2-space indentation."

Documented this new switch.
parent b82be5c8
No related branches found
No related tags found
No related merge requests found
......@@ -80,7 +80,7 @@ def audit_formula_text text
end
# No trailing whitespace, please
if text =~ /[ ]+$/
if text =~ /(\t|[ ])+$/
problems << " * Trailing whitespace was found."
end
......@@ -88,6 +88,12 @@ def audit_formula_text text
problems << " * Use \"if ARGV.build_head?\" instead"
end
if ARGV.include? "--warn"
if text =~ /^\t/
problems << " * Use spaces instead of tabs for indentation"
end
end
return problems
end
......
......@@ -188,10 +188,13 @@ to recognize `brew cmdname`.
Some external commands are shipped with Homebrew, and enabled by default.
* `audit`:
* `audit [--warn]`:
Checks all formulae for Homebrew coding style violations. This should be
run before submitting a new formula for inclusion.
If `--warn` is passed, performs additional stricter checks that may not need
to be fixed before submitting.
* `options` <formula>:
Displays install options specific to <formula>.
......
......@@ -197,9 +197,12 @@ Homebrew allows external commands to be defined by putting a +x file named \fBbr
Some external commands are shipped with Homebrew, and enabled by default\.
.
.TP
\fBaudit\fR
\fBaudit [\-\-warn]\fR
Checks all formulae for Homebrew coding style violations\. This should be run before submitting a new formula for inclusion\.
.
.IP
If \fB\-\-warn\fR is passed, performs additional stricter checks that may not need to be fixed before submitting\.
.
.TP
\fBoptions\fR \fIformula\fR
Displays install options specific to \fIformula\fR\.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment