feat(typescript-estree): add defaultProject for project service

docs/packages/TypeScript_ESTree.mdx

@@ -277,9 +277,14 @@ interface ParseAndGenerateServicesOptions extends ParseOptions {
  */
 interface ProjectServiceOptions {
   /**
-   * Globs of files to allow running with the default inferred project settings.
+   * Globs of files to allow running with the default project compiler options.
    */
   allowDefaultProjectForFiles?: string[];
+
+  /**
+   * Path to a TSConfig to use instead of TypeScript's default project configuration.
+   */
+  defaultProject?: string;
 }
 
 interface ParserServices {

packages/typescript-estree/src/create-program/createProjectService.ts

@@ -1,4 +1,6 @@
 /* eslint-disable @typescript-eslint/no-empty-function -- for TypeScript APIs*/
+import os from 'node:os';
+
 import type * as ts from 'typescript/lib/tsserverlibrary';
 
 import type { ProjectServiceOptions } from '../parser-options';
@@ -58,6 +60,40 @@
     jsDocParsingMode,
   });
 
+  if (typeof options === 'object' && options.defaultProject) {
+    try {
+      const configRead = tsserver.readConfigFile(
+        options.defaultProject,
+        system.readFile,
+      );
+
+      if (configRead.error) {
+        throw new Error(
+          `Could not read default project '${options.defaultProject}': ${tsserver.formatDiagnostic(
+            configRead.error,
+            {
+              getCurrentDirectory: system.getCurrentDirectory,
+              getCanonicalFileName: (fileName: string) => fileName,
+              getNewLine: () => os.EOL,
+            },
+          )}`,
+        );
+      }
+
+      type ProjectCompilerOptions =
+        ts.server.protocol.InferredProjectCompilerOptions;
+
+      service.setCompilerOptionsForInferredProjects(
+        (configRead.config as { compilerOptions: ProjectCompilerOptions })
+          .compilerOptions,
+      );
+    } catch (error) {
+      throw new Error(
+        `Could not parse default project '${options.defaultProject}': ${(error as Error).message}`,
+      );
+    }
+  }
+
   return {
     allowDefaultProjectForFiles:
       typeof options === 'object'

packages/typescript-estree/src/parser-options.ts

@@ -109,6 +109,11 @@ export interface ProjectServiceOptions {
    * Globs of files to allow running with the default inferred project settings.
    */
   allowDefaultProjectForFiles?: string[];
+
+  /**
+   * Path to a TSConfig to use instead of TypeScript's default project configuration.
+   */
+  defaultProject?: string;
 }
 
 interface ParseAndGenerateServicesOptions extends ParseOptions {

packages/typescript-estree/tests/lib/createProjectService.test.ts

@@ -1,5 +1,14 @@
+import * as ts from 'typescript';
+
 import { createProjectService } from '../../src/create-program/createProjectService';
 
+const mockReadConfigFile = jest.fn();
+
+jest.mock('typescript/lib/tsserverlibrary', () => ({
+  ...jest.requireActual('typescript/lib/tsserverlibrary'),
+  readConfigFile: mockReadConfigFile,
+}));
+
 describe('createProjectService', () => {
   it('sets allowDefaultProjectForFiles when options.allowDefaultProjectForFiles is defined', () => {
     const allowDefaultProjectForFiles = ['./*.js'];
@@ -18,4 +27,41 @@ describe('createProjectService', () => {
 
     expect(settings.allowDefaultProjectForFiles).toBeUndefined();
   });
+
+  it('throws an error when options.defaultProject is set and the readConfigFile returns an error', () => {
+    mockReadConfigFile.mockReturnValue({
+      error: {
+        category: ts.DiagnosticCategory.Error,
+        code: 1000,
+      },
+    });
+
+    expect(() =>
+      createProjectService(
+        {
+          allowDefaultProjectForFiles: ['file.js'],
+          defaultProject: './tsconfig.json',
+        },
+        undefined,
+      ),
+    ).toThrow(
+      /Could not read default project '\.\/tsconfig.json': error TS1000/,
+    );
+  });
+
+  it('throws an error when options.defaultProject is set and the readConfigFile throws an error', () => {
+    mockReadConfigFile.mockImplementation(() => {
+      throw new Error('Oh no!');
+    });
+
+    expect(() =>
+      createProjectService(
+        {
+          allowDefaultProjectForFiles: ['file.js'],
+          defaultProject: './tsconfig.json',
+        },
+        undefined,
+      ),
+    ).toThrow("Could not parse default project './tsconfig.json': Oh no!");
+  });
 });