import { Component } from "projen";
import { NodeProject } from "projen/lib/javascript";
export interface CSpellDictionaryDefinition {
    /**
     * Some editor extensions will use `addWords` for adding words to your personal dictionary.
     */
    readonly addWords: boolean;
    /**
     * The name of the dictionary.
     */
    readonly name: string;
    /**
     * The path to the dictionary file.
     */
    readonly path: string;
}
export interface CSpellConfig {
    /**
     * Configuration format version of the settings file.
     *
     * This controls how the settings in the configuration file behave.
     *
     * @default "0.2"
     */
    readonly version?: "0.2" | "0.1";
    /**
     * Current active spelling language. This specifies the language locale to use in choosing the
     * general dictionary.
     *
     * For example:
     *
     * - "en-GB" for British English.
     * - "en,nl" to enable both English and Dutch.
     *
     * @default "en"
     */
    readonly language?: string;
    /**
     * words - list of words to be always considered correct
     */
    readonly words?: string[];
    /**
     * List of regular expression patterns or pattern names to exclude from spell checking.
     *
     * Example: `["href"]` - to exclude html href pattern.
     *
     * Regular expressions use JavaScript regular expression syntax.
     *
     * Example: to ignore ALL-CAPS words
     *
     * JSON
     * ```json
     * "ignoreRegExpList": ["/\\b[A-Z]+\\b/g"]
     * ```
     *
     * YAML
     * ```yaml
     * ignoreRegExpList:
     *   - >-
     *    /\b[A-Z]+\b/g
     * ```
     *
     * By default, several patterns are excluded. See
     * [Configuration](https://cspell.org/configuration/patterns) for more details.
     *
     * While you can create your own patterns, you can also leverage several patterns that are
     * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
     */
    readonly ignoreRegExpList?: string[];
    /**
     * flagWords - list of words to be always considered incorrect
     * This is useful for offensive words and common spelling errors. (e.g. "hte" and "thier")
     */
    readonly flagWords?: string[];
    /**
     * Define custom dictionaries.
     */
    readonly dictionaryDefinitions?: CSpellDictionaryDefinition[];
    /**
     * Custom dictionaries to use.
     */
    readonly dictionaries?: string[];
    /**
     * Globs of files to ignore.
     */
    readonly ignorePaths?: string[];
}
export interface CSpellConfigFileOptions {
    readonly config?: CSpellConfig;
}
export declare class CSpellConfigFile extends Component {
    readonly config: CSpellConfig;
    constructor(project: NodeProject, options?: CSpellConfigFileOptions);
}
export interface CSpellOptions extends CSpellConfigFileOptions {
    /**
     * Whether or not to enable cSpell in eslint.
     *
     * @default true
     */
    readonly eslint?: boolean;
}
export declare class CSpell extends Component {
    constructor(project: NodeProject, options?: CSpellOptions);
}