@morev/commitlint-config v0.2.2

@morev/commitlint-config

Shareable commitlint configuration.

Table of contents:

• Installation
  • Using yarn
  • Using npm
  • Using pnpm
• Usage
  • Basic usage
  • Advanced usage
• Built-in type enum

Installation

Using yarn

yarn add @morev/commitlint-config

Using npm

npm install @morev/commitlint-config

Using pnpm

pnpm add @morev/commitlint-config

Usage

Basic usage

Create a .commitlintrc.cjs file in the project root:

echo -e "module.exports = {\n\textends: ['@morev/commitlint-config'],\n\trules: {},\n};" > .commitlintrc.cjs

The command above will create a .commitlintrc.cjs file with the following content:

module.exports = {
  extends: ['@morev/commitlint-config'],
  rules: {},
};

It's recommended to create .commitlintrc.cjs file instead of commitlint.config.js because by using this naming strategy you can keep your Commitlint configuration file consistent across packages regardless of whether the package has "type": "module" or "type": "commonjs".

Advanced usage

If you need fine-grained control, you can import the entire config directly and manipulate it as a JavaScript object:

const config = require('@morev/commitlint-config');

// Replace the `header-min-length` rule with custom settings
config.rules['header-min-length'] = [2, 'always', 5];

module.exports = config;

Also you can use the built-in utility to modify type-enum rule for each project in a more elegant way:

const { modifyTypeEnum } = require('@morev/commitlint-config/utils');
const config = require('@morev/commitlint-config');

module.exports = modifyTypeEnum(config, {
  add: ['temp'],
  remove: ['nvm'],
});

// Now you can use `temp` as a type and cannot use `nvm`, rest types remain as is.

Built-in type enum