spellcheck
Runs a spellcheck on the entire codebase using cspell.
Checks all files in the current folder and its subfolders for spelling issues. If issues are found, they are logged to the console with their file path, line, and column number.
Uses --no-must-find-files so that cspell does not fail when all provided paths are excluded by built-in ignore rules (e.g., package-lock.json).
Import:
import { spellcheck } from 'obsidian-dev-utils/script-utils/linters/cspell';Signature:
function spellcheck(options: SpellcheckOptions | undefined): Promise<void>Parameters:
| Parameter | Type | Description |
|---|---|---|
options | SpellcheckOptions | undefined | The SpellcheckOptions. |
Returns: Promise<void> — A Promise that resolves to a CliTaskResult, indicating the success or failure of the spellcheck.
Links to this page: