noForbiddenPatternsRule

Checks the whole commit message — header, body and footer — against the forbidden patterns.

Only the always condition is meaningful: never would require every line to carry a forbidden pattern, so it is treated the same way rather than inverted.

Import:

import { noForbiddenPatternsRule } from 'obsidian-dev-utils/script-utils/commitlint-forbidden-patterns';

Signature:

function noForbiddenPatternsRule(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 offending line and what matched.

---

Links to this page:

• forbiddenPatternsPlugin