@yikoyu/commitlint-config

➡️ Extendable commitlint configuration, part of the yikoyu/unconfig project.

Prerequisites

ℹ️ This configuration package require these tools to use locally on your device(s):

1. Latest Node.js LTS (Long-Term Support) version
2. One of Node.js package managers:
   • pnpm
   • yarn
   • npm
3. Latest commitlint version

Basic usage

👣 Follow the steps below:

1. Install it with the Node.js package manager of your choice (in our case, we use pnpm).

    pnpm install --save-dev @yikoyu/commitlint-config cz-git czg

2. If using pnpm, please add configuration to the .npmrc file.

   public-hoist-pattern[]=@commitlint/*

3. Create a commitlint configuration file - commitlint.config.(js|cjs|.mjs).

4. Extend this module package configuration.

   import { yikoyu } from '@yikoyu/commitlint-config'
   
   export default yikoyu()

5. Git commit

   pnpm czg

📖 For the commitlint CLI usage, please refer to its documentation.

Used configurations & plugins

⚙️ This configuration module for commitlint loads configurations and plugins options conditionally.

Configurations

| Configurations | Version | Loading condition(s) | | -------------------------------- | ------------------------------------------------ | -------------------- | | @commitlint/cli | | - | | @commitlint/config-conventional | | - |

License

⚖️ For more information, please refer to the License section at the root of the yikoyu/unconfig monorepo.