/eslint-config-tidal

:star2: ESLint sharable config for TIDAL

Primary LanguageJavaScript

eslint-config-tidal

Build Status Codacy grade NPM downloads NPM version Node version Dependency status

ESLint shareable config for the TIDAL Code Style.

Usage

We export five ESLint configurations for your usage.

eslint-config-tidal

Our default export contains all of our base ESLint rules. It requires eslint and eslint-plugin-import.

  1. Install the correct versions (check peerDependencies) of each package:
npm install --save-dev eslint-config-tidal eslint-plugin-import
  1. Add "extends": "tidal" to your .eslintrc.

eslint-config-tidal/flow

This entry point enables the linting rules for Flow. To use, add "extends": ["tidal", "tidal/flow"] to your .eslintrc. Additional required packages: eslint-plugin-flowtype.

eslint-config-tidal/react

This entry point enables the linting rules for React (requires v16.8+). To use, add "extends": ["tidal", "tidal/react"] to your .eslintrc. Additional required packages: eslint-plugin-react, eslint-plugin-react-hooks, eslint-plugin-jest, eslint-plugin-jsx-a11y.

eslint-config-tidal/typescript

This entry point enables the linting rules for Typescript. To use, add "extends": ["tidal", "tidal/typescript", "plugin:import/typescript"] to your .eslintrc. Additional required packages: @typescript-eslint/eslint-plugin, @typescript-eslint/parser.

eslint-config-tidal/legacy

Lints ES5 and below. To use, add "extends": ["tidal", "tidal/legacy"] to your .eslintrc.