Supporting custom command line params to pylint #6

Author: sebdah

README.md

@@ -18,7 +18,19 @@ Don't forget to make it executable.
 Usage
 ------
 
-The commit hook will automatically be called when you are running `git commit`. If you want to skip the tests for a certain commit, use the `-n` flag, `git commit -n`.  
+The commit hook will automatically be called when you are running `git commit`. If you want to skip the tests for a certain commit, use the `-n` flag, `git commit -n`.
+
+### Setting score limit
+
+Open the `pre-commit` script and update the `LIMIT` value according to your needs. E.g.
+
+	LIMIT = 8.0
+
+### Custom `pylint` command line options
+
+The hook supports custom command line options to be specified. Those can be added to the `PYLINT_PARAMS` inside the `pre-commit` script. E.g.
+
+	PYLINT_PARAMS = '--rcfile=/path/to/project/pylint.rc'
 
 
 Requirements

pre-commit

@@ -24,6 +24,11 @@ LICENSE:
 # The lowest allowed score (should be a float between 0.00 and 10.00)
 LIMIT = 8.0
 
+# Custom pylint command line parameters. See pylint --help for more info
+# E.g.
+# PYLINT_PARAMS = '--rcfile=/path/to/project/pylint.rc'
+PYLINT_PARAMS = ''
+
 #######################################
 #
 # CODE BELOW
@@ -103,8 +108,13 @@ def checker():
             python_file, i, len(python_files)))
         sys.stdout.flush()
         try:
+            if PYLINT_PARAMS:
+                # Use without extra config file
+                command = 'pylint %s' % python_file
+            else:
+                command = 'pylint %s %s' % (PYLINT_PARAMS, python_file)
             proc = subprocess.Popen(
-                ('pylint %s' % python_file).split(),
+                command.split(),
                 stdout=subprocess.PIPE,
                 stderr=subprocess.PIPE)
             out, _ = proc.communicate()