Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CSpell

adds cSpell to the project

Hierarchy

  • Component
    • CSpell

Index

Constructors

Properties

Methods

Constructors

constructor

  • adds cSpell to the project

    Parameters

    • project: NodeProject

      the project to add to

    • Optional options: Dynamic<CSpellOptions, NodeProject>

      see CommitLintOptions

    Returns CSpell

Properties

Optional cSpellConfigFile

cSpellConfigFile?: JsonFile

options

options: RequiredCSpellOptions

Readonly project

project: Project

Static defaultOptions

defaultOptions: Dynamic<RequiredCSpellOptions, NodeProject> = ...

Methods

addWords

  • addWords(...words: string[]): void

  • adds words to the dictionary

    Parameters

    • Rest ...words: string[]

      words to add to the dictionary

    Returns void

postSynthesize

  • postSynthesize(): void

  • Called after synthesis. Order is not guaranteed.

    Returns void

preSynthesize

  • preSynthesize(): void

  • Called before synthesis.

    Returns void

synthesize

  • synthesize(): void

  • Synthesizes files to the project output directory.

    Returns void

Generated using TypeDoc