@cffnpwr/commitlint-config

A shared commitlint configuration for cffnpwr.

日本語のREADMEはこちら

What's Included

• Conventional Commits rules (type-enum, subject-max-length, etc.).
• no-ai-coauthor: rejects commits whose Co-authored-by trailer references an AI agent.
• gitmoji-whitelist: allows a leading gitmoji shortcode in the subject only when it is on the whitelist.

How to Install

npm

npm install -D @cffnpwr/commitlint-config

or

npx jsr add -D @cffnpwr/commitlint-config

yarn

yarn add -D @cffnpwr/commitlint-config

or

yarn dlx jsr add -D @cffnpwr/commitlint-config

pnpm

pnpm add -D @cffnpwr/commitlint-config

or

pnpm dlx jsr add -D @cffnpwr/commitlint-config

Bun

bun add -D @cffnpwr/commitlint-config

or

bunx jsr add -D @cffnpwr/commitlint-config

Deno

deno add -D npm:@cffnpwr/commitlint-config

or

deno add -D jsr:@cffnpwr/commitlint-config

How to Use

Create a commitlint config file and extend this shared configuration.

import type { UserConfig } from "@commitlint/types";

const config: UserConfig = {
  extends: ["@cffnpwr/commitlint-config"],
};

export default config;

The custom no-ai-coauthor and gitmoji-whitelist rules are bundled as inline plugins, so no extra plugin installation is required.

License

MIT License