@flick-tech/eslint-config

@flick-tech/eslint-config

shared ESLint configs used in Flick

Motivation

Sharing one thoroughly documented ESLint config makes its maintenance easier and predictable.

Usage

Installation

yarn add \
  "@typescript-eslint/eslint-plugin" \
  "@typescript-eslint/parser" \
  "eslint-plugin-cypress" \
  "eslint-plugin-import" \
  "eslint-plugin-jsx-a11y" \
  "eslint-plugin-react-hooks" \
  "eslint-plugin-react" \
  "eslint-plugin-simple-import-sort" \
  "eslint-plugin-sonarjs" \

Rules requiring typechecking

Reference your tsconfig in project to enable rules which require typechecking

{
  "root": true,
  "parserOptions": {
    "project": "./tsconfig.json"
  },
  "extends": ["@flick-tech"],
  "ignorePatterns": "./libs/tracking/src/lib/itly/*.ts"
}

Releasing

There's no release needed for use in frontend repo. To use in other repositories, run yarn publish in libs/eslint-config directory.

Development

• Mark changes from "default" rules present in common presets with @changed.
• Describe the background for a rule or its disabling with a comment marked with @motivation.
• Use rules that affect semantics — detect bugs and "no morning coffee" mistakes.
• Avoid obtrusive code style rules.