@gtbuchanan/eslint-config

@gtbuchanan/eslint-config

Shared ESLint configuration for TypeScript projects.

Install

pnpm add -D @gtbuchanan/eslint-config eslint jiti

Usage

// eslint.config.ts
import { configure } from '@gtbuchanan/eslint-config';

export default configure({
  tsconfigRootDir: import.meta.dirname,
});

Pre-commit

pre-commit runs hooks in an isolated environment where your project's node_modules is not available. Use createRequire so that @gtbuchanan/eslint-config resolves in both local development and the pre-commit isolated environment:

// eslint.config.ts
import { createRequire } from 'node:module';
import { pathToFileURL } from 'node:url';
import type * as EslintConfig from '@gtbuchanan/eslint-config';

interface ModuleMap {
  '@gtbuchanan/eslint-config': typeof EslintConfig;
}

// createRequire bridges ESM→CJS resolution, which respects NODE_PATH (set by pre-commit)
const { resolve } = createRequire(import.meta.url);

async function importModule<S extends keyof ModuleMap>(
  specifier: S,
): Promise<ModuleMap[S]> {
  const { href } = pathToFileURL(resolve(specifier));
  const module: ModuleMap[S] = await import(href);
  return module;
}

const { configure } = await importModule('@gtbuchanan/eslint-config');

export default configure({
  tsconfigRootDir: import.meta.dirname,
});

Included plugins

• typescript-eslint — strictTypeChecked + stylisticTypeChecked presets
• eslint-plugin-unicorn — Recommended modern JS/TS rules
• eslint-plugin-promise — Promise best practices
• @stylistic/eslint-plugin — Formatting rules (semicolons, quotes, etc.)
• @eslint-community/eslint-plugin-eslint-comments — Suppression comment hygiene
• eslint-plugin-import-x — Import ordering
• @eslint/json — JSON file linting
• @vitest/eslint-plugin — Vitest test-specific rules
• eslint-plugin-n — Node.js best practices
• eslint-plugin-pnpm — pnpm workspace validation (opt-in)
• eslint-plugin-yml — YAML linting and key sorting
• eslint-plugin-toml — TOML linting and structural key/table ordering
• @eslint/markdown — Official Markdown lint plugin (commonmark AST)
• @gtbuchanan/eslint-plugin-markdownlint — Markdown structural linting via markdownlint (gap-filling rules not yet covered by @eslint/markdown)
• eslint-plugin-only-warn — Downgrades errors to warnings (opt-in)

Markdown linting

Two plugins lint Markdown alongside each other: @eslint/markdown runs its recommended rule set, and @gtbuchanan/eslint-plugin-markdownlint fills the gaps @eslint/markdown doesn't yet cover. Rules @eslint/markdown already enforces (e.g. duplicate headings, bare URLs, missing alt text) are disabled in markdownlint to keep diagnostics single-sourced. As @eslint/markdown adds rules upstream, the markdownlint counterparts retire one by one.

Suppressions

@eslint/markdown rules suppress with the standard ESLint HTML-comment syntax:

<!-- eslint-disable-next-line markdown/no-duplicate-headings -- intentional -->

# Duplicate heading allowed here

markdownlint/lint runs as a single ESLint rule, so per-rule control uses markdownlint's own comment syntax instead:

<!-- markdownlint-disable-next-line MD036 -->

**Bold paragraph used as heading**

<!-- eslint-disable markdownlint/lint --> would suppress every markdownlint rule at once. Prefer the markdownlint directive for single-rule scope. See the markdownlint docs for the full inline directive syntax.