Class: DocumentValidator
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:110
Constructors
Constructor
new DocumentValidator(
doc,options,settings):DocumentValidator
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:145
Parameters
doc
Document to validate
options
options controlling how the document is validated.
settings
configuration to use (not finalized).
Returns
DocumentValidator
Properties
errors
readonlyerrors:Error[] =[]
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:113
options
readonlyoptions:DocumentValidatorOptions
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:118
perfTiming
readonlyperfTiming:PerfTimings={}
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:119
settings
readonlysettings:CSpellSettings
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:148
configuration to use (not finalized).
skipValidation
skipValidation:
boolean
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:120
Accessors
document
Get Signature
get document():
TextDocument
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:463
Returns
prepTime
Get Signature
get prepTime():
number
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:316
The amount of time in ms to prepare for validation.
Returns
number
ready
Get Signature
get ready():
boolean
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:161
Returns
boolean
recordCheckedRanges
Get Signature
get recordCheckedRanges():
boolean
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:628
Returns
boolean
Set Signature
set recordCheckedRanges(
value):void
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:632
Parameters
value
boolean
Returns
void
validateDirectives
Get Signature
get validateDirectives():
boolean
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:320
Returns
boolean
Methods
_getPreparations()
_getPreparations():
Preparations|undefined
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:603
Internal cspell-lib use.
Returns
Preparations | undefined
check()
check(
parsedText):ValidationIssue[]
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:337
Parameters
parsedText
Returns
checkDocument()
checkDocument(
forceCheck?):ValidationIssue[]
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:421
Check a Document for Validation Issues.
Note: The validator must be prepared before calling this method.
Parameters
forceCheck?
boolean = false
force a check even if the document would normally be excluded.
Returns
the validation issues.
checkDocumentAsync()
checkDocumentAsync(
forceCheck?):Promise<ValidationIssue[]>
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:409
Check a Document for Validation Issues.
Parameters
forceCheck?
boolean
force a check even if the document would normally be excluded.
Returns
Promise<ValidationIssue[]>
the validation issues.
checkDocumentDirectives()
checkDocumentDirectives(
forceCheck?):ValidationIssue[]
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:441
Parameters
forceCheck?
boolean = false
Returns
checkText()
checkText(
range,_text,scope?):ValidationIssue[]
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:331
Check a range of text for validation issues.
Parameters
range
readonly [number, number]
the range of text to check.
_text
string | undefined
the text to check. If not given, the text will be taken from the document.
scope?
string | string[]
the scope to use for validation. If not given, the default scope will be used.
Returns
the validation issues.
getCheckedTextRanges()
getCheckedTextRanges():
MatchRange[]
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:614
Get the calculated ranges of text that should be included in the spell checking.
Use getRangesChecked to retrieve the ranges of text that have been checked.
Returns
MatchRange[]
MatchRanges of text to include.
getConfigErrors()
getConfigErrors():
ImportFileRefWithError[] |undefined
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:572
Returns
ImportFileRefWithError[] | undefined
getDictionaryErrors()
getDictionaryErrors():
Map<string,Error[]> |undefined
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:578
Returns
Map<string, Error[]> | undefined
getFinalizedDocSettings()
getFinalizedDocSettings():
CSpellSettingsInternal
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:566
Returns
CSpellSettingsInternal
getRangesChecked()
getRangesChecked():
Iterable<readonly [number,number]>
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:619
Returns
Iterable<readonly [number, number]>
prepare()
prepare():
Promise<void>
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:165
Returns
Promise<void>
shouldCheckDocument()
shouldCheckDocument():
boolean
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:595
Returns true if the final result of the configuration calculation results
in the document being enabled. Note: in some cases, checking the document
might still make sense, for example, the @cspell/eslint-plugin relies on
eslint configuration to make that determination.
Returns
boolean
true if the document settings have resolved to be enabled
traceWord()
traceWord(
word):TraceResult
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:473
Parameters
word
string
Returns
TraceResult
updateDocumentText()
updateDocumentText(
text):Promise<void>
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:467
Parameters
text
string
Returns
Promise<void>
create()
staticcreate(doc,options,settingsOrConfigFile):Promise<DocumentValidator>
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:127
Parameters
doc
options
settingsOrConfigFile
CSpellSettings | ICSpellConfigFile
Returns
Promise<DocumentValidator>