@cspell/cspell-json-reporter 8.4.1 → 8.6.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.
Files changed (2) hide show
  1. package/README.md +9 -1
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -12,6 +12,14 @@ npm install -SD @cspell/cspell-json-reporter
12
12
 
13
13
  ## Usage
14
14
 
15
+ ### Using Command Line
16
+
17
+ ```sh
18
+ cspell . --reporter @cspell/cspell-json-reporter
19
+ ```
20
+
21
+ ### Using CSpell Configuration
22
+
15
23
  Add this to `cspell.yaml`:
16
24
 
17
25
  ```yaml
@@ -88,7 +96,7 @@ export type CSpellJSONReporterOutput = {
88
96
 
89
97
  Possible settings:
90
98
 
91
- - `outFile` (required) - path for JSON file to emit
99
+ - `outFile` (default: stdout) - path for JSON file to emit
92
100
  - `verbose` (default: false) - enable saving of execution logs
93
101
  - `debug` (default: false) - enable saving of debug logs
94
102
  - `progress` (default: false) - enable saving of file progress logs
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/cspell-json-reporter",
3
- "version": "8.4.1",
3
+ "version": "8.6.0",
4
4
  "description": "JSON reporter for CSpell",
5
5
  "author": "Jason Dent",
6
6
  "license": "MIT",
@@ -44,10 +44,10 @@
44
44
  "watch": "tsc -b . -w"
45
45
  },
46
46
  "dependencies": {
47
- "@cspell/cspell-types": "8.4.1"
47
+ "@cspell/cspell-types": "8.6.0"
48
48
  },
49
49
  "engines": {
50
50
  "node": ">=18"
51
51
  },
52
- "gitHead": "d57dbadb81b859d659c578cd8e81ac5dbcbaae8c"
52
+ "gitHead": "78eadb48e8ab400f4fcd159344c5b15968d7ab2e"
53
53
  }