@commitlint/rules/lib/subject-case.js

Lint your commit messages

import { case as ensureCase } from "@commitlint/ensure";
import message from "@commitlint/message";
/**
 * Since the rule requires first symbol of a subject to be a letter, use
 * Unicode `Cased_Letter` category now to allow non-Latin alphabets as well.
 *
 * Do not use `Letter` category directly to avoid capturing `Modifier_Letter`
 * (which just modifiers letters, so we probably shouldn't anyway) and
 * `Other_Letter` (they actually are case-less, so they can't be validated)
 * categories, and to stay close to previous implementation.
 *
 * Also, typescript does not seem to support almost any longhand category name
 * (and even short for `Cased_Letter` too) so list all required letter
 * categories manually just to prevent it from complaining about unknown stuff.
 *
 * @see [Unicode Categories]{@link https://www.regular-expressions.info/unicode.html}
 */
const startsWithLetterRegex = /^[\p{Ll}\p{Lu}\p{Lt}]/iu;
const negated = (when) => when === "never";
export const subjectCase = (parsed, when = "always", value = []) => {
    const { subject } = parsed;
    if (typeof subject !== "string" || !subject.match(startsWithLetterRegex)) {
        return [true];
    }
    const checks = (Array.isArray(value) ? value : [value]).map((check) => {
        if (typeof check === "string") {
            return {
                when: "always",
                case: check,
            };
        }
        return check;
    });
    const matches = checks.filter((check) => {
        const r = ensureCase(subject, check.case);
        return negated(check.when) ? !r : r;
    });
    const result = matches.length > 0;
    // A `never` rule fails because a case matched, so report the case(s) that
    // did. An `always` rule fails because none matched, so it keeps reporting
    // every configured case.
    const reported = negated(when) && result ? matches : checks;
    const list = reported.map((c) => c.case).join(", ");
    return [
        negated(when) ? !result : result,
        message([`subject must`, negated(when) ? `not` : null, `be ${list}`]),
    ];
};
//# sourceMappingURL=subject-case.js.map