@quobix/vacuum 0.0.29 → 0.0.30

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.
Files changed (2) hide show
  1. package/README.md +16 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -151,6 +151,22 @@ Alternatively, you can pull it from
151
151
  [Github packages](https://github.com/daveshanley/vacuum/pkgs/container/vacuum).
152
152
  To do that, replace `dshanley/vacuum` with `ghcr.io/daveshanley/vacuum` in the above commands.
153
153
 
154
+ ## Using vacuum with pre-commit
155
+
156
+ Vacuum can be used with [pre-commit](https://pre-commit.com).
157
+
158
+ To do that, add to your `.pre-commit-config.yaml`:
159
+
160
+ ```yaml
161
+ repos:
162
+ - repo: https://github.com/daveshanley/vacuum
163
+ rev: # a tag or a commit hash from this repo, see https://github.com/daveshanley/vacuum/releases
164
+ hooks:
165
+ - id: vacuum
166
+ ```
167
+
168
+ See the [hook config](./.pre-commit-hooks.yaml) here for details on what options the hook uses and what files it checks by default.
169
+
154
170
  ## Build an interactive HTML report
155
171
 
156
172
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quobix/vacuum",
3
- "version": "0.0.29",
3
+ "version": "0.0.30",
4
4
  "description": "The world's fastest, most scalable and complete OpenAPI parser",
5
5
  "type": "module",
6
6
  "author": "Dave Shanley",