feat(shared): add utils to choose the parser based on enabled eslint features

Author: Rel1cx

examples/vite-react-dom-with-ts-blank-eslint-parser-app/eslint.config.js

@@ -3,11 +3,13 @@ import eslintJs from "@eslint/js";
 import eslintReact from "@eslint-react/eslint-plugin";
 import eslintPluginReactHooks from "eslint-plugin-react-hooks";
 import eslintPluginReactRefresh from "eslint-plugin-react-refresh";
-import globals from "globals";
+import tsEslintParser from "@typescript-eslint/parser";
 import tsBlankEslintParser from "ts-blank-eslint-parser";
+import globals from "globals";
 
 import TSCONFIG from "./tsconfig.json" with { type: "json" };
 import TSCONFIG_NODE from "./tsconfig.node.json" with { type: "json" };
+import { isInEditorEnv } from "@eslint-react/shared";
 
 const GLOB_TS = ["**/*.ts", "**/*.tsx"];
 
@@ -19,11 +21,7 @@ export default [
       globals: {
         ...globals.browser,
       },
-      parser: tsBlankEslintParser,
-      parserOptions: {
-        jsxPragma: "React",
-        sourceType: "module",
-      },
+      ...getOptimalParser(),
     },
     rules: {
       ...eslintJs.configs.recommended.rules,
@@ -37,10 +35,7 @@ export default [
       globals: {
         ...globals.node,
       },
-      parser: tsBlankEslintParser,
-      parserOptions: {
-        sourceType: "module",
-      },
+      ...getOptimalParser("tsconfig.node.json"),
     },
     rules: {
       ...eslintJs.configs.recommended.rules,
@@ -71,3 +66,25 @@ export default [
     },
   },
 ];
+
+function getOptimalParser(project = "tsconfig.json") {
+  return isFixable()
+    ? {
+      parser: tsEslintParser,
+      parserOptions: {
+        project,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    }
+    : {
+      parser: tsBlankEslintParser,
+    };
+}
+
+function isFixable() {
+  return isInEditorEnv() || hasFixFlag();
+}
+
+function hasFixFlag() {
+  return process.argv.includes("--fix");
+}

examples/vite-react-dom-with-ts-blank-eslint-parser-app/package.json

@@ -16,12 +16,14 @@
   },
   "devDependencies": {
     "@eslint-react/eslint-plugin": "workspace:*",
+    "@eslint-react/shared": "workspace:*",
     "@eslint/config-inspector": "^1.0.0",
     "@eslint/js": "^9.19.0",
     "@tsconfig/node22": "^22.0.0",
     "@tsconfig/strictest": "^2.0.5",
     "@types/react": "^19.0.8",
     "@types/react-dom": "^19.0.3",
+    "@typescript-eslint/parser": "^8.22.0",
     "@vitejs/plugin-react": "^4.3.4",
     "eslint": "^9.19.0",
     "eslint-plugin-react-hooks": "^5.1.0",

packages/shared/docs/README.md

@@ -46,3 +46,5 @@
 - [getId](functions/getId.md)
 - [getReactVersion](functions/getReactVersion.md)
 - [getSettingsFromContext](functions/getSettingsFromContext.md)
+- [isInEditorEnv](functions/isInEditorEnv.md)
+- [isInGitHooksOrLintStaged](functions/isInGitHooksOrLintStaged.md)

packages/shared/docs/functions/isInEditorEnv.md

@@ -0,0 +1,13 @@
+[**@eslint-react/shared**](../README.md)
+
+***
+
+[@eslint-react/shared](../README.md) / isInEditorEnv
+
+# Function: isInEditorEnv()
+
+> **isInEditorEnv**(): `boolean`
+
+## Returns
+
+`boolean`

packages/shared/docs/functions/isInGitHooksOrLintStaged.md

@@ -0,0 +1,13 @@
+[**@eslint-react/shared**](../README.md)
+
+***
+
+[@eslint-react/shared](../README.md) / isInGitHooksOrLintStaged
+
+# Function: isInGitHooksOrLintStaged()
+
+> **isInGitHooksOrLintStaged**(): `boolean`
+
+## Returns
+
+`boolean`

packages/shared/src/env.ts

@@ -0,0 +1,25 @@
+/* eslint-disable @typescript-eslint/no-unnecessary-condition */
+/* eslint-disable @typescript-eslint/strict-boolean-expressions */
+/* eslint-disable no-constant-binary-expression */
+// Ported from https://github.com/antfu/eslint-config/blob/9a2a48bcda2e9ed026a9031924f8f6eae4af6728/src/utils.ts#L135
+export function isInEditorEnv() {
+  if (process.env["CI"]) {
+    return false;
+  }
+  if (isInGitHooksOrLintStaged()) {
+    return false;
+  }
+  return !!(false
+    || process.env["VSCODE_PID"]
+    || process.env["VSCODE_CWD"]
+    || process.env["JETBRAINS_IDE"]
+    || process.env["VIM"]
+    || process.env["NVIM"]);
+}
+
+export function isInGitHooksOrLintStaged() {
+  return !!(false
+    || process.env["GIT_PARAMS"]
+    || process.env["VSCODE_GIT_COMMAND"]
+    || process.env["npm_lifecycle_script"]?.startsWith("lint-staged"));
+}

packages/shared/src/index.ts

@@ -1,5 +1,6 @@
 export * from "./constants";
 export * from "./create-rule";
+export * from "./env";
 export * from "./get-id";
 export * from "./get-react-version";
 export * from "./schemas";