obsidian-dev-utils/dist/lib/esm/ScriptUtils/spellcheck.d.mts

This is the collection of useful functions that you can use for your Obsidian plugin development

/**
 * @packageDocumentation
 *
 * This module provides a function for running a spellcheck on the codebase using the `cspell` library.
 * It reports any spelling issues found in the code and returns a {@link CliTaskResult} indicating whether the spellcheck was successful.
 */
/**
 * 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.
 *
 * @returns A {@link Promise} that resolves to a {@link CliTaskResult}, indicating the success or failure of the spellcheck.
 */
export declare function spellcheck(): Promise<void>;