commitlint-config-awesome

An awesome variation of @commitlint/config-conventional.

Table of Contents

• About the Package
• Install
• Usage
• Custom Configuration
• Support
• Contributing
• Changelog
• License

About the Package

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.

Learn more about commitlint configuration.

Install

npm install -D commitlint-config-awesome

Usage

Use the "extends": "awesome" property in your commitlint config, then add any additional configuration as required.

Using package.json file

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

Using .commitlintrc.json file

{
  "extends": ["awesome"]
}

Using .commitlintrc.yml file

extends: [awesome]

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

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

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": ["awesome"],
  "rules": {
    "header-max-length": [0, "always", 100]
  }
}

Using YAML

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

Using JavaScript

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

Forking and publishing your own configuration

Depending on how far down the rabbit role you need to go, you may want to publish your own configuration.

Fork the repo, then perform a few find-replace tasks on all files in your version of the repository:

1. Find commitlint-config-awesome, replace with commitlint-config-your-config-name
2. Find awesome, replace with your-config-name
3. Find seantrane, replace with your-profile
4. Delete files; rm -Rf CODEOWNERS CONTRIBUTING.md

Support

Submit an issue, in which you should provide as much detail as necessary for your issue.

Contributing

Contributions are always appreciated. Read CONTRIBUTING.md documentation to learn more.

Changelog

Release details are documented in the CHANGELOG.md file, and on the GitHub Releases page.

License

ISC License

Copyright (c) 2018 Sean Trane Sciarrone