@easternmotors/eslint-config-ts

The goal of this repo is to provide a very explicit full list of ESLint rules of what I think are the best practices/packages for users using React/Typescript. Feel free to extend this and turn on/off rules to your heart's content. It's also helpful to turn a few rules off when first adding this to your project and slowing enabling them when you have time. I also added Prettier and Stylelint so that users have the option to use all three if desired.

Getting Started

To get started, run:

// via yarn
yarn add @easternmotors/eslint-config-ts
// or via npm
npm install @easternmotors/eslint-config-ts

Prerequisites

Ensure you have the correct peer dependencies installed which are listed in package.json

Configuration

You can use/extend the definitions using the following syntax:

Using

package.json

"lint": "eslint . --config ./node_modules/@easternmotors/eslint-config-ts --ext js,ts,tsx --resolve-plugins-relative-to ./node_modules/@easternmotors/eslint-config-ts",
"format": "prettier --config ./node_modules/@easternmotors/eslint-config-ts/prettier.config.js --write \"$(pwd)/**/*.{js,ts,tsx}\"",
"stylelint": "stylelint --config ./node_modules/@easternmotors/eslint-config-ts/stylelint.config.js '**/*.css'"

Extending

ESLint (see https://eslint.org/docs/user-guide/configuring#extending-configuration-files)

"extends": ["eslint:recommended", "@easternmotors/eslint-config-ts"]

Prettier (see https://prettier.io/docs/en/configuration.html#sharing-configurations)

(module.exports = {
  ...require("@easternmotors/eslint-config-ts/prettier.config"),
  "singleQuote": false
})

Stylelint (see https://eslint.org/docs/user-guide/configuring#extending-configuration-files)

"extends": ["stylelint-config-recommended", "@easternmotors/eslint-config-ts/stylelint.config"]