Skip to main content

Interface: FeaturesSupportedByReporter

Defined in: cspell-types/dist/index.d.mts:272

Allows the reporter to advertise which features it supports.

Properties​

contextGeneration?​

optional contextGeneration: boolean

Defined in: cspell-types/dist/index.d.mts:291

The reporter can generate context for issues.

  • true - the reporter will be called with issues that do NOT have a context property.
  • false | undefined - the reporter will be called with issues that have a context property.

issueType?​

optional issueType: boolean

Defined in: cspell-types/dist/index.d.mts:285

The reporter supports the Issue.issueType option.

  • true - the reporter will be called with all issues types.
  • false | undefined - only IssueType.spelling issues will be passed to the reporter.

unknownWords?​

optional unknownWords: boolean

Defined in: cspell-types/dist/index.d.mts:279

The reporter supports the ReportingConfiguration.unknownWords option and understands how to filter issues based upon Issue.isFlagged, Issue.hasSimpleSuggestions and Issue.hasPreferredSuggestions.

  • true - The reporter.issue method will be called for all spelling issues and it is expected to handle .
  • false | undefined - the unknown words will be filtered out based upon the unknownWords setting before being passed to the reporter.