@yiluhub/commitlint-config

Commitlint shared configuration

Installs commitlint, husky, lint-stage, cz-conventional-changelog and exports commitlint configuration.

Installation

# cd into your project
cd your-awesome-project

# install the package as a devDependency 
yarn add --dev @yiluhub/commitlint-config

# if you don't have a .commitlintrc copy into your project this file
frontend-shared-packages/templates/.commitlintrc.js

# if you do have already a .commitlintrc, use the following configuration and you can ovveride any rules you want
{
    extends: ['@yiluhub/commitlint-config'],
    rules: {
        ...your rules will override the default ones.
    }
}

# in your package.json make sure you have these configurations
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  },
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -e $GIT_PARAMS"
    }
  }

Packages that will be installed in your project

Package	Version
@commitlint/cli	^7.1.1
@commitlint/config-angular	^7.1.1
@commitlint/travis-cli	^7.1.1
cz-conventional-changelog	^2.1.0
husky	^1.0.0-rc.13
lint-staged	^7.2.2