Function: shouldCheckDocument()
shouldCheckDocument(
doc,options,settings):Promise<ShouldCheckDocumentResult>
Defined in: packages/cspell-lib/src/lib/textValidation/docValidator.ts:719
Check if a document should be checked based upon the ignorePaths and override settings.
This function will search and fetch settings based upon the location of the document if noConfigSearch is not true.
Parameters
doc
document to check
options
options to override some of the settings.
settings
current settings
Returns
Promise<ShouldCheckDocumentResult>
ShouldCheckDocumentResult