@commitlint/config-conventional
Shareable commitlint config enforcing conventional commits
Last updated a month ago by escapedcat .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @commitlint/config-conventional 
SYNC missed versions from official npm registry.

Lint your conventional commits

@commitlint/config-conventional

Shareable commitlint config enforcing conventional commits. Use with @commitlint/cli and @commitlint/prompt-cli.

Getting started

npm install --save-dev @commitlint/config-conventional @commitlint/cli
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js

Rules

Problems

The following rules are considered problems for @commitlint/config-conventional and will yield a non-zero exit code when not met.

Consult docs/rules for a list of available rules.

type-enum

  • condition: type is found in value

  • rule: always

  • level: error

  • value

    [
      'build',
      'ci',
      'chore',
      'docs',
      'feat',
      'fix',
      'perf',
      'refactor',
      'revert',
      'style',
      'test'
    ];
    
echo "foo: some message" # fails
echo "fix: some message" # passes

type-case

  • description: type is in case value
  • rule: always
  • level: error
  • value
    'lowerCase'
    
echo "FIX: some message" # fails
echo "fix: some message" # passes

type-empty

  • condition: type is empty
  • rule: never
  • level: error
echo ": some message" # fails
echo "fix: some message" # passes

scope-case

  • condition: scope is in case value
  • rule: always
  • level: error
'lowerCase'
echo "fix(SCOPE): some message" # fails
echo "fix(scope): some message" # passes

subject-case

  • condition: subject is in one of the cases ['sentence-case', 'start-case', 'pascal-case', 'upper-case']
  • rule: never
  • level: error
echo "fix(SCOPE): Some message" # fails
echo "fix(SCOPE): Some Message" # fails
echo "fix(SCOPE): SomeMessage" # fails
echo "fix(SCOPE): SOMEMESSAGE" # fails
echo "fix(scope): some message" # passes
echo "fix(scope): some Message" # passes

subject-empty

  • condition: subject is empty
  • rule: never
  • level: error
echo "fix:" # fails
echo "fix: some message" # passes

subject-full-stop

  • condition: subject ends with value
  • rule: never
  • level: error
  • value
'.'
echo "fix: some message." # fails
echo "fix: some message" # passes

header-max-length

  • condition: header has value or less characters
  • rule: always
  • level: error
  • value
100
echo "fix: some message that is way too long and breaks the line max-length by several characters" # fails
echo "fix: some message" # passes

footer-leading-blank

  • condition: footer should have a leading blank line
  • rule: always
  • level: warning
  • value
100
echo "fix: some message
BREAKING CHANGE: It will be significant" # warning

echo "fix: some message

BREAKING CHANGE: It will be significant" # passes

footer-max-line-length

  • condition: footer each line has value or less characters
  • rule: always
  • level: error
  • value
100
echo "fix: some message

BREAKING CHANGE: footer with multiple lines
has a message that is way too long and will break the line rule 'line-max-length' by several characters" # fails

echo "fix: some message

BREAKING CHANGE: footer with multiple lines
but still no line is too long" # passes

body-leading-blank

  • condition: body should have a leading blank line
  • rule: always
  • level: warning
  • value
100;
echo "fix: some message
body" # warning

echo "fix: some message

body" # passes

body-max-line-length

  • condition: body each line has value or less characters
  • rule: always
  • level: error
  • value
100;
echo "fix: some message

body with multiple lines
has a message that is way too long and will break the line rule 'line-max-length' by several characters" # fails

echo "fix: some message

body with multiple lines
but still no line is too long" # passes

Current Tags

  • 9.0.1                                ...           latest (a month ago)
  • 9.1.1                                ...           next (2 days ago)

31 Versions

  • 9.1.1                                ...           2 days ago
  • 9.1.0                                ...           11 days ago
  • 9.0.1                                ...           a month ago
  • 9.0.0                                ...           a month ago
  • 8.3.4                                ...           6 months ago
  • 8.3.3                                ...           8 months ago
  • 8.3.2                                ...           8 months ago
  • 8.3.0                                ...           9 months ago
  • 8.2.0                                ...           10 months ago
  • 8.1.0                                ...           a year ago
  • 8.0.0                                ...           a year ago
  • 7.6.0                                ...           a year ago
  • 7.5.0                                ...           a year ago
  • 7.3.1                                ...           a year ago
  • 7.3.0                                ...           a year ago
  • 7.1.2                                ...           2 years ago
  • 7.1.1                                ...           2 years ago
  • 7.1.0                                ...           2 years ago
  • 7.0.1                                ...           2 years ago
  • 7.0.0                                ...           2 years ago
  • 6.1.3                                ...           2 years ago
  • 6.1.2                                ...           2 years ago
  • 6.1.1                                ...           2 years ago
  • 6.1.0                                ...           2 years ago
  • 6.0.4                                ...           2 years ago
  • 6.0.3                                ...           2 years ago
  • 6.0.2                                ...           2 years ago
  • 5.2.3                                ...           3 years ago
  • 5.3.0-0                                ...           3 years ago
  • 5.1.3                                ...           3 years ago
  • 5.1.1                                ...           3 years ago
Downloads
Today 600
This Week 7,309
This Month 2,743
Last Day 2,143
Last Week 11,871
Last Month 55,342
Dev Dependencies (2)
Dependents (373)

Copyright 2014 - 2017 © taobao.org |