Document how to use in a Git pre-commit hook.
This commit is contained in:
12
README.md
12
README.md
@@ -37,6 +37,18 @@ needed!
|
||||
* It's super fast. The `check` command finishes small codebases in well under 1 second, and a 250k
|
||||
line codebase is checked in under 3 seconds.
|
||||
|
||||
Use in a Git pre-commit hook
|
||||
----------------------------
|
||||
|
||||
```
|
||||
editorconfig-cli check src/ tests/
|
||||
if [[ $? != '0' ]]; then
|
||||
echo 'Code is not aligned with .editorconfig'
|
||||
echo 'Review the output and commit your fixes'
|
||||
exit 1
|
||||
fi
|
||||
```
|
||||
|
||||
How to contribute
|
||||
-----------------
|
||||
|
||||
|
||||
@@ -8,8 +8,3 @@
|
||||
|
||||
* The file pattern `{num1..num2}` is not fully implemented yet. See
|
||||
`ConvertWildcardPatternToGoRegexp` in `path_matcher.go`
|
||||
|
||||
* Add an example of how to use the `check` command in a continuous integration build or in a Git
|
||||
pre-commit hook.
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user