Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Update reporter README #3113

Merged
merged 2 commits into from
Jun 23, 2022
Merged

fix: Update reporter README #3113

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e468880
fix: Update reporter README
Jason3S Jun 23, 2022
12bec6f
Update README.md
Jason3S Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions packages/cspell-json-reporter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,28 @@

> CSpell reporter with JSON output

## Installation

Install it as a development package in the repository that will use it.

```sh
npm install -SD @cspell/cspell-json-reporter
```

## Usage

Add this to cSpell.json:
Add this to `cspell.yaml`:

```yaml
reporters: [['@cspell/cspell-json-reporter', { outFile: 'out.json' }]]
```
reporters: [
['@cspell/cspell-json-reporter', { outFile: 'out.json' }]
]

or `cspell.json`

```json
{
"reporters": [["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]
}
```

## Output file format
Expand All @@ -23,7 +37,7 @@ reporters: [
- `info` - CSpell execution logs if `settings.verbose` is enabled
- `debug` - CSpell debug logs if `settings.debug` is enabled

See [CSpellJSONReporterOutput](src/CSpellJSONReporterOutput.ts) for more info.
See [CSpellJSONReporterOutput](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-json-reporter/src/CSpellJSONReporterOutput.ts) for more info.

## Settings

Expand All @@ -34,4 +48,4 @@ Possible settings:
- `debug` (default: false) - enable saving of debug logs
- `progress` (default: false) - enable saving of file progress logs

See [CSpellJSONReporterSettings](src/CSpellJSONReporterSettings.ts) for more info.
See [CSpellJSONReporterSettings](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-json-reporter/src/CSpellJSONReporterSettings.ts) for more info.