cspell-lib
Namespaces
Enumerations
Classes
- DocumentValidator
- FeatureFlags
- ImportError
- SpellingDictionaryLoadError
- SuggestionError
- UnknownFeatureFlagError
Interfaces
- AdvancedCSpellSettingsWithSourceTrace
- AvailableParsers
- BaseSetting
- CacheSettings
- CharacterSetCosts
- CheckTextInfo
- CommandLineSettings
- ConfigurationDependencies
- CreateTextDocumentParams
- CSpellConfigFile
- CSpellPlugin
- CSpellReporter
- CSpellReporterEmitters
- CSpellReporterModule
- CSpellSettings
- CSpellSettingsWithSourceTrace
- CSpellVFSFile
- CSpellVFSFileEntry
- DetermineFinalDocumentSettingsResult
DictionaryDefinitionAlternate- DictionaryDefinitionAugmented
- DictionaryDefinitionBase
- DictionaryDefinitionCustom
- DictionaryDefinitionInlineFlagWords
- DictionaryDefinitionInlineIgnoreWords
- DictionaryDefinitionInlineWords
- DictionaryDefinitionPreferred
- DictionaryDefinitionSimple
- DictionaryInformation
- DictionaryReferenceCollection
- Document
- DocumentParser
- DocumentValidatorOptions
- EditCosts
- ExcludeFilesGlobMap
- ExtendableSettings
- FeatureFlag
- Features
- FeaturesSupportedByReporter
- FileSettings
- FileSource
- ICSpellConfigFile
- ImportFileRef
- ImportFileRefWithError
- IncludeExcludeOptions
- InMemorySource
- Issue
- LanguageSetting
- LanguageSettingFilterFields
- LanguageSettingFilterFieldsDeprecated
- LanguageSettingFilterFieldsPreferred
LegacySettings- Logger
- MergeSource
- OverrideFilterFields
- OverrideSettings
- ParsedTags
- ParsedText
- Parser
- ParseResult
- PerfTimer
- PnPSettings
- ProgressBase
- ProgressFileBase
- ProgressFileBegin
- ProgressFileComplete
- RegExpPatternDefinition
- ReporterConfiguration
- ReportingConfiguration
- ReportIssueOptions
- RunResult
- Settings
- SoftWordBreakDefinitions
- SoftWordBreaks
- SpellCheckFileOptions
- SpellCheckFilePerf
- SpellCheckFileResult
- SpellingDictionary
- SpellingDictionaryCollection
- SubstitutionDefinition
- SuggestedWord
- SuggestionCollector
- SuggestionOptions
- SuggestionResult
- SuggestionsConfiguration
- SuggestionsForWordResult
- SuggestOptions
- TextDocument
- TextDocumentFragment
- TextDocumentLine
- TextDocumentOffset
- TextDocumentRef
- TextInfoItem
- TextOffset
- TraceOptions
- TraceResult
- TraceWordResult
- UnknownWordsConfiguration
- ValidationIssue
- ValidationTags
- VFileSystemProvider
- VirtualFS
- WordSegmentationSettings
- WorkspaceTrustSettings
Type Aliases
- CacheFormat
- CacheStrategy
- CharacterSet
- CompoundWordsMethod
- CreateParser
- CSpellPackageSettings
- CSpellUserSettings
- CSpellUserSettingsFields
- CSpellUserSettingsWithComments
- CSpellVFS
- CSpellVFSData
- CSpellVFSFileUrl
- CSpellVFSTextData
- 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
- ParsedTag
- ParserName
- ParserOptions
- Parsers
- Pattern
- PatternId
- PatternRef
- PredefinedPatterns
- ProgressEmitter
- ProgressItem
- ProgressTypes
- Range
- RegExpPatternList
- ReplaceEntry
- ReplaceMap
- ReporterSettings
- ResultEmitter
- SimpleGlob
- SoftWordBreak
- SoftWordBreakPattern
- SoftWordBreakRegExpString
- SoftWordBreakRule
- Source
- SourceMap
- SpellingErrorEmitter
- SubstitutionDefinitions
- SubstitutionEntry
- SubstitutionID
- Substitutions
- SuggestionCostMapDef
- SuggestionCostsDefs
- TagPattern
- TrustLevel
- UnknownWordsChoices
- Version
- VersionLatest
VersionLegacy
Variables
- CompoundWordsMethod
- ConfigFields
- currentSettingsFileVersion
- defaultConfigFilenames
- defaultCSpellSettings
- defaultFileName
- ENV_CSPELL_GLOB_ROOT
- MessageTypes
- sectionCSpell
- unknownWordsChoices
Functions
- asyncIterableToArray
- calcOverrideSettings
- checkFilenameMatchesGlob
checkText- checkTextDocument
- clearCachedFiles
- clearCaches
- combineTextAndLanguageSettings
- createConfigLoader
- createDictionaryReferenceCollection
- 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
- mergeConfig
- mergeInDocSettings
- mergeSettings
- readConfigFile
- readFile
- readFileSync
- readRawSettings
- readSettings
readSettingsFiles- refreshDictionaryCache
- resolveConfigFileImports
- resolveFile
- searchForConfig
- setLogger
- shouldCheckDocument
- spellCheckDocument
- spellCheckDocumentRPC
- spellCheckFile
- suggestionsForWord
- suggestionsForWords
- toCSpellSettingsWithOutSourceTrace
- traceWords
- traceWordsAsync
- updateTextDocument
validateText- writeToFile
- writeToFileIterable
References
constructSettingsForText
Renames and re-exports combineTextAndLanguageSettings
defaultSettingsFilename
Renames and re-exports defaultFileName
Plugin
Renames and re-exports CSpellPlugin
writeToFileIterableP
Renames and re-exports writeToFileIterable