@slhs/eslint-config

@slhs/eslint-config

This is the SLHS ESLint configuration.

Requirements

This config uses the new "Flat Config" format and comes with some requirements:

• Node.js 20.0.0 or newer
• ESLint 8.57.0 or newer
• Your project to be in native ESM ("type": "module" in your package.json)
• VSCode must be configured to use the Flat Config file (eslint.config.js). You'll probably want to enable this as a workspace setting (not a user setting) and check it in to source control:

Install

pnpm add -D @slhs/eslint-config

Be sure to install the appropriately versioned eslint peer dependency as well.

Usage

Follow the ESLint documentation on shared configurations. See the documentation on ignoring files if you need to ignore anything the config doesn't already ignore by default.

Examples

eslint.config.js

import { defineConfig } from 'eslint/config';
import slhsConfig from '@slhs/eslint-config';

const config = defineConfig([
  slhsConfig,
  {
    // your optional overrides here
  },
]);

export default config;

package.json

{
  "scripts": {
    ...
    "lint": "eslint --cache --cache-location ./node_modules/.cache/eslint .",
    ...
  }
}