Use defineConfig for completion and option checking when composing a
Commitlint configuration. It returns the object unchanged; native JSDoc with
import('@commitlint/types').UserConfig or satisfies UserConfig avoids the
extra helper.
Only @commitlint/types 19–21 is a required peer; the helper does not import
the CLI or a rule preset. Install those separately when you run Commitlint.
Configuration execution and rule validation remain Commitlint's
responsibility.
bun i -D @archoleat/commitlint-define-config @commitlint/typesTo run conventional commit checks, also install @commitlint/cli and
@commitlint/config-conventional in your project. The helper itself does
not choose or install a rule preset.
This ES module is loaded by the host tool's configuration loader. Follow the Node.js requirements of that tool. Bun is used for repository tooling, not required to call the published helper.
Add the following code to the commitlint.config.ts or commitlint.config.js
file:
import { defineConfig } from '@archoleat/commitlint-define-config';
export default defineConfig({});Please read CONTRIBUTING to start contributing.
This project is licensed under the MIT license.