0.2.1 • Published 6 months ago

@yikoyu/commitlint-config v0.2.1

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

@yikoyu/commitlint-config

package version badge

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


Prerequisites

node.js version support badge supported commitlint version badge

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

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

Basic usage

👣 Follow the steps below:

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

     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 icon - 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 icon usage, please refer to its documentation.


Used configurations & plugins

Dependencies badge

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

Configurations

ConfigurationsVersionLoading condition(s)
@commitlint/cli@commitlint/cli version badge-
@commitlint/config-conventional@commitlint/config-conventional version badge-

License

license badge

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