Skip to content

About

Typed defineConfig helper for Commitlint configuration and editor completion.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

51 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Commitlint Define Config

NPM Version NPM Downloads Specs Commitlint Editorconfig Prettier ESLint Remark Zero Deps

Table of Contents

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.

Installation

bun i -D @archoleat/commitlint-define-config @commitlint/types

To 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.

Runtime

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.

Usage

See Commitlint Configuration.

Add the following code to the commitlint.config.ts or commitlint.config.js file:

import { defineConfig } from '@archoleat/commitlint-define-config';

export default defineConfig({});

Contributing

Please read CONTRIBUTING to start contributing.

License

This project is licensed under the MIT license.

About

Typed defineConfig helper for Commitlint configuration and editor completion.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages