`@cspell/cspell-json-reporter`

CSpell reporter with JSON output

Installation

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

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

Usage

Add this to cspell.yaml:

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

or cspell.json

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

Output file format

@cspell/cspell-json-reporter emits a JSON file with the following fields:

issues - found spelling issues
result - CSpell linting results
error - CSell error messages
progress - file linting progress messages if settings.progress is enabled
info - CSpell execution logs if settings.verbose is enabled
debug - CSpell debug logs if settings.debug is enabled

<summary>JSON Output Definition</summary>

import type {
  ErrorLike,
  Issue,
  MessageType,
  ProgressFileComplete,
  ProgressItem,
  RunResult,
} from '@cspell/cspell-types';

export type CSpellJSONReporterOutput = {
  /**
   * Found spelling issues
   */
  issues: Array<Issue>;
  /**
   * CSpell execution logs
   */
  info?: Array<{ message: string; msgType: MessageType }>;
  /**
   * CSpell debug logs
   */
  debug?: Array<{ message: string }>;
  /**
   * CSpell error logs
   */
  error?: Array<{ message: string; error: ErrorLike }>;
  /**
   * CSpell file progress logs
   */
  progress?: Array<ProgressItem | ProgressFileComplete>;
  /**
   * Execution result
   */
  result: RunResult;
};

Settings

Possible settings:

outFile (required) - path for JSON file to emit
verbose (default: false) - enable saving of execution logs
debug (default: false) - enable saving of debug logs
progress (default: false) - enable saving of file progress logs

<summary>Reporter Settings</summary>

/**
 * CSpell-json-reporter settings type definition
 */
export type CSpellJSONReporterSettings = {
  /**
   * Path to the output file.
   *
   * Relative paths are relative to the current working directory.
   *
   * Special values:
   * - `stdout` - write the JSON to `stdout`.
   * - `stderr` - write the JSON to `stderr`.
   *
   * @default stdout
   */
  outFile?: string;
  /**
   * Add more information about the files being checked and the configuration
   * @default false
   */
  verbose?: boolean;
  /**
   * Add information useful for debugging cspell.json files
   * @default false
   */
  debug?: boolean;
  /**
   * Add progress messages
   * @default false
   */
  progress?: boolean;
};

Current Tags

5.21.2 ... cspell5 (3 years ago)
5.21.2-alpha.0 ... cspell5-next (3 years ago)
7.3.6 ... latest (a year ago)
7.0.1-alpha.9 ... next (a year ago)

156 Versions

