@guimauvedigital/eslint-plugin-safety v1.0.12

ESLint rules we use at Guimauve Digital

A monster against bad code

Install ESLint first

npm init @eslint/config@latest

Follow the base instructions and choose the options you want.

Install the plugin

npm install @guimauvedigital/eslint-plugin-safety --save-dev

Add the plugin

Update your eslint.config.mjs file to add the plugin:

import globals from "globals"
import safety from "@guimauvedigital/eslint-plugin-safety"

export default [
    {
        files: ["**/*.{js,mjs,cjs,ts,jsx,tsx}"],
        languageOptions: {
            globals: {...globals.browser, ...globals.node},
            parser: "@typescript-eslint/parser",
            parserOptions: {
                projectService: true,
                tsconfigRootDir: import.meta.dirname,
                project: "./tsconfig.json",
            },
        }
    },
    ...safety.configs.all,
    // Optionally add more rules specific to your project
]

Bonuses

There are good ideas taken from The long-tail of type safety | App.js Conf 2023.

TypeScript config

Update tsconfig.json and add the following settings:

{
  "compilerOptions": {
    "strict": true,
    "strictNullChecks": true,
    "noUncheckedIndexedAccess": true
  }
}

TypeScript ESLint plugin

Checkout typescript-eslint plugin for more TypeScript specific rules.

This is often already installed when you create a new project with npm init @eslint/config@latest if TypeScript is selected. We include it in our all configuration.

TypeScript Reset

ts-reset is a package that adds extra TypeScript checks about typings.

Install it with npm i -D @total-typescript/ts-reset and create a reset.d.ts file:

// Do not add any other lines of code to this file!
import "@total-typescript/ts-reset"