commitlint.config.mjs

export default {
    /* Resolve and load @commitlint/config-conventional from node_modules.
       Referenced packages must be installed */
    extends: ["@commitlint/config-conventional"],
    rules: {
        "body-max-line-length": [0, "always", 100],
        "footer-max-line-length": [0, "always", 100],
    },
    /* Array of functions that return true if commitlint should ignore the given message.
       Given array is merged with predefined functions, which consist of matchers like:
       
       - 'Merge pull request', 'Merge X into Y' or 'Merge branch X'
       - 'Revert X'
       - 'v1.2.3' (ie semver matcher)
       - 'Automatic merge X' or 'Auto-merged X into Y'
       
       To see full list, check https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/is-ignored/src/defaults.ts.
       To disable those ignores and run rules always, set `defaultIgnores: false` as shown below. */
    ignores: [
        function (commit) {
            return commit === "";
        },
    ],
    /* Whether commitlint uses the default ignore rules, see the description above. */
    defaultIgnores: true,
    /* Custom URL to show upon failure */
    helpUrl: "https://github.com/conventional-changelog/commitlint/#what-is-commitlint",
    /* Custom prompt configs */
    prompt: {
        questions: {
            type: {
                description: "Select the type of change that you're committing",
                enum: {
                    feat: {
                        description: "A new feature",
                        title: "Features",
                        emoji: "✨",
                    },
                    fix: {
                        description: "A bug fix",
                        title: "Bug Fixes",
                        emoji: "🐛",
                    },
                    docs: {
                        description: "Documentation only changes",
                        title: "Documentation",
                        emoji: "📚",
                    },
                    style: {
                        description: "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)",
                        title: "Styles",
                        emoji: "💎",
                    },
                    refactor: {
                        description: "A code change that neither fixes a bug nor adds a feature",
                        title: "Code Refactoring",
                        emoji: "📦",
                    },
                    perf: {
                        description: "A code change that improves performance",
                        title: "Performance Improvements",
                        emoji: "🚀",
                    },
                    test: {
                        description: "Adding missing tests or correcting existing tests",
                        title: "Tests",
                        emoji: "🚨",
                    },
                    build: {
                        description: "Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)",
                        title: "Builds",
                        emoji: "🛠",
                    },
                    ci: {
                        description: "Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)",
                        title: "Continuous Integrations",
                        emoji: "⚙️",
                    },
                    chore: {
                        description: "Other changes that don't modify src or test files",
                        title: "Chores",
                        emoji: "♻️",
                    },
                    revert: {
                        description: "Reverts a previous commit",
                        title: "Reverts",
                        emoji: "🗑",
                    },
                },
            },
            scope: {
                description: "What is the scope of this change (e.g. component or file name)",
            },
            subject: {
                description: "Write a short, imperative tense description of the change",
            },
            body: {
                description: "Provide a longer description of the change",
            },
            isBreaking: {
                description: "Are there any breaking changes?",
            },
            breakingBody: {
                description: "A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself",
            },
            breaking: {
                description: "Describe the breaking changes",
            },
            isIssueAffected: {
                description: "Does this change affect any open issues?",
            },
            issuesBody: {
                description: "If issues are closed, the commit requires a body. Please enter a longer description of the commit itself",
            },
            issues: {
                description: 'Add issue references (e.g. "fix #123", "re #123".)',
            },
        },
    },
};