diff --git a/arguments.html b/arguments.html index f50b0a5..e5a3481 100644 --- a/arguments.html +++ b/arguments.html @@ -6,9 +6,9 @@ - <no title> — Git Lint 0.0.4 documentation + <no title> — Git Lint 0.0.4 documentation - + - -
+ +
-
+
-o <linters>, –only=<linters>
@@ -83,31 +83,30 @@
-
+ -
+ -
- © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/authors.html b/authors.html index 504c2fa..1f5f62a 100644 --- a/authors.html +++ b/authors.html @@ -6,9 +6,9 @@ - Credits — Git Lint 0.0.4 documentation + Credits — Git Lint 0.0.4 documentation - +
-
+ -
- © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/contributing.html b/contributing.html index 290ea9a..f613f38 100644 --- a/contributing.html +++ b/contributing.html @@ -6,9 +6,9 @@ - Contributing — Git Lint 0.0.4 documentation + Contributing — Git Lint 0.0.4 documentation - +
-
+ -
- © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/genindex.html b/genindex.html index 1388d5d..3a20612 100644 --- a/genindex.html +++ b/genindex.html @@ -7,9 +7,9 @@ - Index — Git Lint 0.0.4 documentation + Index — Git Lint 0.0.4 documentation - + - -
+ +
-
+

Index

@@ -294,29 +294,26 @@
-
+ -
+ -
- © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/git_lint.html b/git_lint.html index ffa0a6b..60aaf93 100644 --- a/git_lint.html +++ b/git_lint.html @@ -6,9 +6,9 @@ - git_lint package — Git Lint 0.0.4 documentation + git_lint package — Git Lint 0.0.4 documentation - + - -
+ +
-
+

git_lint package

@@ -53,20 +53,20 @@

git_lint.git_lint module

-class git_lint.git_lint.Linters(linters, filenames)[source]
+class git_lint.git_lint.Linters(linters, filenames)[source]
-dryrun()[source]
+dryrun()[source]
-static encode_shell_messages(prefix, messages)[source]
+static encode_shell_messages(prefix, messages)[source]
-static run_external_linter(filename, linter, linter_name)[source]
+static run_external_linter(filename, linter, linter_name)[source]

Run one linter against one file.

If the result matches the error condition specified in the configuration file, return the error code and messages, otherwise return nothing.

@@ -74,7 +74,7 @@ return the error code and messages, otherwise return nothing.

-static run_one_linter(linter, filenames)[source]
+static run_one_linter(linter, filenames)[source]

Runs one linter against a set of files

Creates a match filter for the linter, extract the files to be linted, and runs the linter against each file, returning the @@ -86,33 +86,33 @@ return code and the output of the lint process.

-class git_lint.git_lint.MatchFilter(config)[source]
+class git_lint.git_lint.MatchFilter(config)[source]
-static make_match_filter_matcher(extensions)[source]
+static make_match_filter_matcher(extensions)[source]
-class git_lint.git_lint.StagingRunner(filenames)[source]
+class git_lint.git_lint.StagingRunner(filenames)[source]
-class git_lint.git_lint.WorkspaceRunner(filenames)[source]
-

Bases: object

+class git_lint.git_lint.WorkspaceRunner(filenames)[source] +

Bases: object

-git_lint.git_lint.executable_exists(script, label)[source]
+git_lint.git_lint.executable_exists(script, label)[source]
-git_lint.git_lint.find_config_file(options, base)[source]
+git_lint.git_lint.find_config_file(options, base)[source]

Returns the configuration file from a prioritized list of locations.

Locations are prioritized as:
@@ -130,48 +130,48 @@ return code and the output of the lint process.

-git_lint.git_lint.get_filelist(options, extras)[source]
+git_lint.git_lint.get_filelist(options, extras)[source]

Returns the list of files against which we’ll run the linters.

-git_lint.git_lint.get_git_base()[source]
+git_lint.git_lint.get_git_base()[source]
-git_lint.git_lint.get_git_head()[source]
+git_lint.git_lint.get_git_head()[source]
-git_lint.git_lint.get_git_response(cmd)[source]
+git_lint.git_lint.get_git_response(cmd)[source]
-git_lint.git_lint.get_git_response_raw(cmd)[source]
+git_lint.git_lint.get_git_response_raw(cmd)[source]
-git_lint.git_lint.get_linter_status(config)[source]
+git_lint.git_lint.get_linter_status(config)[source]
-git_lint.git_lint.get_shell_response(fullcmd)[source]
+git_lint.git_lint.get_shell_response(fullcmd)[source]
-git_lint.git_lint.get_working_linter_names(config)[source]
+git_lint.git_lint.get_working_linter_names(config)[source]
-git_lint.git_lint.load_config(options, base)[source]
+git_lint.git_lint.load_config(options, base)[source]

