build: add lint, style and format commands

mattyclarkson · mattyclarkson · commit 6780f7db07f1 · 2018-10-29T09:34:03.000Z
The `format` command is useful because the `cpplint` code does not conform to any tight style. If we can remove all the `pylint` and `flake8` violations we can develop a `yapf` configuration that formats to that style
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,39 @@
+[flake8]
+ignore =
+    # indentation is not a multiple of four,
+    E111,E114,
+    # visually indented line with same indent as next logical line,
+    E129,
+    # line too long
+    E501,
+    # expected 2 blank lines, found 1
+    E302,E305,
+    # closing bracket does not match indentation of opening bracket's line
+    E123,
+    # multiple spaces before operator
+    E221,
+    # line break before binary operator
+    W503,
+    # line break after binary operator
+    W504,
+    # multiple statements on one line
+    E701,
+    # continuation line under-indented for hanging indent
+    E121,
+    # closing bracket does not match visual indentation
+    E124,
+    # continuation line with same indent as next logical line
+    E125,
+    # continuation line over-indented for visual indent
+    E127,
+    # continuation line under-indented for visual indent
+    E128,
+    # unexpected indentation
+    E116,
+    # too many blank lines
+    E303,
+    # missing whitespace around arithmetic operator
+    E226,
+    # test for membership should be 'not in'
+    E713,
+max-line-length=80
diff --git a/.pylintrc b/.pylintrc
@@ -0,0 +1,32 @@
+[BASIC]
+include-naming-hint=yes
+method-rgx=[A-Z_][A-Za-z0-9]{2,49}$
+function-rgx=[A-Z_][A-Za-z0-9]{2,49}$|main|unicode_escape_decode
+const-rgx=[a-zA-Z_][A-Za-z0-9_]{2,49}$
+variable-rgx=[a-z_][a-z0-9_]{0,49}$
+argument-rgx=[a-z_][a-z0-9_]{0,49}$
+class-rgx=[A-Z_][a-zA-Z0-9]+$|basestring|unicode|long|xrange
+
+[MESSAGES CONTROL]
+disable=global-statement,multiple-statements,missing-docstring,no-else-return,no-self-use,consider-merging-isinstance,bad-indentation,bad-continuation,fixme,bad-option-value,anomalous-unicode-escape-in-string,unused-argument,useless-object-inheritance,consider-using-dict-comprehension,consider-using-in
+
+[REPORTS]
+output-format=colorized
+reports=no
+score=no
+
+[FORMAT]
+indent-string='  '
+indent-after-paren=4
+max-module-lines=10000
+
+[DESIGN]
+max-locals=25
+max-line-length=100
+max-attributes=10
+max-branches=30
+max-args=20
+max-statements=75
+max-returns=10
+min-public-methods=0
+max-bool-expr=10
diff --git a/.style.yapf b/.style.yapf
@@ -0,0 +1,5 @@
+[style]
+based_on_style = chromium
+dedent_closing_brackets = True
+coalesce_brackets = True
+continuation_indent_width = 2
diff --git a/README.rst b/README.rst
@@ -40,6 +40,17 @@ The modifications in this branch are minor fixes and cosmetic changes:
 * Support ``#pragma once`` as an alternative to header include guards
 * Add quiet option to suppress non error-related output
 
+Development
+-----------
+
+.. code-block:: bash
+
+    pip install --user -e .[dev]
+    ./setup.py lint
+    ./setup.py style
+    ./setup.py test
+    ./setup.py ci # all the above
+
 Maintaining
 -----------
 
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,4 @@
+[aliases]
+style = flake8
+ci = lint style test
+
diff --git a/setup.py b/setup.py
@@ -1,6 +1,59 @@
 #! /usr/bin/env python
 
-from setuptools import setup
+from setuptools import setup, Command
+from setuptools.command.test import test as TestCommand
+from subprocess import check_call
+from multiprocessing import cpu_count
+from distutils.spawn import find_executable
+
+
+class Test(TestCommand):
+    def run_tests(self):
+        check_call(('./cpplint_unittest.py'))
+        check_call(('./cpplint_clitest.py'))
+
+
+class Cmd(Command):
+    user_options = [
+      ('executable', 'e', 'The executable to use for the command')
+    ]
+
+    def initialize_options(self):
+        self.executable = find_executable(self.executable)
+
+    def finalize_options(self):
+        pass
+
+    def execute(self, *k):
+        check_call((self.executable,) + k)
+
+
+class Lint(Cmd):
+    description = 'Run linting of the code'
+    user_options = Cmd.user_options + [
+      ('jobs', 'j', 'Use multiple processes to speed up the linting')
+    ]
+    executable = 'pylint'
+
+    def initialize_options(self):
+        self.jobs = cpu_count()
+
+    def finalize_options(self):
+        self.jobs = int(self.jobs)
+        if self.jobs < 1:
+            raise ValueError('Jobs must be one or larger')
+
+    def run(self):
+        self.execute('-j', str(self.jobs), 'cpplint.py')
+
+
+class Format(Cmd):
+    description = 'Formats the code'
+    executable = 'yapf'
+
+    def run(self):
+        self.execute('--parallel', '--in-place', 'cpplint.py')
+
 
 setup(name='cpplint',
       version='1.3.0',
@@ -15,8 +68,8 @@
       url='http://en.wikipedia.org/wiki/Cpplint',
       download_url='https://github.com/cpplint/cpplint',
       keywords=['lint', 'python', 'c++'],
-      maintainer = 'cpplint Developers',
-      maintainer_email = 'see_github@nospam.com',
+      maintainer='cpplint Developers',
+      maintainer_email='see_github@nospam.com',
       classifiers=['Programming Language :: Python',
                    'Programming Language :: Python :: 2',
                    'Programming Language :: Python :: 2.7',
@@ -38,4 +91,9 @@
             'flake8',
             'yapf',
         ]
+      },
+      cmdclass={
+        'test': Test,
+        'lint': Lint,
+        'format': Format
       })
