Readability added.

.git-lint

@@ -63,3 +63,9 @@ match = .json
 print = False
 condition = error
 
+[readability]
+output = Running Text Style Check
+match = .rst
+command = git-lint-style
+print = False
+condition = error

bin/git-lint-style

@@ -46,6 +46,10 @@ def main(*args):
         print(error)
         return returncode
     kincaid = re.search(r'Kincaid:\s*([\d\.]+)', values, re.MULTILINE)
+
+    # Assumes an uncheckable issue, like an empty RST.  Not unusual.
+    if not kincaid: 
+        return 0
     val = float(kincaid.group(1))
 
     msg = ""

docs/conf.py

@@ -20,7 +20,7 @@ import os
 # directory, add these directories to sys.path here. If the directory is
 # relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 
 # Get the project root dir, which is the parent dir of this
 cwd = os.getcwd()
@@ -31,12 +31,12 @@ project_root = os.path.dirname(cwd)
 # version is used.
 sys.path.insert(0, project_root)
 
-import git_lint
+import git_lint  # noqa
 
 # -- General configuration ---------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@@ -49,7 +49,7 @@ templates_path = ['_templates']
 source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
@@ -69,13 +69,13 @@ release = git_lint.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to
 # some non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -83,28 +83,28 @@ exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built
 # documents.
-#keep_warnings = False
+# keep_warnings = False
 
 
 # -- Options for HTML output -------------------------------------------
@@ -116,27 +116,27 @@ html_theme = 'default'
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as
 # html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the
 # top of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon
 # of the docs.  This file should be a Windows icon file (.ico) being
 # 16x16 or 32x32 pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets)
 # here, relative to this directory. They are copied after the builtin
@@ -146,46 +146,46 @@ html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page
 # bottom, using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names
 # to template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer.
 # Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer.
 # Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages
 # will contain a <link> tag referring to it.  The value of this option
 # must be the base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'git_lintdoc'
@@ -195,13 +195,13 @@ htmlhelp_basename = 'git_lintdoc'
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
+    # 'papersize': 'letterpaper',
 
     # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
+    # 'pointsize': '10pt',
 
     # Additional stuff for the LaTeX preamble.
-    #'preamble': '',
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -215,23 +215,23 @@ latex_documents = [
 
 # The name of an image file (relative to this directory) to place at
 # the top of the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings
 # are parts, not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output ------------------------------------
@@ -245,7 +245,7 @@ man_pages = [
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output ----------------------------------------
@@ -263,13 +263,13 @@ texinfo_documents = [
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False

git_lint/git_lint.py

@@ -146,10 +146,6 @@ git_head = get_git_head()
 #  \___/ \__|_|_|_|\__|_\___/__/
 #
 
-def base_file_cleaner(files):
-    return [file.replace(git_base + '/', '', 1) for file in files]
-
-
 class MatchFilter:
 
     def __init__(self, config):

git_lint/option_handler.py

@@ -65,15 +65,17 @@ def cleanup_options(options, commandline):
                    if key not in excluded}
         return (cleaned, excluded)
 
-    def shortoptstogo(i): return i[0] + ((i[2] and ':') or '')
+    def shortoptstogo(i):
+        return i[0] + ((i[2] and ':') or '')
 
-    def longoptstogo(i): return i[1] + ((i[2] and '=') or '')
+    def longoptstogo(i):
+        return i[1] + ((i[2] and '=') or '')
 
     optstringsshort = ''.join([shortoptstogo(opt) for opt in options])
     optstringslong = [longoptstogo(opt) for opt in options]
     (chosen_options, filenames) = getopt.getopt(commandline[1:],
-                                         optstringsshort,
+                                                optstringsshort,
-                                         optstringslong)
+                                                optstringslong)
 
     # Turns what getopt returns into something more human-readable
     streamline_options = make_option_streamliner(options)

git_lint/reporters.py

@@ -1,8 +1,13 @@
 from __future__ import print_function
+from .git_lint import load_config, run_linters, git_base
 import gettext
 _ = gettext.gettext
 
 
+def base_file_cleaner(files):
+    return [file.replace(git_base + '/', '', 1) for file in files]
+
+
 # ICK.  Mutation, references, and hidden assignment.
 def group_by(iterable, field_id):
     results = []
@@ -28,7 +33,7 @@ def print_report(results, unlintable_filenames, cant_lint_filenames,
     for group in grouped_results:
         print(grouping.format(group[0]))
         for (filename, lintername, returncode, text) in group[1]:
-            print('\n'.join(text))
+            print('\n'.join(base_file_cleaner(text)))
         print('')
     if len(broken_linter_names):
         print(_('These linters could not be run:'), ','.join(broken_linter_names))

setup.py

@@ -4,10 +4,11 @@ import sys
 import argparse
 import os.path
 
+
 def _resolve_prefix(prefix, type):
     osx_system_prefix = r'^/System/Library/Frameworks/Python.framework/Versions'
-    matches = {'man': [(r'^/usr$', '/usr/share'), 
+    matches = {'man': [(r'^/usr$', '/usr/share'),
-                       (r'^/usr/local$', '/usr/local/share'), 
+                       (r'^/usr/local$', '/usr/local/share'),
                        (osx_system_prefix, '/usr/share')]}
 
     match = [i[1] for i in matches.get(type, []) if re.match(i[0], prefix)]
@@ -19,7 +20,7 @@ def _resolve_prefix(prefix, type):
 def get_data_files(prefix):
     return [(os.path.join(_resolve_prefix(prefix, 'man'), 'man/man1'), ['docs/_build/man/git-lint.1'])]
 
-    
+
 parser = argparse.ArgumentParser()
 parser.add_argument('--prefix', default='',
                     help='prefix to install data files')
@@ -62,10 +63,11 @@ setup(
     package_dir={'git_lint':
                  'git_lint'},
     include_package_data=True,
-    data_files = get_data_files(prefix),
+    data_files=get_data_files(prefix),
     install_requires=requirements,
     license="MIT",
     zip_safe=False,
+    scripts=['bin/git-lint-style'],
     keywords='git lint style syntaxt development',
     entry_points={
         'console_scripts': [