Loads the git-lint configuration file.

Returns the configuration file as a dictionary of dictionaries. Performs substitutions as specified in the SafeConfigParser @@ -184,17 +184,17 @@ files for specific linters.

-git_lint.git_lint.run_git_command(cmd)[source]
+git_lint.git_lint.run_git_command(cmd)[source]
-git_lint.git_lint.run_linters(options, config, extras=[])[source]
+git_lint.git_lint.run_linters(options, config, extras=[])[source]
-git_lint.git_lint.split_git_response(cmd)[source]
+git_lint.git_lint.split_git_response(cmd)[source]
@@ -202,7 +202,7 @@ files for specific linters.

git_lint.option_handler module

-git_lint.option_handler.cleanup_options(options, commandline)[source]
+git_lint.option_handler.cleanup_options(options, commandline)[source]
Takes a table of options and the commandline, and returns a
dictionary of those options that appear on the commandline @@ -223,32 +223,32 @@ Help text, list of (long) options superseded by this one.

git_lint.reporters module

-git_lint.reporters.base_file_cleaner(files)[source]
+git_lint.reporters.base_file_cleaner(files)[source]
-git_lint.reporters.group_by(iterable, field_id)[source]
+git_lint.reporters.group_by(iterable, field_id)[source]
-git_lint.reporters.print_help(options, name)[source]
+git_lint.reporters.print_help(options, name)[source]
-git_lint.reporters.print_linters(config, broken_linter_names)[source]
+git_lint.reporters.print_linters(config, broken_linter_names)[source]
-git_lint.reporters.print_report(results, unlintable_filenames, cant_lint_filenames, broken_linter_names, unfindable_filenames, options={'bylinter': True})[source]
+git_lint.reporters.print_report(results, unlintable_filenames, cant_lint_filenames, broken_linter_names, unfindable_filenames, options={'bylinter': True})[source]
-git_lint.reporters.print_version(name, version)[source]
+git_lint.reporters.print_version(name, version)[source]
@@ -261,7 +261,7 @@ Help text, list of (long) options superseded by this one.
-
+ -
+ -
- © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/history.html b/history.html index 9e235dc..51495bf 100644 --- a/history.html +++ b/history.html @@ -6,9 +6,9 @@ - History — Git Lint 0.0.4 documentation + History — Git Lint 0.0.4 documentation - +
-
+ -
- © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/index.html b/index.html index aa0c438..7394896 100644 --- a/index.html +++ b/index.html @@ -6,9 +6,9 @@ - Welcome to Git Lint’s documentation! — Git Lint 0.0.4 documentation + Welcome to Git Lint’s documentation! — Git Lint 0.0.4 documentation - +
-
+ -
- © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/installation.html b/installation.html index b3ea608..8244e14 100644 --- a/installation.html +++ b/installation.html @@ -6,9 +6,9 @@ - Installation — Git Lint 0.0.4 documentation + Installation — Git Lint 0.0.4 documentation - +
-
+ -
- © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/manual.html b/manual.html index 6457fd1..b0b9986 100644 --- a/manual.html +++ b/manual.html @@ -6,9 +6,9 @@ - git-lint(1) — Git Lint 0.0.4 documentation + git-lint(1) — Git Lint 0.0.4 documentation - + - -
+ +
-
+

git-lint(1)

@@ -53,7 +53,7 @@

SYNOPSIS

[verse] -git lint [<options>...] [<files...>]

+git lint [<options>...] [<files...>]

DESCRIPTION

@@ -106,13 +106,13 @@ the files currently in the staging area.

By default, the output is that of all the linters specified, in the order in which they appear in the configuration file, followed by every file specified, sorted ASCIIbetically. This order can be -flipped (files first, then linters) with the --byfiles option.

-

git lint returns the maximal error code if any linters fail a +flipped (files first, then linters) with the --byfiles option.

+

git lint returns the maximal error code if any linters fail a pass, or zero if they all succeed.

CONFIGURATION

-

git lint uses a standard INI-style configuration file. Aside from the +

git lint uses a standard INI-style configuration file. Aside from the DEFAULT section, the name of each section is an alphanumeric token name for a linter, followed by configuration details for that linter. Standard details are:

@@ -122,7 +122,7 @@ are:

  • match - A comma-separated list of extensions to match against the linter
  • print - If true, will prefix each line of output from the linter with the filename
  • condition - if “error”, the return code of the linter is the status of the pass. If “output,” any output will result in a failure.
    • -
  • comment - Text to include when running the --linters option
    • +
  • comment - Text to include when running the --linters option
    • @@ -131,7 +131,7 @@ are:

    -
    + -
    + -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/modules.html b/modules.html index 9fd0a71..d134d43 100644 --- a/modules.html +++ b/modules.html @@ -6,9 +6,9 @@ - git_lint — Git Lint 0.0.4 documentation + git_lint — Git Lint 0.0.4 documentation - + - -
    + +
    -
    +

    git_lint

    @@ -65,31 +65,30 @@
    -
    + -
    + -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/modules/git_lint/git_lint.html b/modules/git_lint/git_lint.html index 247071f..7650f51 100644 --- a/modules/git_lint/git_lint.html +++ b/modules/git_lint/git_lint.html @@ -6,9 +6,9 @@ - git_lint.git_lint — Git Lint 0.0.4 documentation + git_lint.git_lint — Git Lint 0.0.4 documentation - +
    -
    + -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/modules/git_lint/option_handler.html b/modules/git_lint/option_handler.html index e7f561e..b7ac1e6 100644 --- a/modules/git_lint/option_handler.html +++ b/modules/git_lint/option_handler.html @@ -6,9 +6,9 @@ - git_lint.option_handler — Git Lint 0.0.4 documentation + git_lint.option_handler — Git Lint 0.0.4 documentation - +
    -
    + -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/modules/git_lint/reporters.html b/modules/git_lint/reporters.html index 66e7979..bd4ef9a 100644 --- a/modules/git_lint/reporters.html +++ b/modules/git_lint/reporters.html @@ -6,9 +6,9 @@ - git_lint.reporters — Git Lint 0.0.4 documentation + git_lint.reporters — Git Lint 0.0.4 documentation - +
    -
    + -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/modules/index.html b/modules/index.html index c3faac5..b16d13f 100644 --- a/modules/index.html +++ b/modules/index.html @@ -6,9 +6,9 @@ - Overview: module code — Git Lint 0.0.4 documentation + Overview: module code — Git Lint 0.0.4 documentation - + - -
    + +
    -
    +

    All modules for which code is available

    -
    + -
    + -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/objects.inv b/objects.inv index f5ad8c7..de1f784 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/py-modindex.html b/py-modindex.html index 15bebf5..6bce60b 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -6,9 +6,9 @@ - Python Module Index — Git Lint 0.0.4 documentation + Python Module Index — Git Lint 0.0.4 documentation - +
    -
    + -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/readme.html b/readme.html index 39ec180..7ba26a2 100644 --- a/readme.html +++ b/readme.html @@ -6,9 +6,9 @@ - Git Lint: README — Git Lint 0.0.4 documentation + Git Lint: README — Git Lint 0.0.4 documentation - +
    -
    + -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/search.html b/search.html index d6b96da..9b8a8ed 100644 --- a/search.html +++ b/search.html @@ -6,9 +6,9 @@ - Search — Git Lint 0.0.4 documentation + Search — Git Lint 0.0.4 documentation - + - -
    + +
    -
    +

    Strategies

    @@ -55,7 +55,7 @@ c. In the base directory as .git-lint/config? d. In the user’s home directory as .git-lint? e. In the user’s home directroy as .git-lint/config?

    -

  • Prune configuration with -o or -e options

    +

  • Prune configuration with -o or -e options

  • Determine which files to lint. a. Workspace or staging?

    @@ -68,10 +68,10 @@ a. Workspace or staging?

  • From this list:
      -
    1. All changed files -b
      2. +
    2. All changed files -b
    3. All changed files in the current directory and down (default)
      4. -
    4. All files in the current directory and down. -a
      5. -
    5. All files in the repository -a -b
      6. +
    6. All files in the current directory and down. -a
      7. +
    7. All files in the repository -a -b
    @@ -83,7 +83,7 @@ a. Workspace or staging?

  • For each file, run the appropriate linter. -a. If in delta mode -d, only show differences that correspond to user changes. +a. If in delta mode -d, only show differences that correspond to user changes. b. Capture failure output and failure status.

  • Reduce failure status to pass/fail

    @@ -99,31 +99,30 @@ b. Capture failure output and failure status.

    • -
    + -
    + -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file diff --git a/usage.html b/usage.html index c881183..670c4c1 100644 --- a/usage.html +++ b/usage.html @@ -6,9 +6,9 @@ - Usage — Git Lint 0.0.4 documentation + Usage — Git Lint 0.0.4 documentation - +
    -
    + -
    - © Copyright 2016, Kenneth M. "Elf" Sternberg. - Created using Sphinx 1.2.2. + \ No newline at end of file