eslint-config-iamturns
ESLint rules for my projects.
Includes Airbnb JavaScript Style Guide with React, Prettier, TypeScript (optional), and Jest.
See create-exposed-app for example setup.
Installation
This module is distributed via npm which is bundled with Node.js.
Install dependencies. ESLint plugins must also be installed.
npm install eslint-config-iamturns \
eslint-plugin-import@^2.14.0 \
eslint-plugin-jsx-a11y@^6.1.1 \
eslint-plugin-react@^7.11.0 \
--save-dev
Within your ESLint config file:
module.exports = {
extends: ["iamturns"],
rules: {},
}
Typescript support
Install additional dependency:
npm install @typescript-eslint/eslint-plugin@^1.0.0 --save-dev
Within your ESLint config file:
module.exports = {
extends: ["iamturns/typescript"],
rules: {},
}
FAQ
Why are so many features included and enabled by default? I'm not using Jest!
Including and enabling features reduces the need for any additional configuration within consumers.
This may come at a very small speed penalty. If this becomes a problem, you can disable the features within your eslintrc.js
.
Roadmap
Additional Documentation
Credits
Authored and maintained by Matt Turnbull (iamturns.com / @iamturns)
To all contributors (if you exist) - thank you!
License
Open source licensed as MIT.