19.0.3 ā€¢ Published 20 days ago

@commitlint/is-ignored v19.0.3

Weekly downloads
1,007,591
License
MIT
Repository
github
Last release
20 days ago

Get Started | Let's chat slack | Website

Lint commit messages

Demo generated with svg-term-cli

cat docs/assets/commitlint.json | svg-term --out docs/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

npm latest CircleCI

  • šŸš“ Be a good commitizen
  • šŸ“¦ Share configuration via npm
  • šŸ¤– Tap into conventional-changelog

Contents


What is commitlint

commitlint checks if your commit messages meet the conventional commit format.

In general the pattern mostly looks like this:

type(scope?): subject  #scope is optional

Real world examples can look like this:

chore: run tests on travis ci
fix(server): send cors headers
feat(blog): add comment section

Common types according to commitlint-config-conventional (based on the the Angular convention) can be:

  • build
  • ci
  • chore
  • docs
  • feat
  • fix
  • perf
  • refactor
  • revert
  • style
  • test

These can be modified by your own configuration.

Benefits using commitlint

Getting started

# Install commitlint cli and conventional config
npm install --save-dev @commitlint/{config-conventional,cli}
# For Windows:
npm install --save-dev @commitlint/config-conventional @commitlint/cli

# Configure commitlint to use conventional config
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

To lint commits before they are created you can use Husky's 'commit-msg' hook:

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

Detailed Setup instructions

CLI

  • Primary way to interact with commitlint.
  • npm install --save-dev @commitlint/cli
  • Packages: cli

Config

  • Configuration is picked up from commitlint.config.js, .commitlintrc.js, .commitlintrc.json, or .commitlintrc.yml file or a commitlint field in package.json
  • Packages: cli, core
  • See Rules for a complete list of possible rules
  • An example configuration can be found at @commitlint/config-conventional

Shared configuration

A number of shared configurations are available to install and use with commitlint:

āš ļø If you want to publish your own shareable config then make sure it has a name aligning with the pattern commitlint-config-emoji-log or commitlint-config-your-config-name ā€” then in extend all you have to write is emoji-log or your-config-name.

API

  • Alternative, programmatic way to interact with commitlint
  • Packages:
    • format - Format commitlint reports
    • lint - Lint a string against commitlint rules
    • load - Load shared commitlint configuration
    • read - Read commit messages from a specified range or last edit
  • See API for a complete list of methods and examples

Tools

Roadmap

Ideas: conventional-changelog/commitlint#94

commitlint is considered stable and is used in various projects as development tool.

We identify ease of adoption and developer experience as fields where there is room and need for improvement. The items on the roadmap should enhance commitlint regarding those aspects.

Version Support

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

Related projects

  • conventional-changelog ā€“ Generate a changelog from conventional commit history
  • commitizen ā€“ Simple commit conventions for internet citizens
  • create-semantic-module ā€“ CLI for quickly integrating commitizen and commitlint in new or existing projects
  • commitlint.io - helps your project to ensures nice and tidy commit messages without needing any download or installation

License

Copyright by @marionebl. All commitlint packages are released under the MIT license.

Development

commitlint is developed in a mono repository.

Install and run

git clone git@github.com:conventional-changelog/commitlint.git
cd commitlint
yarn
yarn run build # run build tasks
yarn start # run tests, again on change

For more information on how to contribute please take a look at our contribution guide.

Publishing a release

yarn clean
yarn install
yarn run build
yarn test
yarn run publish
19.0.0

21 days ago

19.0.3

20 days ago

18.6.1

1 month ago

18.6.0

2 months ago

18.4.4

2 months ago

18.4.3

4 months ago

18.4.2

4 months ago

18.4.0

4 months ago

18.0.0

5 months ago

17.7.0

7 months ago

18.1.0

5 months ago

17.6.7

8 months ago

17.8.1

5 months ago

17.8.0

5 months ago

17.6.6

9 months ago

17.6.5

10 months ago

17.6.3

11 months ago

17.4.4

1 year ago

17.4.0

1 year ago

17.4.2

1 year ago

17.2.0

1 year ago

17.1.0

2 years ago

17.0.3

2 years ago

17.0.0

2 years ago

16.2.4

2 years ago

16.0.0

2 years ago

16.2.1

2 years ago

15.0.0

2 years ago

8.3.6

2 years ago

14.0.0

2 years ago

13.2.0

2 years ago

13.1.0

3 years ago

13.0.0

3 years ago

12.1.2

3 years ago

12.1.3

3 years ago

12.1.4

3 years ago

12.1.1

3 years ago

12.1.0

3 years ago

12.0.1

3 years ago

12.0.0

3 years ago

11.0.0

4 years ago

10.0.0

4 years ago

9.1.2

4 years ago

9.1.1

4 years ago

9.1.0

4 years ago

9.0.1

4 years ago

9.0.0

4 years ago

8.3.5

4 years ago

8.3.4

4 years ago

8.3.2

4 years ago

8.3.0

4 years ago

8.2.0

5 years ago

8.1.0

5 years ago

8.0.0

5 years ago

7.6.0

5 years ago

7.5.1

5 years ago

7.5.0

5 years ago

7.3.1

5 years ago

7.3.0

5 years ago

7.2.1

5 years ago

7.2.0

5 years ago

7.1.2

6 years ago

7.1.1

6 years ago

7.1.0

6 years ago

7.0.0

6 years ago

6.1.3

6 years ago

6.1.2

6 years ago

6.1.1

6 years ago

6.1.0

6 years ago

6.0.4

6 years ago

6.0.3

6 years ago

6.0.2

6 years ago

6.0.0

6 years ago

5.2.8

6 years ago