Security News
RubyGems.org Adds New Maintainer Role
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
@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
cspell . --reporter @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
(default: stdout) - 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;
};
<small>8.10.4 (2024-07-05)</small>
FAQs
JSON reporter for CSpell
The npm package @cspell/cspell-json-reporter receives a total of 251,486 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 0 open source maintainers 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
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.