Configuration

The init command creates a commitlint.config.mjs in your project root.

Default config

commitlint.config.mjs

import { museletPlugin, museletRules } from '@muselet/commitlint-plugin';

export default {
  plugins: [museletPlugin],
  rules: {
    ...museletRules,
  },
};

Custom rules

You can override individual rules by spreading museletRules and replacing specific entries:

commitlint.config.mjs

import { museletPlugin, museletRules } from '@muselet/commitlint-plugin';

export default {
  plugins: [museletPlugin],
  rules: {
    ...museletRules,
    // Make "Metrics" required for perf commits
    'muselet-perf-sections': [2, 'always', { required: ['Why', 'Metrics', 'Approach'] }],
  },
};