Merge pull request #1287 from Quramy/use_provided_typescript_module

chore: Use provided TypeScript module

.eslintrc.yml

@@ -17,10 +17,21 @@ rules:
   no-duplicate-imports: error
   no-var: error
   no-unsafe-finally: error
+  no-restricted-imports: off
   prefer-const: error
   prefer-rest-params: error
   no-trailing-spaces:
     - error
     - ignoreComments: true
   '@typescript-eslint/no-use-before-define': error
   '@typescript-eslint/no-namespace': error
+overrides:
+  - files: '**/*.ts'
+    excludedFiles: ['*.test.ts', '**/testing/**']
+    rules:
+      '@typescript-eslint/no-restricted-imports':
+        - error
+        - paths:
+            - name: typescript
+              message: "Use 'tsmodule' instead"
+              allowTypeImports: true

package.json

@@ -27,7 +27,7 @@
     "prepare": "husky install",
     "clean": "rimraf -g lib \"e2e/*.log\" \"*.tsbuildinfo\"",
     "build": "run-s build:ts build:doc",
-    "build:ts": "tsc -p .",
+    "build:ts": "tsc -p . && cp src/tsmodule.js lib && cp src/tsmodule.d.ts lib",
     "build:doc": "npm run doc:toc",
     "lint": "eslint \"src/**/*.{ts,tsx}\"",
     "jest": "jest",

src/analyzer/analyzer-factory.ts

@@ -1,5 +1,5 @@
 import path from 'node:path';
-import ts from 'typescript';
+import ts from '../tsmodule';
 import { Analyzer } from './analyzer';
 import type { TsGraphQLPluginConfigOptions } from '../types';
 import { ScriptHost } from '../ts-ast-util';

src/analyzer/analyzer.ts

@@ -1,5 +1,7 @@
 import path from 'node:path';
