Commitlint Config

This package is a commitlint configuration for commit message conventions and enforcement. It's a modified variation of @commitlint/config-conventional, with the following enhancements:

• Commit message header-length is extended to 80 characters, provoked by lengthy Greenkeeper's commit message subject lines.

Table of Contents

• Commitlint Config
  • Table of Contents
  • Installation
  • Usage
    • Using package.json file
    • Using .commitlintrc.json file
    • Using .commitlintrc.yml file
    • Using commitlint.config.js, .commitlintrc.js file
  • Custom Configuration
    • Using JSON
    • Using YAML
    • Using JavaScript
  • License

Installation

$ npm i --save-dev commitlint-config-smallela

Usage

Using package.json file

{
  "commitlint": {
    "extends": ["smallela"]
  }
}

Using .commitlintrc.json file

{
  "extends": ["smallela"]
}

Using .commitlintrc.yml file

extends: [smallela]

Using commitlint.config.js, .commitlintrc.js file

module.exports = {
  extends: ['smallela']
};

Custom Configuration

There are many ways to implement custom configurations. Review the complete list of possible rules to learn more.

You can override the rules immediately following the extends property. See the following examples.

Using JSON

{
  "extends": ["smallela"],
  "rules": {
    "header-max-length": [0, "always", 100]
  }
}

Using YAML

extends: [smallela]
rules:
  header-max-length: [0, 'always', 100]

Using JavaScript

module.exports = {
  extends: ['smallela'],
  rules: {
    'header-max-length': [0, 'always', 100]
  }
};

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.