chore: add comments

zanminkian · Nov 23, 2024 · 6cdb0b3 · 6cdb0b3
1 parent 9f04b44
commit 6cdb0b3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -36,7 +36,7 @@
     "eslint-plugin-esm": "workspace:*",
     "eslint-plugin-fp": "2.3.0",
     "eslint-plugin-import": "2.31.0",
-    "eslint-plugin-n": "17.13.2",
+    "eslint-plugin-n": "17.14.0",
     "eslint-plugin-pkg-json": "workspace:*",
     "eslint-plugin-promise": "7.1.0",
     "eslint-plugin-publint": "workspace:*",

diff --git a/packages/eslint-config/src/config/typescript.ts b/packages/eslint-config/src/config/typescript.ts
@@ -83,6 +83,9 @@ export function typescript(project?: string) {
         parserOptions: {
           ...jsConfig.languageOptions.parserOptions,
           tsconfigRootDir: process.cwd(),
+          // Setting `projectService: true` or `project: true` is pretty slow when lint a monorepo with many tsconfig.json files in each sub-app.
+          // For a better performance, we are recommended using one tsconfig.json file in a project.
+          // Waiting for typescript-eslint to officially provide a better way to use `projectService`.
           project: project ?? "tsconfig.json",
         },
       },