summaryrefslogtreecommitdiffstats
path: root/PRESUBMIT.py
diff options
context:
space:
mode:
authormaruel@chromium.org <maruel@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2009-03-05 14:03:14 +0000
committermaruel@chromium.org <maruel@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2009-03-05 14:03:14 +0000
commit3347870323d0366168c1ddf11a484b30207bea05 (patch)
tree96163352e7030d90fc17d0f4ff4ae4312876e74d /PRESUBMIT.py
parentf0a51fb571f46531025fa09240bbc3e1af925e84 (diff)
downloadchromium_src-3347870323d0366168c1ddf11a484b30207bea05.zip
chromium_src-3347870323d0366168c1ddf11a484b30207bea05.tar.gz
chromium_src-3347870323d0366168c1ddf11a484b30207bea05.tar.bz2
- Add «no trailing whitespace» and <=80 cols rules.
- Remove the invalid import os statement (PRESUBMIT.py shouldn't import anything). - Add excluded paths. Mostly third parties. - Increase what is considered a source file. - Don't check for DO NOT SUBMIT on upload. Review URL: http://codereview.chromium.org/28219 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@10983 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'PRESUBMIT.py')
-rwxr-xr-xPRESUBMIT.py102
1 files changed, 73 insertions, 29 deletions
diff --git a/PRESUBMIT.py b/PRESUBMIT.py
index 1340216..e0bd7de 100755
--- a/PRESUBMIT.py
+++ b/PRESUBMIT.py
@@ -9,17 +9,24 @@ See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts for
details on the presubmit API built into gcl.
"""
-
-import os
-
-
# Files with these extensions will be considered source files
-SOURCE_FILE_EXTENSIONS = ['.c', '.cc', '.cpp', '.h', '.m', '.mm', '.py']
-
+SOURCE_FILE_EXTENSIONS = [
+ '.c', '.cc', '.cpp', '.h', '.m', '.mm', '.py', '.mk', '.am', '.json',
+]
+EXCLUDED_PATHS = [
+ r"breakpad[\\\/].*",
+ r"chrome[\\\/]Debug[\\\/].*",
+ r"chrome[\\\/]Hammer[\\\/].*",
+ r"chrome[\\\/]Release[\\\/].*",
+ r"xcodebuild[\\\/].*",
+ r"skia[\\\/].*",
+ r".*third_party[\\\/].*",
+ r"v8[\\\/].*",
+]
def ReadFile(path):
"""Given a path, returns the full contents of the file.
-
+
Reads files in binary format.
"""
fo = open(path, 'rb')
@@ -35,39 +42,76 @@ _ReadFile = ReadFile
def CheckChangeOnUpload(input_api, output_api):
- return (CheckNoCrOrTabs(input_api, output_api) +
- input_api.canned_checks.CheckDoNotSubmit(input_api, output_api))
+ return LocalChecks(input_api, output_api)
def CheckChangeOnCommit(input_api, output_api):
- # No extra checks on commit for now
- return CheckChangeOnUpload(input_api, output_api)
+ return (LocalChecks(input_api, output_api) +
+ input_api.canned_checks.CheckDoNotSubmit(input_api, output_api))
+
+def LocalChecks(input_api, output_api, max_cols=80):
+ """Reports an error if for any source file in SOURCE_FILE_EXTENSIONS:
+ - uses CR (or CRLF)
+ - contains a TAB
+ - has a line that ends with whitespace
+ - contains a line >|max_cols| cols unless |max_cols| is 0.
-def CheckNoCrOrTabs(input_api, output_api):
- """Reports an error if source files use CR (or CRLF) or TAB.
+ Note that the whole file is checked, not only the changes.
"""
cr_files = []
- tab_files = []
results = []
-
- for f in input_api.AffectedTextFiles(include_deletes=False):
+ excluded_paths = [input_api.re.compile(x) for x in EXCLUDED_PATHS]
+ files = input_api.AffectedFiles()
+ for f in files:
path = f.LocalPath()
- root, ext = os.path.splitext(path)
- if ext in SOURCE_FILE_EXTENSIONS:
- # Need to read the file ourselves since AffectedFile.NewContents()
- # will normalize line endings.
- contents = _ReadFile(path)
- if '\r' in contents:
- cr_files.append(path)
- if '\t' in contents:
- tab_files.append(path)
+ root, ext = input_api.os_path.splitext(path)
+ # Look for unsupported extensions.
+ if not ext in SOURCE_FILE_EXTENSIONS:
+ continue
+ # Look for excluded paths.
+ found = False
+ for item in excluded_paths:
+ if item.match(path):
+ found = True
+ break
+ if found:
+ continue
+
+ # Need to read the file ourselves since AffectedFile.NewContents()
+ # will normalize line endings.
+ contents = _ReadFile(path)
+ if '\r' in contents:
+ cr_files.append(path)
+
+ local_errors = []
+ # Remove EOL character.
+ lines = contents.splitlines()
+ line_num = 1
+ for line in lines:
+ if line.endswith(' '):
+ local_errors.append(output_api.PresubmitError(
+ '%s, line %s ends with whitespaces.' %
+ (path, line_num)))
+ # Accept lines with http:// to exceed the max_cols rule.
+ if max_cols and len(line) > max_cols and not 'http://' in line:
+ local_errors.append(output_api.PresubmitError(
+ '%s, line %s has %s chars, please reduce to %d chars.' %
+ (path, line_num, len(line), max_cols)))
+ if '\t' in line:
+ local_errors.append(output_api.PresubmitError(
+ "%s, line %s contains a tab character." %
+ (path, line_num)))
+ line_num += 1
+ # Just show the first 5 errors.
+ if len(local_errors) == 6:
+ local_errors.pop()
+ local_errors.append(output_api.PresubmitError("... and more."))
+ break
+ results.extend(local_errors)
+
if cr_files:
results.append(output_api.PresubmitError(
'Found CR (or CRLF) line ending in these files, please use only LF:',
items=cr_files))
- if tab_files:
- results.append(output_api.PresubmitError(
- 'Found tabs in the following files, please use spaces',
- items=tab_files))
return results