FuelRats ESLint configs

Standard configurations for Fuel Rats ECMAScript projects

Note about v2

v2 Changes a number of aspects of our code style which may lead to time consuming adjustments, and in some cases an outright refactor of your code.

Please see PR #3 for a comprehensive list of changes made from v1.2.5

If you are a react user, @fuelrats/eslint-config-react no longer extends @fuelrats/eslint-config. See the react package README.md for more information.

Motivation

The TechRat team of The FuelRats utilize ECMAScript on all fronts. Over time these projects have strayed in code standards as no common base has been shared between them.

@fuelrats/eslint-config aims to help unify style and standards across all major FuelRats Javascript projects.

Packages

This config has two separate packages:

@fuelrats/eslint-config

• Base ESLint ruleset with @babel/eslint-parser as the primary parser. Generally intended for node.js backend projects.
  • Assumes an ECMAScript 2020 environment with Babel 7 as the primary transpiler.
  • Includes [@babel/eslint-plugin][eslint-plugin-babel] for providing core rule compatibility for common babel plugins.
  • Includes eslint-plugin-import for additional ESModule linting.
  • Includes eslint-plugin-jsdoc for JSDoc block linting.
  • Also includes a purejs preset which disables @babel/eslint-parser and [@babel/eslint-plugin][eslint-plugin-babel].

@fuelrats/eslint-config-react

• Companion config to @fuelrats/eslint-config. Built specifically for our react projects.
  • Adds eslint-plugin-react for react and better JSX linting.
  • Adds eslint-plugin-react-hooks for react "rules of hooks" enforcement.
  • Adds eslint-plugin-jsx-a11y for enforcing website accessibility best practices.

Installation

• For regular javascript or node.js projects, go to @fuelrats/eslint-config.
• For React projects, go to @fuelrats/eslint-config-react.

Development

This monorepo uses yarn workspaces to manage dependencies and versioning. When downloading for development, follow these steps:

1. Clone the Repository

$ git clone https://github.com/FuelRats/eslint-config-fuelrats.git && cd eslint-config-fuelrats

2. Let yarn install everything for you

$ yarn install

3. Done! 🎉

Credits

Our code style and this config set was inspired by and derived from the AirBnB javascript style guide.

Send some love their way 😍🎉🎊