@rocketseat/commitlint-config

Shareable commitlint config used by Rocketseat 🚀

Showing:

Popularity

Downloads/wk

30

GitHub Stars

93

Maintenance

Last Commit

8mos ago

Contributors

2

Package

Dependencies

0

Size (min+gzip)

0.3KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

@rocketseat/commitlint-config

npm version License

Shareable commitlint config used by Rocketseat.

Install

You can install it with npm or Yarn.

# npm
npm i -D @rocketseat/commitlint-config @commitlint/cli

# Yarn
yarn add -D @rocketseat/commitlint-config @commitlint/cli

Usage

After installing it, apply the config to commitlint by running the following command:

echo "module.exports = { extends: ['@rocketseat/commitlint-config'] };" > .commitlintrc.js

Bonus

To lint commits before they are created, install Husky and use the 'commit-msg' hook.

# Npm
npm i -D husky

# Yarn
yarn add -D husky

After that, you can create a .huskyrc file or add to your package.json the following code for

Husky v4:

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

Husky v5:

# .husky/commit-msg
# ...
npx --no-install commitlint --edit $1
# or
yarn commitlint --edit $1

Version Support

  • Node.js LTS >= 10.21.0
  • git >= 2.13.2

License

MIT License © Rocketseat

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial