From d2f2b3969b1039e380aadf576a53a61bcc91b3ad Mon Sep 17 00:00:00 2001 From: "Kenneth M. Elf Sternberg" Date: Mon, 19 Sep 2016 16:00:37 -0700 Subject: [PATCH] Trying to formalize the plan from the original. --- docs/strategies.rst | 32 ++++++++++++++++++++++++++++++++ docs/usage.rst | 2 +- 2 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 docs/strategies.rst diff --git a/docs/strategies.rst b/docs/strategies.rst new file mode 100644 index 0000000..7a21b92 --- /dev/null +++ b/docs/strategies.rst @@ -0,0 +1,32 @@ +Strategies +---------- + +git-lint has a couple of phases in which it develops its strategy for what to run: + +1. Load the configuration file. + a. On the command line? + b. In the base directory as .git-lint? + 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? + +2. Prune configuration with ``-o`` or ``-e`` options + +3. Determine which files to lint. + a. Workspace or staging? + i. If staging, record all stashed timestamps for restoration + b. From this list: + i. All changed files ``-b`` + ii. All changed files in the current directory and down (default) + iii. All files in the current directory and down. ``-a`` + iv. All files in the repository ``-a -b`` + c. Add files from command line, if any. + d. Filter based on match criteria in configuration file. + +4. For each file, run the appropriate linter. + a. If in delta mode ``-d``, only show differences that correspond to user changes. + b. Capture failure output and failure status. + +5. Reduce failure status to pass/fail +6. Print resulting messages and exit with failure status (for pre-commit). +7. If staging, unstage and touch-up files to restore timestamps. diff --git a/docs/usage.rst b/docs/usage.rst index e45f86d..bbf0611 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -19,7 +19,7 @@ Options Version info ``-c`` ``--config`` - Specify config file (default: ``$GIT_DIR/.git/git_lint/config``) + Specify config file (default: ``$GIT_DIR/.git-lint``) ``-w`` ``--workspace`` Check workspace [default]