Canonical ESLint Config
Canonical is the most comprehensive code style guide. It consists of more than 800 rules, some of which are custom written for Canonical (e.g. eslint-plugin-jsdoc, eslint-plugin-flowtype).
The goal of the Canonical style guide is to reduce noise in code version control and promote use of the latest ES features.
Usage
This package includes the following configurations:
canonical
– The Canonical code style guide.canonical/ava
– To be used in addition to "canonical" configuration by projects that use AVA.canonical/flowtype
– To be used in addition to "canonical" configuration by projects that use Flowtype.canonical/lodash
– To be used in addition to "canonical" configuration by projects that use lodash.canonical/mocha
– To be used in addition to "canonical" configuration by projects that use Mocha.canonical/react
– To be used in addition to "canonical" configuration by projects that use React.
Example:
{
"extends": [
"canonical",
"canonical/ava",
"canonical/flowtype",
"canonical/lodash",
"canonical/mocha",
"canonical/react"
]
}
Versioning Policy
All breaking changes will bump the major version as per the semver convention. Therefore, every new rule addition will increase the major version.