@commitlint/config-conventional
Shareable commitlint config enforcing conventional commits
Last updated a month ago by marionebl .
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.

:warning:
IMPORTANT This is a direct replacement for @commitlint/config-angular prior to version 4. config-angular diverged from the conventional commit convention as of version 5. See #146 for details.

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

  • 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
  • value
      'lowerCase'
    
echo "FIX: some message" # fails
echo "fix: some message" # passes

type-empty

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

scope-case

  • condition: scope is in case value
  • rule: always
  '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
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
echo "fix:" # fails
echo "fix: some message" # passes

subject-full-stop

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

header-max-length

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

Current Tags

  • 8.0.0                                ...           latest (a month ago)
  • 8.0.0                                ...           next (a month ago)

21 Versions

  • 8.0.0                                ...           a month ago
  • 7.6.0                                ...           2 months ago
  • 7.5.0                                ...           5 months ago
  • 7.3.1                                ...           5 months ago
  • 7.3.0                                ...           5 months ago
  • 7.1.2                                ...           10 months ago
  • 7.1.1                                ...           10 months ago
  • 7.1.0                                ...           10 months ago
  • 7.0.1                                ...           a year ago
  • 7.0.0                                ...           a year ago
  • 6.1.3                                ...           a year ago
  • 6.1.2                                ...           a year ago
  • 6.1.1                                ...           a year ago
  • 6.1.0                                ...           a year ago
  • 6.0.4                                ...           a year ago
  • 6.0.3                                ...           a year ago
  • 6.0.2                                ...           a year ago
  • 5.2.3                                ...           2 years ago
  • 5.3.0-0                                ...           2 years ago
  • 5.1.3                                ...           2 years ago
  • 5.1.1                                ...           2 years ago
Downloads
Today 280
This Week 1,792
This Month 10,614
Last Day 728
Last Week 3,374
Last Month 11,957
Dependencies (0)
None
Dev Dependencies (1)
Dependents (139)

Copyright 2014 - 2016 © taobao.org |