Merge pull request #127 from supermetrics-public/feature/code-fmt-mak…

…e-targets

Add scripts and docs for code quality tooling

Makefile.frag

@@ -1,2 +1,19 @@
+format_files=jsonpath.c \
+	php_jsonpath.h \
+	src/jsonpath/*.{c,h} \
+
 findphp:
 	@echo $(PHP_EXECUTABLE)
+
+format-check:
+	@clang-format --dry-run -Werror $(format_files)
+
+format-code:
+	@clang-format -i $(format_files)
+
+lint-code:
+	@cppcheck --enable=all --error-exitcode=1 --std=c89 --suppress=missingInclude $(format_files)
+
+setup-pre-commit:
+	@ln -s ../../pre-commit .git/hooks
+

README.md

@@ -248,6 +248,32 @@ $ make lcov
 
 You can then find a coverage report in the `lcov_html/` directory.
 
+## Code Quality Tooling
+
+Please run the code formatter and linter (and fix any issues reported by the linter) before filing a pull request.
+
+You may check the code format and linter automatically before committing by setting up a pre-commit hook:
+
+```bash
+make setup-pre-commit
+```
+
+### Formatting
+
+Code formatting requires [clang-format](https://clang.llvm.org/docs/index.html).
+
+```bash
+make format-code
+```
+
+### Linting
+
+Linting requires [cppcheck](http://cppcheck.sourceforge.net/).
+
+```bash
+make lint-code
+```
+
 ## Contributors
 
 JsonPath-PHP is created by [Mike Kaminski](https://github.com/mkaminski1988) and maintained by 

pre-commit

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+make format-check lint-code