/** * @packageDocumentation * ESLint rule that spellchecks source comments with cspell dictionaries. */ import type { TSESLint } from "@typescript-eslint/utils"; /** Message ids emitted by this rule. */ type MessageIds = "dictionaryLoadFailed" | "problem"; /** Configurable rule options tuple. */ type Options = [SpellcheckCommentsOptions?]; /** Extra docs metadata carried by this plugin's rules. */ type PluginDocs = Readonly<{ recommended: boolean; }>; /** Configurable spellcheck rule options. */ type SpellcheckCommentsOptions = Readonly<{ cspellConfigImports?: readonly string[]; ignoreDigits?: boolean; ignoreLiteral?: boolean; ignoreWordFiles?: readonly string[]; ignoreWords?: readonly string[]; maxSuggestions?: number; normalizeApostrophes?: boolean; useDefaultDictionaries?: boolean; }>; /** Create the runtime spellcheck-comments rule. */ declare const spellcheckCommentsRule: TSESLint.RuleModule; export default spellcheckCommentsRule; //# sourceMappingURL=spellcheck-comments.d.ts.map