7.3.6 ... a year ago
7.3.5 ... a year ago
7.3.4 ... a year ago
7.3.3 ... a year ago
7.3.2 ... a year ago
7.3.1 ... a year ago
7.3.0 ... a year ago
7.2.0 ... a year ago
7.1.1 ... a year ago
7.0.2 ... a year ago
7.0.1 ... a year ago
7.0.0 ... a year ago
7.0.1-alpha.9 ... a year ago
6.31.3 ... a year ago
7.0.1-alpha.8 ... a year ago
7.0.1-alpha.7 ... a year ago
7.0.1-alpha.6 ... a year ago
7.0.1-alpha.5 ... a year ago
7.0.1-alpha.4 ... a year ago
7.0.1-alpha.3 ... a year ago
7.0.1-alpha.2 ... a year ago
7.0.1-alpha.1 ... a year ago
7.0.1-alpha.0 ... a year ago
7.0.0-alpha.2 ... 2 years ago
7.0.0-alpha.1 ... 2 years ago
6.31.1 ... 2 years ago
6.31.0 ... 2 years ago
6.30.2 ... 2 years ago
6.30.1 ... 2 years ago
6.30.0 ... 2 years ago
6.29.3 ... 2 years ago
6.29.2 ... 2 years ago
6.29.1 ... 2 years ago
6.29.0 ... 2 years ago
6.28.0 ... 2 years ago
6.27.0 ... 2 years ago
6.26.3 ... 2 years ago
6.26.2 ... 2 years ago
6.26.1 ... 2 years ago
6.26.0 ... 2 years ago
6.25.0 ... 2 years ago
6.24.0 ... 2 years ago
6.23.1 ... 2 years ago
6.23.0 ... 2 years ago
6.22.0 ... 2 years ago
6.21.0 ... 2 years ago
6.20.1 ... 2 years ago
6.20.0 ... 2 years ago
6.19.2 ... 2 years ago
6.19.1 ... 2 years ago
6.19.0 ... 2 years ago
6.18.1 ... 2 years ago
6.18.0 ... 2 years ago
6.17.0 ... 2 years ago
6.16.0 ... 2 years ago
6.15.1 ... 2 years ago
6.15.0 ... 2 years ago
6.14.3 ... 2 years ago
6.14.2 ... 2 years ago
6.14.1 ... 2 years ago
6.14.0 ... 2 years ago
6.13.3 ... 2 years ago
6.13.2 ... 2 years ago
6.13.1 ... 2 years ago
6.13.0 ... 2 years ago
6.12.0 ... 2 years ago
6.11.1 ... 2 years ago
6.11.0 ... 2 years ago
6.10.1 ... 2 years ago
6.10.0 ... 2 years ago
6.9.1 ... 2 years ago
6.9.0 ... 2 years ago
6.8.2 ... 2 years ago
6.8.1 ... 2 years ago
6.8.0 ... 2 years ago
6.7.0 ... 2 years ago
6.6.1 ... 2 years ago
6.6.1-alpha.9 ... 2 years ago
6.6.1-alpha.2 ... 2 years ago
6.6.1-alpha.1 ... 2 years ago
6.6.1-alpha.0 ... 2 years ago
6.6.0 ... 2 years ago
6.5.0 ... 2 years ago
6.4.2 ... 2 years ago
6.4.1 ... 2 years ago
6.4.0 ... 2 years ago
6.4.0-alpha.0 ... 2 years ago
6.3.0 ... 2 years ago
6.2.4-alpha.0 ... 2 years ago
6.2.3 ... 2 years ago
6.2.2 ... 2 years ago
6.2.1 ... 2 years ago
6.2.0 ... 2 years ago
6.2.0-alpha.1 ... 2 years ago
6.2.0-alpha.0 ... 2 years ago
6.1.3 ... 2 years ago
6.1.3-alpha.1 ... 2 years ago
6.1.3-alpha.0 ... 2 years ago
6.1.2 ... 2 years ago
6.1.1 ... 3 years ago
6.1.0 ... 3 years ago
6.1.0-alpha.0 ... 3 years ago
5.21.2 ... 3 years ago
6.0.0 ... 3 years ago
5.21.2-alpha.0 ... 3 years ago
6.0.0-alpha.0 ... 3 years ago
5.21.1 ... 3 years ago
5.21.0 ... 3 years ago
5.20.0 ... 3 years ago
5.19.7 ... 3 years ago
5.19.6 ... 3 years ago
5.19.5 ... 3 years ago
5.19.4 ... 3 years ago
5.19.3 ... 3 years ago
5.19.2 ... 3 years ago
5.19.1 ... 3 years ago
5.19.0 ... 3 years ago
5.18.5 ... 3 years ago
5.18.4 ... 3 years ago
5.18.3 ... 3 years ago
5.18.2 ... 3 years ago
5.18.1 ... 3 years ago
5.18.0 ... 3 years ago
5.18.0-alpha.0 ... 3 years ago
5.17.0 ... 3 years ago
5.17.0-alpha.0 ... 3 years ago
5.16.0 ... 3 years ago
5.15.3 ... 3 years ago
5.15.2 ... 3 years ago
5.15.1 ... 3 years ago
5.15.0 ... 3 years ago
5.14.0 ... 3 years ago
5.14.0-alpha.0 ... 3 years ago
5.13.4 ... 3 years ago
5.13.3 ... 3 years ago
5.13.2 ... 3 years ago
5.13.1 ... 3 years ago
5.13.0 ... 3 years ago
5.12.6 ... 3 years ago
5.12.5 ... 3 years ago
5.12.4 ... 3 years ago
5.12.3 ... 3 years ago
5.12.2 ... 3 years ago
5.12.1 ... 3 years ago
5.12.0 ... 3 years ago
5.12.0-alpha.0 ... 3 years ago
5.11.1 ... 3 years ago
5.11.0 ... 3 years ago
5.11.0-alpha.0 ... 3 years ago
5.10.1 ... 3 years ago
5.10.0 ... 3 years ago
5.10.0-alpha.6 ... 3 years ago
5.10.0-alpha.5 ... 3 years ago
5.10.0-alpha.4 ... 3 years ago
5.10.0-alpha.3 ... 3 years ago
5.10.0-alpha.2 ... 3 years ago