@tractorbeam/eslint-config

Shared ESLint configuration for Tractorbeam projects using modern flat config format.

Installation

pnpm add -D @tractorbeam/eslint-config eslint typescript-eslint

TypeScript config files (eslint.config.ts)

If you use an eslint.config.ts file under Node.js, ESLint requires the optional dev dependency jiti (v2+):

pnpm add -D jiti

Quick Start

// eslint.config.ts
import { defineConfig } from "eslint/config";

import { base, react, typescript } from "@tractorbeam/eslint-config";

export default defineConfig([base, typescript, react]);

Available Configs

| Config | Description | File Patterns | | ------------------- | ---------------------------------------- | ------------------------------- | | base | ESLint recommended rules | All files | | typescript | TypeScript, unicorn, regexp, import-lite | **/*.ts, **/*.tsx | | react | React, hooks, a11y, react-compiler | **/*.tsx, **/*.jsx | | tanstackRouter | TanStack Router plugin | **/*.tsx, **/*.jsx | | node | Node.js globals | All files | | cloudflareWorkers | Cloudflare Workers globals | All files | | playwright | Playwright testing rules | No default (use with extends) |

Customization

Disabling Type Checking for JS Files

If you have JavaScript files alongside TypeScript, disable type checking for them:

import { defineConfig } from "eslint/config";
import tseslint from "typescript-eslint";

import { base, typescript } from "@tractorbeam/eslint-config";

export default defineConfig([
  base,
  typescript,
  { files: ["**/*.js"], extends: [tseslint.configs.disableTypeChecked] },
]);

Custom File Patterns

Use extends to apply configs to specific file patterns:

import { defineConfig } from "eslint/config";

import { base, playwright, typescript } from "@tractorbeam/eslint-config";

export default defineConfig([
  base,
  eslint,
  { files: ["**/e2e/**/*.ts"], extends: [playwright] },
]);

Overriding Rules

Override any rules by adding them after extends:

import { defineConfig } from "eslint/config";

import { base, react, typescript } from "@tractorbeam/eslint-config";

export default defineConfig([
  base,
  typescript,
  {
    extends: [react],
    rules: {
      "react-hooks/exhaustive-deps": "error",
    },
  },
]);

Adding Ignores

Use ESLint's built-in ignore utilities:

import { includeIgnoreFile } from "@eslint/compat";
import { defineConfig, globalIgnores } from "eslint/config";

import { base, typescript } from "@tractorbeam/eslint-config";

export default defineConfig([
  base,
typescript
  includeIgnoreFile(".gitignore"),
  globalIgnores(["dist/**", "*.gen.ts"]),
]);

Peer Dependencies

• eslint >= 9
• typescript-eslint >= 8