@quobix/vacuum 0.3.4 → 0.3.6
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 +31 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -314,5 +314,36 @@ The `lint`, `dashboard` and `spectral-report` commands all accept a `-r` or `--r
|
|
|
314
314
|
|
|
315
315
|
---
|
|
316
316
|
|
|
317
|
+
## Configuration
|
|
318
|
+
|
|
319
|
+
### File
|
|
320
|
+
You can configure vacuum using a configuration file named `vacuum.conf.yaml`
|
|
321
|
+
|
|
322
|
+
By default, vacuum searches for this file in the following directories
|
|
323
|
+
1. Working directory
|
|
324
|
+
2. `$XDG_CONFIG_HOME`
|
|
325
|
+
3. `${HOME}/.config`
|
|
326
|
+
|
|
327
|
+
You can also specify a path to a file using the `--config` flag
|
|
328
|
+
|
|
329
|
+
Global flags are configured as top level nodes
|
|
330
|
+
```yaml
|
|
331
|
+
time: true
|
|
332
|
+
base: 'http://example.com'
|
|
333
|
+
...
|
|
334
|
+
```
|
|
335
|
+
Command specific flags are configured under a node with the commands name
|
|
336
|
+
```yaml
|
|
337
|
+
...
|
|
338
|
+
lint:
|
|
339
|
+
silent: true
|
|
340
|
+
...
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### Environmental variables
|
|
344
|
+
|
|
345
|
+
You can configure global vacuum flags using environmental variables in the form of: `VACUUM_<flag>`
|
|
346
|
+
|
|
347
|
+
If a flag, has a `-` in it, replace with `_`
|
|
317
348
|
|
|
318
349
|
> Logo gopher is modified, originally from [egonelbre](https://github.com/egonelbre/gophers)
|