@heliofi/eslint-config-helio

eslint-config-helio

Official Helio eslint config for all Helio projects.

The package extends Airbnb styling guidelines customized for Typescript projects.

Usage

This package exposes two plugins, one for react applications and one for Node.js applications. Install the package as a developer dependency:

yarn add -D eslint-config-helio

If the project doesn't have eslint installed with Airbnb config, make sure that those dependencies are installed

yarn add -D @typescript-eslint/eslint-plugin@ˆ5.13.0 \
            @typescript-eslint/parser@ˆ5.0.0 \
            @eslint \
            eslint-config-airbnb-base \
            eslint-config-airbnb-typescript \
            eslint-plugin-import

React

In order to use the plugin in a React project add the following to package json

"eslintConfig": {
    "extends": [
+     "helio/react"
    ],
+   "parserOptions": {
+     "project": "./tsconfig.json"
+   }
},

Node.js

Similarly to React, in Node projects add the helio plugin without react extension

"eslintConfig": {
    "extends": [
+     "helio"
    ],
+   "parserOptions": {
+     "project": "./tsconfig.json"
+   }
},

Note it's important to add parserOptions.project with project pointing to tsconfig.json