npm.io
2.1.1 • Published 5 months ago

@saasjetlib/eslint-config-typescript

Licence
MIT
Version
2.1.1
Deps
3
Size
21 kB
Vulns
0
Weekly
0

SaaSJet ESLint config for TypeScript

This package provides a shared, extensible ESLint flat config for TypeScript projects (ESLint 9+).

Usage

  1. Install packages

npm

npm install --save-dev @saasjetlib/eslint-config-typescript eslint typescript
yarn
yarn add --dev @saasjetlib/eslint-config-typescript eslint typescript

You only install the config plus the eslint and typescript peer dependencies. The parser (@typescript-eslint/parser) and plugins (@typescript-eslint/eslint-plugin, eslint-plugin-import-x) ship as dependencies of this package and are installed automatically.

  1. Create an ESLint configuration file eslint.config.mjs
import typescriptConfig from '@saasjetlib/eslint-config-typescript';

export default [
  ...typescriptConfig,
];

The config already wires up the @typescript-eslint/parser (as a parser object) and registers the @typescript-eslint and import-x plugins, so it works as-is in flat config.

  1. Customizing

This is a flat config, so override anything by appending your own config object. The TypeScript block sets languageOptions.parserOptions.project: './tsconfig.json' by default — point it at a different tsconfig (or set tsconfigRootDir) like this:

import typescriptConfig from '@saasjetlib/eslint-config-typescript';

export default [
  ...typescriptConfig,
  {
    files: ['**/*.ts', '**/*.tsx'],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.eslint.json'],
        tsconfigRootDir: import.meta.dirname,
      },
    },
  },
];

Note: this is flat config (ESLint 9+). The legacy eslintrc options env.* and parserOptions.sourceType no longer apply — use languageOptions / languageOptions.globals instead.