@typescript-eslint/project-service 8.32.2-alpha.12

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 typescript-eslint and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,12 @@
+# `@typescript-eslint/project-service`
+
+> Standalone TypeScript project service wrapper for linting.
+
+[![NPM Version](https://img.shields.io/npm/v/@typescript-eslint/project-service.svg?style=flat-square)](https://www.npmjs.com/package/@typescript-eslint/project-service)
+[![NPM Downloads](https://img.shields.io/npm/dm/@typescript-eslint/project-service.svg?style=flat-square)](https://www.npmjs.com/package/@typescript-eslint/project-service)
+
+A standalone export of the "Project Service" that powers typed linting for typescript-eslint.
+
+> See https://typescript-eslint.io for general documentation on typescript-eslint, the tooling that allows you to run ESLint and Prettier on TypeScript code.
+
+<!-- Local path for docs: docs/packages/Project_Service.mdx -->

package/dist/createProjectService.d.ts

@@ -0,0 +1,60 @@
+import type { ProjectServiceOptions } from '@typescript-eslint/types';
+import type * as ts from 'typescript/lib/tsserverlibrary';
+/**
+ * Shortcut type to refer to TypeScript's server ProjectService.
+ */
+export type TypeScriptProjectService = ts.server.ProjectService;
+/**
+ * A created Project Service instance, as well as metadata on its creation.
+ */
+export interface ProjectServiceAndMetadata {
+    /**
+     * Files allowed to be loaded from the default project, if any were specified.
+     */
+    allowDefaultProject: string[] | undefined;
+    /**
+     * The performance.now() timestamp of the last reload of the project service.
+     */
+    lastReloadTimestamp: number;
+    /**
+     * The maximum number of files that can be matched by the default project.
+     */
+    maximumDefaultProjectFileMatchCount: number;
+    /**
+     * The created TypeScript Project Service instance.
+     */
+    service: TypeScriptProjectService;
+}
+/**
+ * Settings to create a new Project Service instance with {@link createProjectService}.
+ */
+export interface CreateProjectServiceSettings {
+    /**
+     * Granular options to configure the project service.
+     */
+    options?: ProjectServiceOptions;
+    /**
+     * How aggressively (and slowly) to parse JSDoc comments.
+     */
+    jsDocParsingMode?: ts.JSDocParsingMode;
+    /**
+     * Root directory for the tsconfig.json file, if not the current directory.
+     */
+    tsconfigRootDir?: string;
+}
+/**
+ * Creates a new Project Service instance, as well as metadata on its creation.
+ * @param settings Settings to create a new Project Service instance.
+ * @returns A new Project Service instance, as well as metadata on its creation.
+ * @example
+ * ```ts
+ * import { createProjectService } from '@typescript-eslint/project-service';
+ *
+ * const { service } = createProjectService();
+ *
+ * service.openClientFile('index.ts');
+ * ```
+ */
+export declare function createProjectService({ jsDocParsingMode, options: optionsRaw, tsconfigRootDir, }?: CreateProjectServiceSettings): ProjectServiceAndMetadata;
+export { type ProjectServiceOptions } from '@typescript-eslint/types';
+//# sourceMappingURL=createProjectService.d.ts.map

package/dist/createProjectService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createProjectService.d.ts","sourceRoot":"","sources":["../src/createProjectService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,KAAK,KAAK,EAAE,MAAM,gCAAgC,CAAC;AA4B1D;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,mBAAmB,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAE1C;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,mCAAmC,EAAE,MAAM,CAAC;IAE5C;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAEhC;;OAEG;IACH,gBAAgB,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC;IAEvC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAAC,EACnC,gBAAgB,EAChB,OAAO,EAAE,UAAe,EACxB,eAAe,GAChB,GAAE,4BAAiC,GAAG,yBAAyB,CA0H/D;AAED,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/createProjectService.js

@@ -0,0 +1,137 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProjectService = createProjectService;
+const debug_1 = __importDefault(require("debug"));
+const getParsedConfigFileFromTSServer_js_1 = require("./getParsedConfigFileFromTSServer.js");
+const DEFAULT_PROJECT_MATCHED_FILES_THRESHOLD = 8;
+const log = (0, debug_1.default)('typescript-eslint:project-service:createProjectService');
+const logTsserverErr = (0, debug_1.default)('typescript-eslint:project-service:tsserver:err');
+const logTsserverInfo = (0, debug_1.default)('typescript-eslint:project-service:tsserver:info');
+const logTsserverPerf = (0, debug_1.default)('typescript-eslint:project-service:tsserver:perf');
+const logTsserverEvent = (0, debug_1.default)('typescript-eslint:project-service:tsserver:event');
+// For TypeScript APIs that expect a function to be passed in
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+const doNothing = () => { };
+const createStubFileWatcher = () => ({
+    close: doNothing,
+});
+/**
+ * Creates a new Project Service instance, as well as metadata on its creation.
+ * @param settings Settings to create a new Project Service instance.
+ * @returns A new Project Service instance, as well as metadata on its creation.
+ * @example
+ * ```ts
+ * import { createProjectService } from '@typescript-eslint/project-service';
+ *
+ * const { service } = createProjectService();
+ *
+ * service.openClientFile('index.ts');
+ * ```
+ */
+function createProjectService({ jsDocParsingMode, options: optionsRaw = {}, tsconfigRootDir, } = {}) {
+    const options = {
+        defaultProject: 'tsconfig.json',
+        ...optionsRaw,
+    };
+    // We import this lazily to avoid its cost for users who don't use the service
+    // TODO: Once we drop support for TS<5.3 we can import from "typescript" directly
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    const tsserver = require('typescript/lib/tsserverlibrary');
+    // TODO: see getWatchProgramsForProjects
+    // We don't watch the disk, we just refer to these when ESLint calls us
+    // there's a whole separate update pass in maybeInvalidateProgram at the bottom of getWatchProgramsForProjects
+    // (this "goes nuclear on TypeScript")
+    const system = {
+        ...tsserver.sys,
+        clearImmediate,
+        clearTimeout,
+        setImmediate,
+        setTimeout,
+        watchDirectory: createStubFileWatcher,
+        watchFile: createStubFileWatcher,
+        // We stop loading any TypeScript plugins by default, to prevent them from attaching disk watchers
+        // See https://github.com/typescript-eslint/typescript-eslint/issues/9905
+        ...(!options.loadTypeScriptPlugins && {
+            require: () => ({
+                error: {
+                    message: 'TypeScript plugins are not required when using parserOptions.projectService.',
+                },
+                module: undefined,
+            }),
+        }),
+    };
+    const logger = {
+        close: doNothing,
+        endGroup: doNothing,
+        getLogFileName: () => undefined,
+        // The debug library doesn't use levels without creating a namespace for each.
+        // Log levels are not passed to the writer so we wouldn't be able to forward
+        // to a respective namespace.  Supporting would require an additional flag for
+        // granular control.  Defaulting to all levels for now.
+        hasLevel: () => true,
+        info(s) {
+            this.msg(s, tsserver.server.Msg.Info);
+        },
+        loggingEnabled: () => 
+        // if none of the debug namespaces are enabled, then don't enable logging in tsserver
+        logTsserverInfo.enabled ||
+            logTsserverErr.enabled ||
+            logTsserverPerf.enabled,
+        msg: (s, type) => {
+            switch (type) {
+                case tsserver.server.Msg.Err:
+                    logTsserverErr(s);
+                    break;
+                case tsserver.server.Msg.Perf:
+                    logTsserverPerf(s);
+                    break;
+                default:
+                    logTsserverInfo(s);
+            }
+        },
+        perftrc(s) {
+            this.msg(s, tsserver.server.Msg.Perf);
+        },
+        startGroup: doNothing,
+    };
+    log('Creating Project Service with: %o', options);
+    const service = new tsserver.server.ProjectService({
+        cancellationToken: { isCancellationRequested: () => false },
+        eventHandler: logTsserverEvent.enabled
+            ? (e) => {
+                logTsserverEvent(e);
+            }
+            : undefined,
+        host: system,
+        jsDocParsingMode,
+        logger,
+        session: undefined,
+        useInferredProjectPerProjectRoot: false,
+        useSingleInferredProject: false,
+    });
+    service.setHostConfiguration({
+        preferences: {
+            includePackageJsonAutoImports: 'off',
+        },
+    });
+    log('Enabling default project: %s', options.defaultProject);
+    const configFile = (0, getParsedConfigFileFromTSServer_js_1.getParsedConfigFileFromTSServer)(tsserver, options.defaultProject, !!optionsRaw.defaultProject, tsconfigRootDir);
+    if (configFile) {
+        service.setCompilerOptionsForInferredProjects(
+        // NOTE: The inferred projects API is not intended for source files when a tsconfig
+        // exists. There is no API that generates an InferredProjectCompilerOptions suggesting
+        // it is meant for hard coded options passed in. Hard asserting as a work around.
+        // See https://github.com/microsoft/TypeScript/blob/27bcd4cb5a98bce46c9cdd749752703ead021a4b/src/server/protocol.ts#L1904
+        configFile.options);
+    }
+    return {
+        allowDefaultProject: options.allowDefaultProject,
+        lastReloadTimestamp: performance.now(),
+        maximumDefaultProjectFileMatchCount: options.maximumDefaultProjectFileMatchCount_THIS_WILL_SLOW_DOWN_LINTING ??
+            DEFAULT_PROJECT_MATCHED_FILES_THRESHOLD,
+        service,
+    };
+}

package/dist/getParsedConfigFileFromTSServer.d.ts

@@ -0,0 +1,3 @@
+import type * as ts from 'typescript/lib/tsserverlibrary';
+export declare function getParsedConfigFileFromTSServer(tsserver: typeof ts, defaultProject: string, throwOnFailure: boolean, tsconfigRootDir?: string): ts.ParsedCommandLine | undefined;
+//# sourceMappingURL=getParsedConfigFileFromTSServer.d.ts.map

package/dist/getParsedConfigFileFromTSServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getParsedConfigFileFromTSServer.d.ts","sourceRoot":"","sources":["../src/getParsedConfigFileFromTSServer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,EAAE,MAAM,gCAAgC,CAAC;AAI1D,wBAAgB,+BAA+B,CAC7C,QAAQ,EAAE,OAAO,EAAE,EACnB,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,OAAO,EACvB,eAAe,CAAC,EAAE,MAAM,GACvB,EAAE,CAAC,iBAAiB,GAAG,SAAS,CAYlC"}

package/dist/getParsedConfigFileFromTSServer.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getParsedConfigFileFromTSServer = getParsedConfigFileFromTSServer;
+const tsconfig_utils_1 = require("@typescript-eslint/tsconfig-utils");
+function getParsedConfigFileFromTSServer(tsserver, defaultProject, throwOnFailure, tsconfigRootDir) {
+    try {
+        return (0, tsconfig_utils_1.getParsedConfigFile)(tsserver, defaultProject, tsconfigRootDir);
+    }
+    catch (error) {
+        if (throwOnFailure) {
+            throw new Error(`Could not read Project Service default project '${defaultProject}': ${error.message}`);
+        }
+    }
+    return undefined;
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './createProjectService';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./createProjectService"), exports);

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@typescript-eslint/project-service",
+  "version": "8.32.2-alpha.12",
+  "description": "Standalone TypeScript project service wrapper for linting.",
+  "files": [
+    "dist",
+    "!*.tsbuildinfo",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.ts",
+  "engines": {
+    "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/typescript-eslint/typescript-eslint.git",
+    "directory": "packages/project-service"
+  },
+  "bugs": {
+    "url": "https://github.com/typescript-eslint/typescript-eslint/issues"
+  },
+  "homepage": "https://typescript-eslint.io",
+  "license": "MIT",
+  "keywords": [
+    "eslint",
+    "typescript",
+    "estree"
+  ],
+  "scripts": {
+    "//": "These package scripts are mostly here for convenience. Task running is handled by Nx at the root level.",
+    "build": "yarn run -BT nx build",
+    "clean": "rimraf dist/ coverage/",
+    "format": "yarn run -T format",
+    "lint": "yarn run -BT nx lint",
+    "test": "yarn run -BT nx test",
+    "typecheck": "yarn run -BT nx typecheck"
+  },
+  "dependencies": {
+    "@typescript-eslint/tsconfig-utils": "^8.32.2-alpha.12",
+    "@typescript-eslint/types": "^8.32.2-alpha.12",
+    "debug": "^4.3.4"
+  },
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/typescript-eslint"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nx": {
+    "name": "project-service",
+    "includedScripts": [
+      "clean"
+    ]
+  }
+}