eslint.config.js

import eslint from "@eslint/js";
import comments from "@eslint-community/eslint-plugin-eslint-comments/configs";
import vitest from "@vitest/eslint-plugin";
import jsdoc from "eslint-plugin-jsdoc";
import jsonc from "eslint-plugin-jsonc";
import markdown from "eslint-plugin-markdown";
import n from "eslint-plugin-n";
import packageJson from "eslint-plugin-package-json/configs/recommended";
import perfectionist from "eslint-plugin-perfectionist";
import * as regexp from "eslint-plugin-regexp";
import yml from "eslint-plugin-yml";
import tseslint from "typescript-eslint";

export default tseslint.config(
  {
    ignores: ["coverage*", "lib", "node_modules", "pnpm-lock.yaml", "**/*.snap"],
  },
  {
    linterOptions: {
      reportUnusedDisableDirectives: "error",
    },
  },
  eslint.configs.recommended,
  ...jsonc.configs["flat/recommended-with-json"],
  ...markdown.configs.recommended,
  ...yml.configs["flat/recommended"],
  ...yml.configs["flat/prettier"],
  comments.recommended,
  jsdoc.configs["flat/contents-typescript-error"],
  jsdoc.configs["flat/logical-typescript-error"],
  jsdoc.configs["flat/stylistic-typescript-error"],
  n.configs["flat/recommended"],
  packageJson,
  perfectionist.configs["recommended-natural"],
  regexp.configs["flat/recommended"],
  ...tseslint.config({
    extends: [...tseslint.configs.strictTypeChecked, ...tseslint.configs.stylisticTypeChecked],
    files: ["**/*.js", "**/*.ts"],
    languageOptions: {
      parserOptions: {
        projectService: {
          allowDefaultProject: ["*.*s", "eslint.config.js"],
          defaultProject: "./tsconfig.json",
        },
        tsconfigRootDir: import.meta.dirname,
      },
    },
    rules: {
      // These off-by-default rules work well for this repo and we like them on.
      "logical-assignment-operators": ["error", "always", { enforceForIfStatements: true }],
      "operator-assignment": "error",

      // These on-by-default rules don't work well for this repo and we like them off.
      "jsdoc/lines-before-block": "off",
      "no-constant-condition": "off",

      // These on-by-default rules work well for this repo if configured
      "@typescript-eslint/no-unused-vars": ["error", { caughtErrors: "all" }],
      "n/no-unsupported-features/node-builtins": ["error", { allowExperimental: true }],
      "perfectionist/sort-objects": "off",
      "perfectionist/sort-intersection-types": "off",

      // Stylistic concerns that don't interfere with Prettier
      "no-useless-rename": "error",
      "object-shorthand": "error",
    },
  }),
  {
    files: ["*.jsonc"],
    rules: {
      "jsonc/comma-dangle": "off",
      "jsonc/no-comments": "off",
      "jsonc/sort-keys": "error",
    },
  },
  {
    extends: [tseslint.configs.disableTypeChecked],
    files: ["**/*.md/*.ts"],
    rules: {
      "n/no-missing-import": ["error", { allowModules: ["nest-flystorage"] }],
    },
  },
  {
    files: ["**/*.test.*"],
    languageOptions: {
      globals: vitest.environments.env.globals,
    },
    plugins: { vitest },
    rules: {
      ...vitest.configs.recommended.rules,

      // These on-by-default rules aren't useful in test files.
      "@typescript-eslint/no-unsafe-assignment": "off",
      "@typescript-eslint/no-unsafe-call": "off",
    },
  },
  {
    files: ["**/*.{yml,yaml}"],
    rules: {
      "yml/file-extension": ["error", { extension: "yml" }],
      "yml/sort-keys": [
        "error",
        {
          order: { type: "asc" },
          pathPattern: "^.*$",
        },
      ],
      "yml/sort-sequence-values": [
        "error",
        {
          order: { type: "asc" },
          pathPattern: "^.*$",
        },
      ],
    },
  },
);