squawk-cli 0.10.0 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -124,6 +124,22 @@ Here's an example comment created by `squawk` using the `example.sql` in the rep
|
|
|
124
124
|
|
|
125
125
|
See the ["GitHub Integration" docs](https://squawkhq.com/docs/github_app) for more information.
|
|
126
126
|
|
|
127
|
+
## `pre-commit` hook
|
|
128
|
+
|
|
129
|
+
Integrate Squawk into Git workflow with [pre-commit](https://pre-commit.com/). Add the following
|
|
130
|
+
to your project's `.pre-commit-config.yaml`:
|
|
131
|
+
|
|
132
|
+
```
|
|
133
|
+
repos:
|
|
134
|
+
- repo: https://github.com/sbdchd/squawk
|
|
135
|
+
rev: v0.10.0
|
|
136
|
+
hooks:
|
|
137
|
+
- id: squawk
|
|
138
|
+
files: path/to/postres/migrations/written/in/sql
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Note the `files` parameter as it specifies the location of the files to be linted.
|
|
142
|
+
|
|
127
143
|
## prior art
|
|
128
144
|
|
|
129
145
|
- <https://github.com/erik/squabble>
|