@wowvendor/commitlint-config
Commitlint config enforcing conventional commits
Last updated 22 days ago by weyheyhey .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @wowvendor/commitlint-config 
SYNC missed versions from official npm registry.

@wowvendor/commitlint-config

Lint your commits

Commitizen friendly

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

Getting started

npm install --save-dev @wowvendor/commitlint-config @commitlint/cli
echo "module.exports = {extends: ['@wowvendor/commitlint-config']};" > 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

    [
      'feat', // A new feature
      'fix', // A bug fix
      'wip', // Work in progress
      'chore', // Build process or auxiliary tool changes
      'refactor', // A code change that neither fixes a bug or adds a feature
      'style', // Markup, white-space, formatting, missing semi-colons...
      'test', // Adding missing tests
      'perf', // A code change that improves performance,
      'docs', // Documentation only changes
      'ci', // CI related changes
      'revert', // Revert to a commit
    ];
    
echo "foo: some message" # fails
echo "fix: some message" # passes

type-case

  • description: type is in case value
  • rule: always
  • value
    'lower-case';
    
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
'kebab-case';
echo "fix(SCOPE): some message" # fails
echo "fix(scope): some message" # passes
echo "fix(some-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
100;
echo "fix: lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore" # fails
echo "fix: some message" # passes

Current Tags

  • 1.0.2                                ...           latest (22 days ago)

3 Versions

  • 1.0.2                                ...           22 days ago
  • 1.0.1                                ...           3 months ago
  • 1.0.0                                ...           6 months ago
Maintainers (2)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 1
Last Month 12
Dependencies (1)
Dev Dependencies (9)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |