diff options
| author | Tom Ryder <tom@sanctum.geek.nz> | 2018-11-19 16:38:33 +1300 |
|---|---|---|
| committer | Tom Ryder <tom@sanctum.geek.nz> | 2018-11-19 16:38:33 +1300 |
| commit | 40a2be885f2ac742b7bfb835ac79eaf18ed16f46 (patch) | |
| tree | 4356028f2f9f8a7b0677d7108a1e75e4bd9a3fdf /README.md | |
| parent | Strip README trailing blank line (diff) | |
| download | syntax-checking-git-hooks-master.tar.gz syntax-checking-git-hooks-master.zip | |
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..aa3a228 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +Syntax checking Git hooks +========================= + +As used by Tom Ryder, because Michael Fincham asked. + +The `pre-commit` file goes in `.git/hooks` in your repository, and you make it +executable. You'll need `file(1)` and various other binaries in your `PATH`. + +This is nowhere near as tidy as it could be, but it correctly handles syntax +checking and linting of added or changed files only, without rescanning the +whole project. It does this with some byzantine Bash. It handles filenames with +funny characters (including newlines) correctly. + +I'll write some real documentation Later™. + +License +------- + +Copyright (c) [Tom Ryder][1]. Distributed under [MIT License][2]. + +[1]: https://sanctum.geek.nz/ +[2]: http://opensource.org/licenses/MIT |