spellcheckHeaderRule

Spellchecks the commit header as the changelog bullet it will become.

Only the always condition is meaningful: never would require the header to be misspelled, so it is treated the same way rather than inverted.

Import:

import { spellcheckHeaderRule } from 'obsidian-dev-utils/script-utils/commitlint-spellcheck-header';

Signature:

function spellcheckHeaderRule(commit: Commit): Promise<readonly [boolean, string?]>

Parameters:

Parameter	Type	Description
commit	Commit	The parsed commit.

Returns: Promise<readonly [boolean, string?]> — A Promise that resolves to the rule outcome, naming each unknown word.

---

Links to this page:

• spellcheckHeaderPlugin