Skip to content
This repository has been archived by the owner on Feb 16, 2018. It is now read-only.

marionebl/conventional-changelog-lint-config-angular

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Lint your commits, angular-style

conventional-changelog-lint-config-angular

Shareable conventional-changelog-lint config enforcing the angular commit convention.

Installation

Fetch it with npm

npm install --save-dev conventional-changelog-lint-config-angular conventional-changelog-lint

See version 0.2 for config conforming to Angular 1 conventions:

npm install --save-dev conventional-changelog-lint-config-angular@0.2

Usage

Install and use as conventional-changelog-lint shareable config.

// .conventional-changelog-lintrc
{
  "extends": ["angular"]
}

⇨ See conventional-changelog-lint/shareable-config for details

Rules

Problems

The following rules are considered problems for conventional-changelog-lint-config-angular and will yield a non-zero exit code when not met.

type-enum

  • condition: type is found in value

  • rule: always

  • value

    [
      'build',
      'chore',
      'ci',
      'docs',
      'feat',
      'fix',
      'perf',
      'refactor',
      'revert',
      'style',
      'test'
      ]

type-case

  • description: type is in case value
  • rule: always
  • value
      'lowerCase'

type-empty

  • condition: type is empty
  • rule: never

scope-case

  • condition: scope is in case value
  • rule: always
  'lowerCase'

subject-empty

  • condition: subject is empty
  • rule: never

subject-full-stop

  • condition: subject ends with value
  • rule: never
  • value
  '.'

header-max-length

  • condition: header has value or less characters
  • rule: always
  • value
  72

Warnings

The following rules are considered warnings for conventional-changelog-lint-config-angular and will print warning messages when not met.

body-leading-blank

  • condition: Body begins with blank line
  • rule: always

lang

  • condition: subject is of language value
  • rule: always
  • value
  eng

Wildcards

The following rules identify commits that pass linting by skipping all other rules.

merge

  • condition: header matches pattern
  • pattern:
      /^(Merge pull request)|(Merge (.*?) into (.*?)|(Merge (.*?) branch (.*?))$)/

release

  • condition: header matches pattern
  • pattern: always
  • pattern:
      /^\\d+.\\d+.\\d+\n?$/

revert

  • condition: header matches pattern
  • pattern: always
  • pattern:
      /^revert: (.*)/

⇨ See conventional-changelog-lint/shareable-config for available rules


Copyright 2016 by Mario Nebl and contributors. Released under the MIT license.