Add initial code

Author: codingjoe

.gitignore

@@ -99,3 +99,6 @@ ENV/
 
 # mypy
 .mypy_cache/
+
+# PyTest
+.pytest_cache/

.relint.yml

@@ -0,0 +1,6 @@
+- name: No ToDo
+  pattern: "[tT][oO][dD][oO]"
+  hint: Get it done right away!
+  filename:
+    - "*.py"
+    - "*.js"

.travis.yml

@@ -0,0 +1,14 @@
+language: python
+python:
+- '3.5'
+- '3.6'
+script: relint **
+deploy:
+  provider: pypi
+  user: codingjoe
+  password:
+    secure: ocotP5Wb+UCtsqMAXOuzCKUabQ6pVkhvRRdNMsJ+MX+Fc6O6fLW90rD5Ny03z29HdvNfedty7hzhGYVdGwOUdMeSy36od1wN7PFZ6cI7Uotn+YBvl249kNdNQFkVcowywUjYi7tuzbl/0VVi1zFCHJvw7Dv0N5LNv7aHeJxuv/9CmOcA+7mEauDjse7zpYxIOO33XLrg2eAZrL1GPZTzrEA7urKBPO6w0s9Z6EUTkEpRYZPBqS6ajCWONNK9Dj65i2GVhEp8SEoAG3ILCiLbM45nJYoUBeL20yG6TliXis4P51JalcgYtq1Ir41vprODA5dWVzgaeS0lemU19ym/Gs+32EmIeMQuJ0QpylmqJ6OjMLTU0QK4up9Eydr824wZ8Q2iZ8zUkaKvrIsLinQ/BSaSnQmz21X0mMXQdDLbI+VmwEOYqaa6liQOK1j1bXSOaCFu6fVV7AiktbCcUeg5NX259VT5+yuAJ49cw3fY7P3pu8+vviNkyKK7APbvhaK4eo4yvGCHGeWaoYrJkb+Vz9yWRathe5nSWzAgOl+fu6N8QCVljMvj1GTt+eVfH8Rr0re7/e/6dv2MiAec+w3K40gp/3J6axMMGfxEQy37+3HCUsgmAGJSFs6uj6KX+HfZTBZIAqyo+KavVos/Ml9zvyf8nTw70FGpay8btc5fyqU=
+  on:
+    tags: true
+    distributions: sdist bdist_wheel
+    repo: codingjoe/relint

README.md

@@ -0,0 +1,36 @@
+ReLint
+======
+
+**Regular Expression Linter**
+
+*Write your own linting rules using regular expressions.*
+
+Usage
+-----
+
+You can write your own regular rules in a YAML file, like so:
+
+.. code-block:: YAML
+
+    - name: No ToDo
+      pattern: "[tT][oO][dD][oO]"
+      hint: Get it done right away!
+      filename:
+        - "*.py"
+        - "*.js"
+
+The ``name`` attribute is the name of your linter, the ``pattern`` can be
+any regular expression. The linter does lint entire files, therefore your
+expressions can match multiple lines and include newlines.
+
+You can narrow down the file types your linter should be working with, by
+providing the optional ``filename`` attribute. The default is ``*``.
+
+The following command will lint all files in the current directory:
+
+.. code-block:: bash
+
+    relint -c .relint.yml **
+
+The default configuration file name is `.relint.yaml` within your working
+directory, but you can provide any YAML or JSON file.

README.rst

@@ -0,0 +1,92 @@
+import argparse
+import fnmatch
+import glob
+import re
+from collections import namedtuple
+from itertools import chain
+
+import yaml
+
+
+def parse_args():
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        'files',
+        metavar='FILE',
+        type=str,
+        nargs='+',
+        help='Path to one or multiple files to be checked.'
+    )
+    parser.add_argument(
+        '--config',
+        '-c',
+        metavar='CONFIG_FILE',
+        type=str,
+        default='.relint.yml',
+        help='Path to config file, default: .relint.yml'
+    )
+    return parser.parse_args()
+
+
+Test = namedtuple('Test', ('name', 'pattern', 'hint', 'filename'))
+
+
+def load_config(path):
+    with open(path) as fs:
+        for test in yaml.load(fs):
+            filename = test.get('filename', ['*'])
+            if not isinstance(filename, list):
+                filename = list(filename)
+            yield Test(
+                name=test['name'],
+                pattern=re.compile(test['pattern']),
+                hint=test.get('hint'),
+                filename=filename,
+            )
+
+
+def lint_file(filename, tests):
+    try:
+        with open(filename) as fs:
+            content = fs.read()
+    except (IsADirectoryError, UnicodeDecodeError):
+        pass
+    else:
+        for test in tests:
+            if any(fnmatch.fnmatch(filename, fp) for fp in test.filename):
+                for match in test.pattern.finditer(content):
+                    yield filename, test, match
+
+
+def main():
+    args = parse_args()
+    paths = {
+        path
+        for file in args.files
+        for path in glob.iglob(file, recursive=True)
+    }
+
+    tests = list(load_config(args.config))
+
+    matches = chain.from_iterable(
+        lint_file(path, tests)
+        for path in paths
+    )
+
+    _filename = ''
+    lines = []
+
+    for filename, test, match in matches:
+        if filename != _filename:
+            _filename = filename
+            lines = match.string.splitlines()
+
+        line_no = match.string[:match.start()].count('\n')
+        print(f"{filename}:{line_no + 1} {test.name}")
+        if test.hint:
+            print("Hint:", test.hint)
+        print(">   ", lines[line_no])
+
+
+if __name__ == '__main__':
+    main()

relint.py

@@ -0,0 +1 @@
+PyYAML

requirements.txt

@@ -0,0 +1,32 @@
+[metadata]
+name = lintipy
+author = Johannes Hoppe
+author-email = [email protected]
+summary = Write your own linting rules using regular expressions
+description-file = README.rst
+home-page = https://github.com/codingjoe/relint
+license = MIT
+classifier =
+    Development Status :: 4 - Beta
+    Environment :: Console
+    Intended Audience :: Developers
+    Intended Audience :: Information Technology
+    Operating System :: OS Independent
+    Programming Language :: Python
+keywords =
+    linter
+    regex
+
+[entry_points]
+console_scripts =
+    relint = relint:main
+
+[pbr]
+skip_authors = true
+skip_changelog = true
+
+[pycodestyle]
+max_line_length = 99
+
+[pydocstyle]
+add_ignore = D1

setup.cfg

@@ -0,0 +1,9 @@
+#!/usr/bin/env python
+
+from setuptools import setup
+
+setup(
+    setup_requires=['pbr'],
+    py_modules=['relint'],
+    pbr=True,
+)

setup.py

@@ -0,0 +1 @@
+# TODO: I'll do it later, promise