cspell-lib
Namespaces
Enumerations
Classes
- CSpellConfigFile
- DocumentValidator
- FeatureFlags
- ImportError
- SpellingDictionaryLoadError
- SuggestionError
- UnknownFeatureFlagError
Interfaces
- AdvancedCSpellSettingsWithSourceTrace
- BaseSetting
- CacheSettings
- CharacterSetCosts
- CheckTextInfo
- CommandLineSettings
- ConfigurationDependencies
- CreateTextDocumentParams
- CSpellReporter
- CSpellReporterModule
- CSpellSettings
- CSpellSettingsWithSourceTrace
- DetermineFinalDocumentSettingsResult
DictionaryDefinitionAlternate- DictionaryDefinitionAugmented
- DictionaryDefinitionBase
- DictionaryDefinitionCustom
- DictionaryDefinitionInlineFlagWords
- DictionaryDefinitionInlineIgnoreWords
- DictionaryDefinitionInlineWords
- DictionaryDefinitionPreferred
- DictionaryInformation
- Document
- DocumentValidatorOptions
- EditCosts
- ExcludeFilesGlobMap
- ExtendableSettings
- FeatureFlag
- Features
- FileSettings
- FileSource
- ICSpellConfigFile
- ImportFileRef
- ImportFileRefWithError
- IncludeExcludeOptions
- InMemorySource
- Issue
- LanguageSetting
- LanguageSettingFilterFields
- LanguageSettingFilterFieldsDeprecated
- LanguageSettingFilterFieldsPreferred
LegacySettings- Logger
- MergeSource
- OverrideFilterFields
- OverrideSettings
- ParsedText
- Parser
- ParseResult
- PerfTimer
- Plugin
- PnPSettings
- ProgressBase
- ProgressFileBase
- ProgressFileBegin
- ProgressFileComplete
- RegExpPatternDefinition
- ReporterConfiguration
- ReportingConfiguration
- RunResult
- Settings
- SpellCheckFileOptions
- SpellCheckFilePerf
- SpellCheckFileResult
- SpellingDictionary
- SpellingDictionaryCollection
- SuggestedWord
- SuggestionCollector
- SuggestionOptions
- SuggestionResult
- SuggestionsConfiguration
- SuggestionsForWordResult
- SuggestOptions
- TextDocument
- TextDocumentLine
- TextDocumentOffset
- TextDocumentRef
- TextInfoItem
- TextOffset
- TraceOptions
- TraceResult
- TraceWordResult
- ValidationIssue
- VFileSystemProvider
- VirtualFS
- WorkspaceTrustSettings
Type Aliases
- CacheFormat
- CacheStrategy
- CharacterSet
- CSpellPackageSettings
- CSpellUserSettings
- CSpellUserSettingsFields
- CSpellUserSettingsWithComments
- CustomDictionaryPath
- CustomDictionaryScope
- DebugEmitter
- DictionaryDefinition
- DictionaryDefinitionInline
- DictionaryFileTypes
- DictionaryId
- DictionaryNegRef
- DictionaryPath
- DictionaryRef
- DictionaryReference
- ErrorEmitter
- ErrorLike
- ExclusionFunction
- Feature
- FsPath
- FSPathResolvable
- Glob
- LanguageId
- LanguageIdMultiple
- LanguageIdMultipleNeg
- LanguageIdSingle
- LocaleId
LocalId- MappedText
- MatchingFileType
- MessageEmitter
- MessageType
- MessageTypeLookup
- ParserName
- ParserOptions
- Pattern
- PatternId
- PatternRef
- PredefinedPatterns
- ProgressEmitter
- ProgressItem
- ProgressTypes
- RegExpPatternList
- ReplaceEntry
- ReplaceMap
- ReporterSettings
- ResultEmitter
- SimpleGlob
- Source
- SpellingErrorEmitter
- SuggestionCostMapDef
- SuggestionCostsDefs
- TrustLevel
- Version
- VersionLatest
VersionLegacy
Variables
- ConfigFields
- currentSettingsFileVersion
- defaultConfigFilenames
- defaultCSpellSettings
- defaultFileName
- ENV_CSPELL_GLOB_ROOT
- MessageTypes
- sectionCSpell
Functions
- asyncIterableToArray
- calcOverrideSettings
- checkFilenameMatchesGlob
checkText- checkTextDocument
- clearCachedFiles
- clearCaches
- combineTextAndLanguageSettings
- createConfigLoader
- createPerfTimer
- createSpellingDictionary
- createSpellingDictionaryCollection
- createTextDocument
- defineConfig
- determineFinalDocumentSettings
- extractDependencies
- extractImportErrors
- fileToDocument
- fileToTextDocument
- finalizeSettings
- getCachedFileSize
- getDefaultBundledSettingsAsync
- getDefaultConfigLoader
- getDefaultSettings
- getDictionary
getGlobalSettings- getGlobalSettingsAsync
- getLanguageIdsForBaseFilename
- getLanguagesForExt
- getLogger
- getSources
- getSystemFeatureFlags
- getVirtualFS
- isBinaryFile
- isSpellingDictionaryLoadError
- loadConfig
- loadPnP
- mergeInDocSettings
- mergeSettings
- readConfigFile
- readFile
- readFileSync
- readRawSettings
- readSettings
readSettingsFiles- refreshDictionaryCache
- resolveConfigFileImports
- resolveFile
- searchForConfig
- setLogger
- shouldCheckDocument
- spellCheckDocument
- spellCheckFile
- suggestionsForWord
- suggestionsForWords
- traceWords
- traceWordsAsync
- updateTextDocument
validateText- writeToFile
- writeToFileIterable
References
constructSettingsForText
Renames and re-exports combineTextAndLanguageSettings
defaultSettingsFilename
Renames and re-exports defaultFileName
writeToFileIterableP
Renames and re-exports writeToFileIterable