elf
/
git-linter
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated README to explain timestamp discrepencies on Lint failure.

This commit is contained in:
Elf M. Sternberg 2016-06-28 16:30:57 -07:00
parent 8705fc1449
commit 29625f9df2
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -10,11 +10,14 @@ you attempt to commit a collection of files, running the configured list
of linters against those files, and will terminate the check-in if any of linters against those files, and will terminate the check-in if any
of the files fails. of the files fails.
pre-commit uses the git-stash to temporarily store any changes you may pre-commit uses the `git-stash` command to temporarily store any changes
have made between your "git-add" and your "git-commit"; it therefore you may have made between your `git-add` and your `git-commit`; it
checks against your *staged* files, not your *workspace* files. Most therefore checks against your *staged* files, not your *workspace*
hooks do the wrong thing and assume your stage and workspace are the files. Most hooks do the wrong thing and assume your stage and
same. This is not necessarily so. workspace are the same. This is not necessarily so. This has the
unfortunate side-effect of touching every file if things should fail,
which may confuse your IDE. I haven't quite figured out how to deal
with that.
pre-commit is written in Hy, a Lisp-like dialect of Python. I find Hy's pre-commit is written in Hy, a Lisp-like dialect of Python. I find Hy's
support for "cond", complex anonymous functions, and complex return support for "cond", complex anonymous functions, and complex return