.eslintrc.json

{
  "root": true,
  "env": {
    "es2021": true,
    "node": true
  },
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaFeatures": {
      "jsx": true
    },
    "project": "./tsconfig.json"
  },
  "plugins": [
    "react",
    "import",
    "@typescript-eslint",
    "react-refresh",
    "tss-unused-classes"
  ],
  "extends": [
    "eslint:recommended",
    "plugin:eslint-comments/recommended",
    "plugin:react/recommended",
    "plugin:react/jsx-runtime", // Vite enables the automatic JSX runtime
    "plugin:react-hooks/recommended",
    "plugin:@typescript-eslint/eslint-recommended",
    "plugin:@typescript-eslint/recommended",
    "plugin:@typescript-eslint/recommended-requiring-type-checking",
    "plugin:@typescript-eslint/strict",
    "plugin:import/recommended",
    "plugin:import/typescript",
    "plugin:jsx-a11y/recommended",
    "prettier"
  ],
  "reportUnusedDisableDirectives": true,
  "settings": {
    "import/resolver": {
      "typescript": {
        "project": "tsconfig.json"
      }
    },
    "react": {
      "version": "detect"
    }
  },
  "rules": {
    "@typescript-eslint/ban-ts-comment": [
      "error",
      {
        "ts-expect-error": "allow-with-description",
        "minimumDescriptionLength": 10
      }
    ],
    "@typescript-eslint/consistent-type-definitions": "off",
    "@typescript-eslint/consistent-type-exports": "error",
    "@typescript-eslint/consistent-type-imports": [
      "warn",
      { "fixStyle": "inline-type-imports" }
    ],
    "@typescript-eslint/no-import-type-side-effects": "error",
    "@typescript-eslint/no-misused-promises": [
      "error",
      {
        "checksVoidReturn": false
      }
    ],
    "@typescript-eslint/no-unused-vars": [
      "warn",
      { "argsIgnorePattern": "^_" } // Ignore arguments that start with an underscore
    ],
    "import/no-extraneous-dependencies": [
      "error",
      {
        "devDependencies": [
          "./src/demo/**",
          "./src/**/__tests__/**",
          "vite.config.mts"
        ],
        "includeTypes": true
      }
    ],
    "import/no-mutable-exports": "error",
    "import/no-unused-modules": "error",
    // Note that no-duplicates prefer-inline doesn't yet handle duplicate type
    // imports properly
    // https://github.com/import-js/eslint-plugin-import/issues/2715
    // (improvements are unreleased in eslint-plugin-import)
    "import/no-duplicates": ["error", { "prefer-inline": true }],
    "no-console": [
      "warn",
      {
        "allow": ["warn", "error"]
      }
    ],
    "no-restricted-imports": "off",
    "@typescript-eslint/no-restricted-imports": [
      "error",
      {
        "paths": [
          {
            "name": "lodash",
            "message": "Please use specific module imports like \"lodash/foo\" instead of \"lodash\".",
            "allowTypeImports": true
          },
          {
            "name": "@mui/icons-material",
            "message": "Please use second-level default path imports rather than top-level named imports. See https://github.com/sjdemartini/mui-tiptap/issues/154"
          }
        ],
        // Disallow imports of third-level MUI "private" paths per
        // https://mui.com/material-ui/guides/minimizing-bundle-size/#option-one-use-path-imports
        "patterns": [
          {
            "group": ["@mui/*/*/*"],
            "message": "Imports of third-level MUI \"private\" paths are not allowed per https://mui.com/material-ui/guides/minimizing-bundle-size/#option-one-use-path-imports"
          }
        ]
      }
    ],
    "react/function-component-definition": "warn",
    "react/jsx-no-useless-fragment": ["warn", { "allowExpressions": true }],
    "react-hooks/exhaustive-deps": [
      "warn",
      {
        "additionalHooks": "(useUpdateEffect)"
      }
    ],
    "react-refresh/only-export-components": [
      "warn",
      { "allowConstantExport": true }
    ],
    "tss-unused-classes/unused-classes": "warn"
  }
}