eslint-config-iamturns

eslint-config-iamturns

ESLint rules for my projects.

Combination of Airbnb JavaScript Style Guide for linting, and Prettier for automatic code formatting.

Supports modern JavaScript: es2018, modules, jsx, jest, etc.

Table of Contents

• Installation
  • Prettier
• FAQ
  • I do not require all the enabled features (es2018, jest, etc)
  • Why use Prettier? Why not just use ESLint alone?
• Roadmap
• Contributing
• Maintaining
• Author
• License

Installation

This module is distributed via npm which is bundled with node.

npm install eslint-config-iamturns --save-dev

Within your ESLint config file:

module.exports = {
  extends: ["iamturns"],
  rules: {},
}

See generator-iamturns-js for example setup.

Prettier

This project assumes you are using Prettier, which automatically handles most of the style-based linting rules.

FAQ

I do not require all the enabled features (es2018, jest, etc)

Many ESLint features have been enabled to reduce the need for any additional configuration within projects extending this ESLint config.

This may come at a very small speed penalty. If this becomes a problem, you can disable the features within your eslintrc.js.

Why use Prettier? Why not just use ESLint alone?

1. ESLint will complain your line is too long, but Prettier will format your code and fix it.
2. Prettier will automatically format other files too (CSS, SCS, Markdown, JSON, YAML, etc).

Roadmap

• Check awesome-eslint for ideas

Contributing

See CONTRIBUTING.md.

Maintaining

See MAINTAINING.md.

Author

Matt Turnbull <[e-mail]>

License

Open source software licensed as MIT.