@quobix/vacuum 0.0.29 → 0.0.31
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 +20 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -151,6 +151,26 @@ 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 definition](./.pre-commit-hooks.yaml) here for details on what options the hook uses and what files it checks by default.
|
|
169
|
+
|
|
170
|
+
If no filenames or more than one filename in your repository matches the default `files` pattern in the hook definition,
|
|
171
|
+
the pattern needs to be overridden in your config so that it matches exactly one filename to lint at a time.
|
|
172
|
+
To lint multiple files, specify the hook multiple times with the appropriate overrides.
|
|
173
|
+
|
|
154
174
|
## Build an interactive HTML report
|
|
155
175
|
|
|
156
176
|
```
|