-import ts from 'typescript';
+
+import ts from '../tsmodule';
+
 import type { ScriptSourceHelper } from '../ts-ast-util/types';
 import { Extractor } from './extractor';
 import {

src/analyzer/extractor.ts

@@ -1,4 +1,4 @@
-import ts from 'typescript';
+import type ts from '../tsmodule';
 import {
   parse,
   visit,

src/analyzer/type-generator.ts

@@ -1,7 +1,8 @@
 import path from 'node:path';
-import ts from 'typescript';
 import type { GraphQLSchema } from 'graphql';
 
+import ts from '../tsmodule';
+
 import { TsGqlError, ErrorWithLocation } from '../errors';
 import {
   mergeAddons,

src/graphql-language-service-adapter/get-completion-at-position.ts

@@ -1,4 +1,4 @@
-import type ts from 'typescript';
+import type ts from '../tsmodule';
 import { getAutocompleteSuggestions, type CompletionItem } from 'graphql-language-service';
 import type { AnalysisContext, GetCompletionAtPosition } from './types';
 import { SimplePosition } from './simple-position';

src/graphql-language-service-adapter/get-definition-and-bound-span.ts

@@ -1,5 +1,5 @@
-import ts from 'typescript';
 import { visit, type FragmentSpreadNode } from 'graphql';
+import ts from '../tsmodule';
 import { getSanitizedTemplateText } from '../ts-ast-util';
 import type { AnalysisContext, GetDefinitionAndBoundSpan } from './types';
 

src/graphql-language-service-adapter/get-quick-info-at-position.ts

@@ -1,5 +1,6 @@
-import ts from 'typescript';
 import { getHoverInformation } from 'graphql-language-service';
+
+import ts from '../tsmodule';
 import type { AnalysisContext, GetQuickInfoAtPosition } from './types';
 import { SimplePosition } from './simple-position';
 

src/graphql-language-service-adapter/get-semantic-diagnostics.ts

@@ -1,6 +1,8 @@
-import ts from 'typescript';
 import type { FragmentDefinitionNode } from 'graphql';
 import { getDiagnostics, type Diagnostic } from 'graphql-language-service';
+
+import ts from '../tsmodule';
+
 import { SchemaBuildErrorInfo } from '../schema-manager/schema-manager';
 import { ERROR_CODES } from '../errors';
 import type { AnalysisContext, GetSemanticDiagnostics } from './types';

src/graphql-language-service-adapter/graphql-language-service-adapter.ts

@@ -1,5 +1,6 @@
-import ts from 'typescript';
 import { parse, type GraphQLSchema, type DocumentNode } from 'graphql';
+
+import ts from '../tsmodule';
 import {
   getTemplateNodeUnder,
   isTaggedTemplateNode,

src/graphql-language-service-adapter/simple-position.ts

@@ -1,4 +1,4 @@
-import type { LineAndCharacter } from 'typescript';
+import type { LineAndCharacter } from '../tsmodule';
 import type { IPosition } from 'graphql-language-service';
 
 export class SimplePosition implements IPosition {

src/index.ts

@@ -1,6 +1,6 @@
 import { pluginModuleFactory } from './language-service-plugin';
 
-export {
+export type {
   TypeGenAddonFactory,
   TypeGenVisitorAddon,
   TypeGenVisitorAddonContext,

src/language-service-plugin/create-plugin.ts

@@ -0,0 +1,85 @@
+import type ts from 'typescript/lib/tsserverlibrary';
+import type { TsGraphQLPluginConfigOptions } from '../types';
+import { GraphQLLanguageServiceAdapter } from '../graphql-language-service-adapter';
+import { SchemaManagerFactory, createSchemaManagerHostFromLSPluginInfo } from '../schema-manager';
+import { FragmentRegistry } from '../gql-ast-util';
+import {
+  createScriptSourceHelper,
+  registerDocumentChangeEvent,
+  getTemplateNodeUnder,
+  findAllNodes,
+  getSanitizedTemplateText,
+  createFileNameFilter,
+  parseTagConfig,
+} from '../ts-ast-util';
+import { LanguageServiceProxyBuilder } from './language-service-proxy-builder';
+
+export function create(info: ts.server.PluginCreateInfo): ts.LanguageService {
+  const logger = (msg: string) => info.project.projectService.logger.info(`[ts-graphql-plugin] ${msg}`);
+  logger('config: ' + JSON.stringify(info.config));
+  const schemaManager = new SchemaManagerFactory(createSchemaManagerHostFromLSPluginInfo(info)).create();
+  const { schema, errors: schemaErrors } = schemaManager.getSchema();
+  const config = info.config as TsGraphQLPluginConfigOptions;
+  const tag = parseTagConfig(config.tag);
+  const removeDuplicatedFragments = config.removeDuplicatedFragments === false ? false : true;
+  const enabledGlobalFragments = config.enabledGlobalFragments !== false;
+  const isExcluded = createFileNameFilter({ specs: config.exclude, projectName: info.project.getProjectName() });
+
+  const fragmentRegistry = new FragmentRegistry({ logger });
+  if (enabledGlobalFragments) {
+    const handleAcquireOrUpdate = (fileName: string, sourceFile: ts.SourceFile, version: string) => {
+      fragmentRegistry.registerDocuments(
+        fileName,
+        version,
+        findAllNodes(sourceFile, node => getTemplateNodeUnder(node, tag)).map(node =>
+          getSanitizedTemplateText(node, sourceFile),
+        ),
+      );
+    };
+
+    registerDocumentChangeEvent(
+      // Note:
+      // documentRegistry in ts.server.Project is annotated @internal
+      (info.project as any).documentRegistry as ts.DocumentRegistry,
+      {
+        onAcquire: (fileName, sourceFile, version) => {
+          if (!isExcluded(fileName) && info.languageServiceHost.getScriptFileNames().includes(fileName)) {
+            handleAcquireOrUpdate(fileName, sourceFile, version);
+          }
+        },
+        onUpdate: (fileName, sourceFile, version) => {
+          if (!isExcluded(fileName) && info.languageServiceHost.getScriptFileNames().includes(fileName)) {
+            if (fragmentRegistry.getFileCurrentVersion(fileName) === version) return;
+            handleAcquireOrUpdate(fileName, sourceFile, version);
+          }
+        },
+        onRelease: fileName => {
+          fragmentRegistry.removeDocument(fileName);
+        },
+      },
+    );
+  }
+
+  const scriptSourceHelper = createScriptSourceHelper(info, { exclude: config.exclude });
+  const adapter = new GraphQLLanguageServiceAdapter(scriptSourceHelper, {
+    schema,
+    schemaErrors,
+    logger,
+    tag,
+    fragmentRegistry,
+    removeDuplicatedFragments,
+  });
+
+  const proxy = new LanguageServiceProxyBuilder(info)
+    .wrap('getCompletionsAtPosition', delegate => adapter.getCompletionAtPosition.bind(adapter, delegate))
+    .wrap('getSemanticDiagnostics', delegate => adapter.getSemanticDiagnostics.bind(adapter, delegate))
+    .wrap('getQuickInfoAtPosition', delegate => adapter.getQuickInfoAtPosition.bind(adapter, delegate))
+    .wrap('getDefinitionAndBoundSpan', delegate => adapter.getDefinitionAndBoundSpan.bind(adapter, delegate))
+    .wrap('getDefinitionAtPosition', delegate => adapter.getDefinitionAtPosition.bind(adapter, delegate))
+    .build();
+
+  schemaManager.registerOnChange(adapter.updateSchema.bind(adapter));
+  schemaManager.start();
+
+  return proxy;
+}

src/language-service-plugin/plugin-module-factory.ts

@@ -1,89 +1,9 @@
-import ts from 'typescript/lib/tsserverlibrary';
-import type { TsGraphQLPluginConfigOptions } from '../types';
-import { GraphQLLanguageServiceAdapter } from '../graphql-language-service-adapter';
-import { SchemaManagerFactory, createSchemaManagerHostFromLSPluginInfo } from '../schema-manager';
-import { FragmentRegistry } from '../gql-ast-util';
-import {
-  createScriptSourceHelper,
-  registerDocumentChangeEvent,
-  getTemplateNodeUnder,
-  findAllNodes,
-  getSanitizedTemplateText,
-  createFileNameFilter,
-  parseTagConfig,
-} from '../ts-ast-util';
-import { LanguageServiceProxyBuilder } from './language-service-proxy-builder';
+import type ts from 'typescript/lib/tsserverlibrary';
 
-function create(info: ts.server.PluginCreateInfo): ts.LanguageService {
-  const logger = (msg: string) => info.project.projectService.logger.info(`[ts-graphql-plugin] ${msg}`);
-  logger('config: ' + JSON.stringify(info.config));
-  const schemaManager = new SchemaManagerFactory(createSchemaManagerHostFromLSPluginInfo(info)).create();
-  const { schema, errors: schemaErrors } = schemaManager.getSchema();
-  const config = info.config as TsGraphQLPluginConfigOptions;
-  const tag = parseTagConfig(config.tag);
-  const removeDuplicatedFragments = config.removeDuplicatedFragments === false ? false : true;
-  const enabledGlobalFragments = config.enabledGlobalFragments !== false;
-  const isExcluded = createFileNameFilter({ specs: config.exclude, projectName: info.project.getProjectName() });
+import { setModule } from './ts-server-module';
 
-  const fragmentRegistry = new FragmentRegistry({ logger });
-  if (enabledGlobalFragments) {
-    const handleAcquireOrUpdate = (fileName: string, sourceFile: ts.SourceFile, version: string) => {
-      fragmentRegistry.registerDocuments(
-        fileName,
-        version,
-        findAllNodes(sourceFile, node => getTemplateNodeUnder(node, tag)).map(node =>
-          getSanitizedTemplateText(node, sourceFile),
-        ),
-      );
-    };
-
-    registerDocumentChangeEvent(
-      // Note:
-      // documentRegistry in ts.server.Project is annotated @internal
-      (info.project as any).documentRegistry as ts.DocumentRegistry,
-      {
-        onAcquire: (fileName, sourceFile, version) => {
-          if (!isExcluded(fileName) && info.languageServiceHost.getScriptFileNames().includes(fileName)) {
-            handleAcquireOrUpdate(fileName, sourceFile, version);
-          }
-        },
-        onUpdate: (fileName, sourceFile, version) => {
-          if (!isExcluded(fileName) && info.languageServiceHost.getScriptFileNames().includes(fileName)) {
-            if (fragmentRegistry.getFileCurrentVersion(fileName) === version) return;
-            handleAcquireOrUpdate(fileName, sourceFile, version);
-          }
-        },
-        onRelease: fileName => {
-          fragmentRegistry.removeDocument(fileName);
-        },
-      },
-    );
-  }
-
-  const scriptSourceHelper = createScriptSourceHelper(info, { exclude: config.exclude });
-  const adapter = new GraphQLLanguageServiceAdapter(scriptSourceHelper, {
-    schema,
-    schemaErrors,
-    logger,
-    tag,
-    fragmentRegistry,
-    removeDuplicatedFragments,
-  });
-
-  const proxy = new LanguageServiceProxyBuilder(info)
-    .wrap('getCompletionsAtPosition', delegate => adapter.getCompletionAtPosition.bind(adapter, delegate))
-    .wrap('getSemanticDiagnostics', delegate => adapter.getSemanticDiagnostics.bind(adapter, delegate))
-    .wrap('getQuickInfoAtPosition', delegate => adapter.getQuickInfoAtPosition.bind(adapter, delegate))
-    .wrap('getDefinitionAndBoundSpan', delegate => adapter.getDefinitionAndBoundSpan.bind(adapter, delegate))
-    .wrap('getDefinitionAtPosition', delegate => adapter.getDefinitionAtPosition.bind(adapter, delegate))
-    .build();
-
-  schemaManager.registerOnChange(adapter.updateSchema.bind(adapter));
-  schemaManager.start();
-
-  return proxy;
-}
-
-export const pluginModuleFactory: ts.server.PluginModuleFactory = () => {
+export const pluginModuleFactory: ts.server.PluginModuleFactory = ({ typescript }) => {
+  setModule(typescript);
+  const { create } = require('./create-plugin') as typeof import('./create-plugin');
   return { create };
 };

src/language-service-plugin/ts-server-module.ts

@@ -0,0 +1,11 @@
+import type ts from 'typescript/lib/tsserverlibrary';
+
+let _module: typeof ts;
+
+export function setModule(typescript: typeof ts) {
+  _module = typescript;
+}
+
+export function getModule() {
+  return _module;
+}

src/schema-manager/file-schema-manager.ts

@@ -1,7 +1,8 @@
 import path from 'node:path';
-import type ts from 'typescript';
 import { buildSchema, buildClientSchema } from 'graphql';
 
+import type ts from '../tsmodule';
+
 import { SchemaManager } from './schema-manager';
 import type { SchemaManagerHost } from './types';
 

src/schema-manager/schema-manager-host.ts

@@ -1,5 +1,5 @@
 import path from 'node:path';
-import ts from 'typescript';
+import ts from '../tsmodule';
 import type { SchemaManagerHost, SchemaConfig } from './types';
 import type { TsGraphQLPluginConfigOptions } from '../types';
 

src/transformer/transformer-host.ts

@@ -1,4 +1,4 @@
-import type ts from 'typescript';
+import type ts from '../tsmodule';
 import { Kind, type DocumentNode, type FragmentDefinitionNode } from 'graphql';
 import { getFragmentDependenciesForAST } from 'graphql-language-service';
 import { AnalyzerFactory, type Analyzer, type ExtractFileResult } from '../analyzer';

src/transformer/transformer.ts

@@ -1,5 +1,5 @@
-import ts from 'typescript';
 import { print, type DocumentNode } from 'graphql';
+import ts from '../tsmodule';
 import { astf, getTemplateNodeUnder, removeAliasFromImportDeclaration, type StrictTagCondition } from '../ts-ast-util';
 
 export type DocumentTransformer = (documentNode: DocumentNode) => DocumentNode;

src/ts-ast-util/ast-factory-alias.ts

@@ -1,3 +1,3 @@
-import ts from 'typescript';
+import ts from '../tsmodule';
 
 export const astf = ts.factory;

src/ts-ast-util/output-source.ts

@@ -1,5 +1,6 @@
 import path from 'node:path';
-import ts from 'typescript';
+
+import ts from '../tsmodule';
 
 import type { OutputSource } from './types';
 import { astf } from './ast-factory-alias';

src/ts-ast-util/register-document-change-event.ts

@@ -1,4 +1,4 @@
-import type ts from 'typescript';
+import type ts from '../tsmodule';
 
 type DocumentChangeEventListener = {
   onAcquire: (fileName: string, sourceFile: ts.SourceFile, version: string) => void;

src/ts-ast-util/script-host.ts

@@ -1,4 +1,4 @@
-import ts from 'typescript';
+import ts from '../tsmodule';
 
 export class ScriptHost implements ts.LanguageServiceHost {
   private readonly _fileMap = new Map<string, string | undefined>();

src/ts-ast-util/script-source-helper.ts

@@ -1,4 +1,4 @@
-import ts from 'typescript';
+import ts from '../tsmodule';
 import { findAllNodes, findNode } from './utilily-functions';
 import { TemplateExpressionResolver } from './template-expression-resolver';
 import { createFileNameFilter } from './file-name-filter';

src/ts-ast-util/tag-utils.ts

@@ -1,4 +1,4 @@
-import ts from 'typescript';
+import ts from '../tsmodule';
 import type { TagConfig, StrictTagCondition } from './types';
 
 export const DEFAULT_TAG_CONDITION = {

src/ts-ast-util/template-expression-resolver.ts

@@ -1,4 +1,4 @@
-import ts from 'typescript';
+import ts from '../tsmodule';
 import { location2pos, pos2location } from '../string-util';
 import { findNode } from './utilily-functions';
 import type { ComputePosition, ResolvedTemplateInfo, ResolveResult, ResolveErrorInfo } from './types';

src/ts-ast-util/utilily-functions.ts

@@ -1,4 +1,4 @@
-import ts from 'typescript';
+import ts from '../tsmodule';
 import { astf } from './ast-factory-alias';
 
 function mergeNamedBinding(base: ts.NamedImportBindings | undefined, head: ts.NamedImportBindings | undefined) {

src/tsmodule.d.ts

@@ -0,0 +1,3 @@
+// eslint-disable-next-line @typescript-eslint/no-restricted-imports
+import * as ts from 'typescript';
+export = ts;

src/tsmodule.js

@@ -0,0 +1,3 @@
+const { getModule } = require('./language-service-plugin/ts-server-module');
+
+module.exports = getModule() ?? require('typescript');