Next Pizza's Mine

    @commitlint/config-angular-type-enum

    17.0.0 • Public • Published

    @commitlint/config-angular-type-enum

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

    See @commitlint/config-angular for full angular conventions.

    Getting started

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

    Usage

    echo "foo: bar" | commitlint # fails
    echo "build: bar" | commitlint # passes

    Examples

    // commitlint.config.js
    const types = require('@commitlint/config-angular-type-enum');
    
    // Use as rule creating errors for non-allowed types
    module.exports = {
      rules: {
        ...types.rules,
      },
    };
    
    // Warn for non-allowed types
    module.exports = {
      rules: {
        'type-enum': [1, 'always', types.values()],
      },
    };

    Install

    npm i @commitlint/config-angular-type-enum

    DownloadsWeekly Downloads

    76,354

    Version

    17.0.0

    License

    MIT

    Unpacked Size

    11.4 kB

    Total Files

    5

    Last publish

    Collaborators

    • marionebl
    • martinhelmut
    • escapedcat
    • bycedric