Naughty Platypus Memorabilia

    @commitlint/config-angular

    13.1.0 • Public • Published

    Lint your commits, angular-style

    @commitlint/config-angular

    Shareable commitlint config enforcing the Angular commit convention. Use with @commitlint/cli and @commitlint/prompt-cli.

    Getting started

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

    Rules

    Problems

    The following rules are considered problems for @commitlint/config-angular 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',
        '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

    subject-exclamation-mark

    • condition: subject must not have a ! before the : marker
    • rule: never

    The angular commit convention dose not use a ! to define a breaking change in the commit subject. If you want to use this feature please consider using the conventional commit config.

    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

    Warnings

    The following rules are considered warnings for @commitlint/config-angular and will print warning messages when not met.

    body-leading-blank

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

    Install

    npm i @commitlint/config-angular

    DownloadsWeekly Downloads

    78,761

    Version

    13.1.0

    License

    MIT

    Unpacked Size

    14.5 kB

    Total Files

    5

    Last publish

    Collaborators

    • marionebl
    • martinhelmut
    • escapedcat
    • bycedric