Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@betsys-eslint/eslint-config-typescript

betsys-com41MIT3.0.0

ESLint configuration used across the company for TypeScript-based projects

eslint, typescript, eslint config, betsys eslint config, eslint typescript config

readme

<picture> <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/19550608/189107427-33501040-d335-4081-a339-0532a88cc5be.svg"> <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/19550608/189107408-a7845b2c-1256-4489-8de5-2891b60f7b16.svg"> Shows an illustrated sun in light color mode and a moon with stars in dark color mode. </picture>

@betsys-eslint/eslint-config-typescript

Set of ESLint rules we use for our TypeScript code


Requirements

We recommend using Node.js v16 as we do not support lower version of Node.js.

Quick Start

Installing automatically

To install the configuration with all the necessary configuration changes, use the following:

npx @betsys-eslint/install config typescript

To read more about our installation script visit: @betsys-eslint/install.
:warning: This package currently works only with .eslintrc.json file. We plan to support other configuration files (.js and .yml) in the future.

Installing manually

To install the configuration manually, use the following:

npm install --save-dev @betsys-eslint/eslint-config-typescript

after installation, add the configuration to you ESLint config:

{
  "overrides": [
    {
      files: ["*.ts"],
      // Locate configuration for your TS files
      "extends": [
        // ...
        "@betsys-eslint/typescript"
      ]
    }
  ]
}

About the configuration

The configuration is inspired by eslint-config-airbnb-base and eslint-config-airbnb-typescript ESLint packages and extends @typescript-eslint/recommended configuration.