import { CSpellSettings } from "@cspell/cspell-types"; import { Component, JsonFile } from "projen"; import { NodeProject } from "projen/lib/javascript"; import { Dynamic } from "../util/dynamic"; /** * option to enable or disable cSpell and cSpell options */ export declare type CSpellOptions = { /** * enable or disable cSpell * * @default true */ cSpell?: boolean; cSpellOptions?: CSpellSettings; }; /** * like CSpellOptions but with required fields */ declare type RequiredCSpellOptions = Required> & { cSpellOptions: Omit & Required>; }; /** * adds cSpell to the project * */ export declare class CSpell extends Component { static defaultOptions: Dynamic; options: RequiredCSpellOptions; cSpellConfigFile?: JsonFile; /** * adds cSpell to the project * * @param project the project to add to * @param options - see `CommitLintOptions` */ constructor(project: NodeProject, options?: Dynamic); /** * Called before synthesis. */ preSynthesize(): void; /** * adds words to the dictionary * * @param {...any} words words to add to the dictionary */ addWords(...words: string[]): void; } export {};