@cspell/cspell-json-reporter 6.1.2 → 6.1.3
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 -6
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -2,14 +2,28 @@
|
|
|
2
2
|
|
|
3
3
|
> CSpell reporter with JSON output
|
|
4
4
|
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Install it as a development package in the repository that will use it.
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install -SD @cspell/cspell-json-reporter
|
|
11
|
+
```
|
|
12
|
+
|
|
5
13
|
## Usage
|
|
6
14
|
|
|
7
|
-
Add this to
|
|
15
|
+
Add this to `cspell.yaml`:
|
|
8
16
|
|
|
17
|
+
```yaml
|
|
18
|
+
reporters: [['@cspell/cspell-json-reporter', { outFile: 'out.json' }]]
|
|
9
19
|
```
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
20
|
+
|
|
21
|
+
or `cspell.json`
|
|
22
|
+
|
|
23
|
+
```json
|
|
24
|
+
{
|
|
25
|
+
"reporters": [["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]
|
|
26
|
+
}
|
|
13
27
|
```
|
|
14
28
|
|
|
15
29
|
## Output file format
|
|
@@ -23,7 +37,7 @@ reporters: [
|
|
|
23
37
|
- `info` - CSpell execution logs if `settings.verbose` is enabled
|
|
24
38
|
- `debug` - CSpell debug logs if `settings.debug` is enabled
|
|
25
39
|
|
|
26
|
-
See [CSpellJSONReporterOutput](src/CSpellJSONReporterOutput.ts) for more info.
|
|
40
|
+
See [CSpellJSONReporterOutput](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-json-reporter/src/CSpellJSONReporterOutput.ts) for more info.
|
|
27
41
|
|
|
28
42
|
## Settings
|
|
29
43
|
|
|
@@ -34,4 +48,4 @@ Possible settings:
|
|
|
34
48
|
- `debug` (default: false) - enable saving of debug logs
|
|
35
49
|
- `progress` (default: false) - enable saving of file progress logs
|
|
36
50
|
|
|
37
|
-
See [CSpellJSONReporterSettings](src/CSpellJSONReporterSettings.ts) for more info.
|
|
51
|
+
See [CSpellJSONReporterSettings](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-json-reporter/src/CSpellJSONReporterSettings.ts) for more info.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cspell/cspell-json-reporter",
|
|
3
|
-
"version": "6.1.
|
|
3
|
+
"version": "6.1.3",
|
|
4
4
|
"description": "JSON reporter for CSpell",
|
|
5
5
|
"author": "Jason Dent",
|
|
6
6
|
"license": "MIT",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"update-snapshot": "jest --updateSnapshot"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@cspell/cspell-types": "^6.1.
|
|
41
|
+
"@cspell/cspell-types": "^6.1.3",
|
|
42
42
|
"mkdirp": "^1.0.4"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
@@ -47,5 +47,5 @@
|
|
|
47
47
|
"engines": {
|
|
48
48
|
"node": ">=14"
|
|
49
49
|
},
|
|
50
|
-
"gitHead": "
|
|
50
|
+
"gitHead": "e96b313542f2ec0a38ac04d1422d97e724ded3a6"
|
|
51
51
|
}
|