@storis/eslint-config

@storis/eslint-config

This package contains the standard eslint configurations for TypeScript packages used by STORIS. It extends and relies on a number of other rulesets and packages including eslint-config-airbnb, @typescript/eslint, and others. It then refines those rulesets to match the STORIS TypeScript style guide.

Installation

@storis/eslint-config is available as an npm package.

npm install @storis/eslint-config

Usage

Peer dependencies

The package relies on the following peer dependencies which differ depending on if you are using the @storis/eslint-config/nodejs config or the @storis/eslint-config/react config. You must ensure that compatible versions of the necessary peer dependencies have been installed.

Required

• @typescript-eslint/eslint-plugin
• @typescript-eslint/parser
• eslint
• eslint-config-airbnb-typescript
• eslint-config-prettier
• eslint-plugin-import
• eslint-plugin-jest
• jest
• typescript

Required for NodeJs Config

• eslint-config-airbnb-base
• eslint-import-resolver-babel-module

Required for React Config

• eslint-config-airbnb
• eslint-import-resolver-webpack
• eslint-plugin-jsx-a11y
• eslint-plugin-react
• eslint-plugin-react-hooks

Configuration

Node

Add the following to your eslint configuration file (e.g. .eslintrc.js):

{
  extends: ['@storis/eslint-config/nodejs'],
  parserOptions: { tsconfigRootDir: __dirname, project: location_of_tsconfig_file }
}

React

Add the following to your eslint configuration file (e.g. .eslintrc.js):

{
  extends: ['@storis/eslint-config/react'],
  parserOptions: { tsconfigRootDir: __dirname, project: location_of_tsconfig_file }
}

License

This project is licensed under the terms of the MIT license.