Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
@cspell/cspell-json-reporter
Advanced tools
@cspell/cspell-json-reporter
CSpell reporter with JSON output
Install it as a development package in the repository that will use it.
npm install -SD @cspell/cspell-json-reporter
Add this to cspell.yaml
:
reporters: [['@cspell/cspell-json-reporter', { outFile: 'out.json' }]]
or cspell.json
{
"reporters": [["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]
}
@cspell/cspell-json-reporter
emits a JSON file with the following fields:
issues
- found spelling issuesresult
- CSpell linting resultserror
- CSell error messagesprogress
- file linting progress messages if settings.progress
is enabledinfo
- CSpell execution logs if settings.verbose
is enableddebug
- CSpell debug logs if settings.debug
is enabledimport 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;
};
Possible settings:
outFile
(required) - path for JSON file to emitverbose
(default: false) - enable saving of execution logsdebug
(default: false) - enable saving of debug logsprogress
(default: false) - enable saving of file progress logs/**
* 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;
};
FAQs
JSON reporter for CSpell
The npm package @cspell/cspell-json-reporter receives a total of 437,336 weekly downloads. As such, @cspell/cspell-json-reporter popularity was classified as popular.
We found that @cspell/cspell-json-reporter demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.