aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Vandenberg2010-10-21 07:51:47 -0700
committerAdam Vandenberg2010-10-21 07:53:37 -0700
commitae9b3ef59f406c8330c2621e5355c75694723f35 (patch)
treea2d95593c8a3918b5d33513a60a6cadae50c8aac
parente9ae9a37e5e22f67aa7e5089a4e396053af6e6da (diff)
downloadhomebrew-ae9b3ef59f406c8330c2621e5355c75694723f35.tar.bz2
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.
-rwxr-xr-xLibrary/Contributions/examples/brew-audit.rb8
-rw-r--r--Library/Contributions/manpages/brew.1.md5
-rw-r--r--share/man/man1/brew.15
3 files changed, 15 insertions, 3 deletions
diff --git a/Library/Contributions/examples/brew-audit.rb b/Library/Contributions/examples/brew-audit.rb
index 54d53d903..7b527f59b 100755
--- a/Library/Contributions/examples/brew-audit.rb
+++ b/Library/Contributions/examples/brew-audit.rb
@@ -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
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md
index d595cc4f8..5751f7d00 100644
--- a/Library/Contributions/manpages/brew.1.md
+++ b/Library/Contributions/manpages/brew.1.md
@@ -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>.
diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1
index ff3e5eee5..203ec4244 100644
--- a/share/man/man1/brew.1
+++ b/share/man/man1/brew.1
@@ -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\.