@thorgate/eslint-config-typescript

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

Usage no npm install needed!

<script type="module">
  import thorgateEslintConfigTypescript from 'https://cdn.skypack.dev/@thorgate/eslint-config-typescript';
</script>

README

@thorgate/eslint-config-typescript

Installation

  1. Install the package

    yarn install @thorgate/eslint-config-typescript
    
  2. Install ESLint plugins

    ESLint plugins used by this config must also be installed within your project. This is a limitation within ESLint.

    Install required plugins if you have npm 5+ installed

    npx install-peerdeps --dev @thorgate/eslint-config-typescript
    

    Otherwise you can use following:

    npm install eslint@^7.5.0 \
                eslint-config-airbnb-typescript@^18.2.1 \
                eslint-config-prettie@^7.0.0 \
                eslint-config-react-app@^6.0.0 \
                eslint-plugin-flowtype@^5.2.0 \
                eslint-plugin-import@^2.22.1 \
                eslint-import-resolver-typescript@^2.3.0 \
                eslint-plugin-jest@^24.1.3 \
                eslint-plugin-jsx-a11y@^6.4.1 \
                eslint-plugin-prettier@^3.2.8 \
                eslint-plugin-react@^7.21.5 \
                eslint-plugin-react-hooks@^4.2.0 \
                @typescript-eslint/parser@^4.9.0 \
                @typescript-eslint/eslint-plugin@^4.9.0 \
                typescript
    
  3. Configure ESLint

    In your .eslintrc add following.

    {
      "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.