@ptsecurity/commitlint-config

Commitlint configuration

Usage no npm install needed!

<script type="module">
  import ptsecurityCommitlintConfig from 'https://cdn.skypack.dev/@ptsecurity/commitlint-config';
</script>

README

commitlint-config

Commitlint configuration

Using

Install packages:

npm i --save-dev husky @commitlint/cli @commitlint/config-conventional @ptsecurity/commitlint-config

Create file commitlint.config.js with extending preset and define set of scopes:

module.exports = {
    extends: ['@ptsecurity/commitlint-config'],
    rules: {
        'scope-enum': [ 
            2,
            'always',
            [
                // as examples
                'app', 
                'common'
            ]
        ]
    }
};

Add to package.json next section:

{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }  
  }
}

Argument -g is path to your commit configuration file. More details about it