Skip to content

Commit

Permalink
brew-audit - add check for tabs.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
adamv committed Oct 21, 2010
1 parent e9ae9a3 commit ae9b3ef
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
8 changes: 7 additions & 1 deletion Library/Contributions/examples/brew-audit.rb
Original file line number Diff line number Diff line change
Expand Up @@ -80,14 +80,20 @@ def audit_formula_text text
end

# No trailing whitespace, please
if text =~ /[ ]+$/
if text =~ /(\t|[ ])+$/
problems << " * Trailing whitespace was found."
end

if text =~ /if\s+ARGV\.include\?\s+'--HEAD'/
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

Expand Down
5 changes: 4 additions & 1 deletion Library/Contributions/manpages/brew.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>.

Expand Down
5 changes: 4 additions & 1 deletion share/man/man1/brew.1
Original file line number Diff line number Diff line change
Expand Up @@ -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\.
Expand Down

0 comments on commit ae9b3ef

Please sign in to comment.