/** * @packageDocumentation * Synchronous cspell-backed spellchecking for projected comment prose. */ import { type SpellingDictionaryCollection } from "cspell-dictionary"; /** Resource references imported by default for comment spellchecking. */ export declare const defaultSpellcheckCspellConfigImports: readonly ["@cspell/dict-bash/cspell-ext.json", "@cspell/dict-companies/cspell-ext.json", "@cspell/dict-css/cspell-ext.json", "@cspell/dict-en-au/cspell-ext.json", "@cspell/dict-en-ca/cspell-ext.json", "@cspell/dict-en-common-misspellings/cspell-ext.json", "@cspell/dict-en-gb-ise/cspell-ext.json", "@cspell/dict-en-gb-legacy/cspell-ext.json", "@cspell/dict-en-gb/cspell-ext.json", "@cspell/dict-en_us/cspell-ext.json", "@cspell/dict-filetypes/cspell-ext.json", "@cspell/dict-git/cspell-ext.json", "@cspell/dict-html/cspell-ext.json", "@cspell/dict-makefile/cspell-ext.json", "@cspell/dict-mime-types/cspell-ext.json", "@cspell/dict-mnemonics/cspell-ext.json", "@cspell/dict-node/cspell-ext.json", "@cspell/dict-npm/cspell-ext.json", "@cspell/dict-people-names/cspell-ext.json", "@cspell/dict-powershell/cspell-ext.json", "@cspell/dict-public-licenses/cspell-ext.json", "@cspell/dict-scientific-terms-us/cspell-ext.json", "@cspell/dict-shell/cspell-ext.json", "@cspell/dict-software-terms/cspell-ext.json", "@cspell/dict-sql/cspell-ext.json", "@cspell/dict-typescript/cspell-ext.json", "@cspell/dict-win32/cspell-ext.json"]; /** Result returned when constructing one spellcheck dictionary collection. */ export type SpellcheckCspellDictionaryCollectionResult = Readonly<{ collection: SpellingDictionaryCollection; errors: readonly SpellcheckCspellResourceError[]; }>; /** Options used to build one cspell-backed dictionary collection. */ export type SpellcheckCspellDictionaryOptions = Readonly<{ configImports?: readonly string[]; cwd: string; ignoreWordFiles?: readonly string[]; ignoreWords?: readonly string[]; locale?: string; useDefaultDictionaries?: boolean; }>; /** One issue produced by the synchronous cspell spellchecker. */ export type SpellcheckCspellIssue = Readonly<{ endOffset: number; reason: string; startOffset: number; }>; /** One cspell resource load problem. */ export type SpellcheckCspellResourceError = Readonly<{ message: string; resource: string; }>; /** Options that control one projected-text spellcheck run. */ export type SpellcheckProjectedTextOptions = Readonly<{ ignoreDigits: boolean; ignoreLiteral: boolean; maxSuggestions: number; normalizeApostrophes: boolean; }>; /** * Build one cspell-backed dictionary collection for spellcheck-comments. * * @param options - Rule options that influence imported dictionaries. * * @returns The assembled collection plus any resource load problems. */ export declare const createSpellcheckCspellDictionaryCollection: (options: Readonly) => SpellcheckCspellDictionaryCollectionResult; /** * Spellcheck projected markdown text with the assembled cspell dictionaries. * * @param text - Projected markdown comment text. * @param collection - Prebuilt cspell dictionary collection. * @param options - Runtime spellcheck behavior. * * @returns Stable issue offsets and human-readable reasons. */ export declare const spellcheckProjectedTextWithCspell: (text: string, collection: Readonly, options: Readonly) => readonly SpellcheckCspellIssue[]; //# sourceMappingURL=spellcheck-cspell.d.ts.map