@andreashuber69/eslint-config NPM

This is a comprehensive and carefully curated shareable eslint config for TypeScript projects.

Rationale

A search for eslint-config and typescript on npm lists well over 2500 packages. Despite this abundance, I've failed to find a package that satisfies what I was looking for, namely:

Leverage the best eslint-plugins to thoroughly inspect code. To get an idea of what this config tries to achieve, it's probably best to compare the number of active rules recommended for TypeScript projects (see TS eslint quick start) with React support (see eslint-plugin-react) to the number of active rules in this configuration. At the time of writing the count is only 97 for the recommended set compared to 596 rules in this package. More specifically, ...
- flag as many problems and as much inconsistent formatting as possible while keeping false positives low. Developers should be able to correct most errors and warnings by rewriting the code as opposed to sprinkling it with eslint-disable.
- treat developers as responsible human beings and trust that they have a good sense of how much and what documentation is necessary. Forcing developers to write docs usually leads to text that is not actually helpful and therefore a waste of time.
- enforce established ES and TS naming conventions.
Make installation, configuration and maintenance as easy as possible. With npm >= 7.0 you only need to install and update this package. All dependencies are kept up to date automatically, see Getting Started for more information.
Closely track the versions of all dependencies and release new config versions as necessary.
Last but not least: Automatically test the configuration, such that changes in eslint and the plugins (e.g. added or removed rules) are detected and the rules listed in the configuration are always in sync with the rules provided. With 7 plugins adding rules to this package, it's hard to overstate the importance of testing for completeness and consistency. No other eslint configuration out there seems to do that, which is probably why some of them still needlessly turn off eslint base rules in favor of their @typescript-eslint counterparts, even though they extend from the @typescript-eslint/recommended list (which already does that).

To see how the linted code will look like, you can look at async-css-plugin and verify-coldcard-dice-seed. If the code looks sensible to you, you might want to give this package a try in your project. Of course, you can tweak everything to your liking, see below.

Prerequisites

The configuration provided by this package and the instructions below are designed to work out of the box for already setup TypeScript projects. That is, there must be a tsconfig.json file in a direct or indirect parent folder of every linted .ts file, see this article for details. Also, while not required, it is recommended to have your tsconfig.json extend from a strict configuration. Here's an example for node:

{
  "extends": [
    "@tsconfig/strictest/tsconfig",
    "@tsconfig/node-lts/tsconfig"
  ],
  "compilerOptions": {
    // Additional compiler options to the ones set by @tsconfig
  },
  "include": [
    "src/**/*"
  ]
}

Getting Started

Installation

On the command line, first enter npm -v to see what version of npm you have installed. If you have a version >=7.0.0, please use this command:

npm install --save-dev @andreashuber69/eslint-config

Otherwise, please use this command:

npx install-peerdeps @andreashuber69/eslint-config --dev

On npm 7 and newer, peer dependencies are installed automatically. On older versions of npm, you can use the tool install-peerdeps as shown above or install the peer dependencies manually.

Configuration

Create the new file .eslintrc.cjs in the root folder of your project, with the following contents:
```
module.exports = {
    env: {
        // You need to set your execution environment (node, browser, etc.), for more information please see
        // https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-environments
        node: true,
    },
    extends: ["@andreashuber69"],
    rules: {
        // Customize rules as you see fit
    },
};
```
This is typically enough, as eslint will merge the above with parserOptions: { ecmaVersion: "latest" }, env: { es2024: true } and other defaults. To see the complete configuration you might want to run ...
```
npx eslint --print-config .eslintrc.cjs >eslint-config.json
```
... and inspect eslint-config.json. Note that for a typical TS project you want to parse according to the latest standard because the TypeScript compiler will downlevel language features depending on the target setting in tsconfig.json.
Add the following line to the scripts section of your package.json (assuming your code resides in the src folder):
```
"lint": "eslint --ext .js,.ts --report-unused-disable-directives './src'",
```