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

Package detail

@thorgate/eslint-config-typescript

thorgate204MIT3.1.0

Common ESLint w/ Typescript config used in Thorgate project template. Based on Airbnb eslint config.

airbnb, config, es2015, es2016, es2017, es2018, eslint, eslintconfig, javascript, styleguide, typescript

readme

@thorgate/eslint-config-typescript

Installation

1) Install the package

`shell script yarn install @thorgate/eslint-config-typescript


1) Install ESLint plugins 

   ESLint plugins used by this config must also be installed within your project. This is a [limitation within ESLint](https://github.com/eslint/rfcs/pull/5).

   Install required plugins if you have *npm 5+* installed
   ```shell script
   npx install-peerdeps --dev @thorgate/eslint-config-typescript

Otherwise you can use following:

`shell script npm install eslint@^8.16.0 \ eslint-config-airbnb@^19.0.4 \ eslint-config-airbnb-typescript@^17.0.0 \ eslint-config-prettier@^8.5.0 \ eslint-config-react-app@^7.0.1 \ eslint-plugin-flowtype@^8.0.3 \ eslint-plugin-import@^2.26.0 \ eslint-import-resolver-typescript@^2.7.1 \ eslint-plugin-jest@^26.2.2 \ eslint-plugin-jsx-a11y@^6.5.1 \ eslint-plugin-prettier@^4.0.0 \ eslint-plugin-react@^7.30.0 \ eslint-plugin-react-hooks@^4.5.0 \ @typescript-eslint/parser@^5.5.0 \ @typescript-eslint/eslint-plugin@^5.5.0 \ typescript@^4


1) Configure ESLint

    In your `.eslintrc` add following.

    ```json
    {
      "extends": ["@thorgate/eslint-config-typescript"],
      "parserOptions": {
        "project": "./tsconfig.json"
      }
    }

If you need to change some rules then add those to .eslintrc also. This goes for adding resolvers also.

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.1.0-alpha.0 (2022-05-25)

Note: Version bump only for package @thorgate/eslint-config-typescript

3.0.0 (2022-01-07)

2.1.0 (2021-04-17)

Bug Fixes

  • Fix eslint-config-typescript (d05774c)
  • Fix package versions (62e63fd)

Features

  • Bump eslint-config-prettier (8e45114)

2.0.0 (2021-04-12)

Features

  • Bump prettier eslint config (81b7075)

BREAKING CHANGES

  • Peer dependency changed

1.0.2 (2020-12-11)

Bug Fixes

  • add missing package peerDep for eslint-config-typescript (ce4b6f6)

1.0.1 (2020-12-11)

Note: Version bump only for package @thorgate/eslint-config-typescript

1.0.0 (2020-12-08)

Note: Version bump only for package @thorgate/eslint-config-typescript