refactor(language-service): simplify tsPluginClient type and its propagation across functions

KazariEX · KazariEX · commit 38c61beb72d9 · 2025-07-24T23:51:39.000+08:00
diff --git a/packages/language-service/index.ts b/packages/language-service/index.ts
@@ -4,8 +4,6 @@ export * from '@volar/language-service';
 // for @vue/language-server usage
 export * from '@volar/language-service/lib/utils/featureWorkers';
 
-import type * as ts from 'typescript';
-
 import { create as createEmmetPlugin } from 'volar-service-emmet';
 import { create as createJsonPlugin } from 'volar-service-json';
 import { create as createPugFormatPlugin } from 'volar-service-pug-beautify';
@@ -33,46 +31,39 @@ import { create as createVueTwoslashQueriesPlugin } from './lib/plugins/vue-twos
 
 export function createVueLanguageServicePlugins(
 	ts: typeof import('typescript'),
-	tsPluginClient:
-		| import('@vue/typescript-plugin/lib/requests').Requests & {
-			getDocumentHighlights: (fileName: string, position: number) => Promise<ts.DocumentHighlights[] | null>;
-		}
-		| undefined,
+	tsPluginClient: import('@vue/typescript-plugin/lib/requests').Requests | undefined,
 ) {
-	const getTsPluginClient = () => tsPluginClient;
 	const plugins = [
 		createCssPlugin(),
 		createJsonPlugin(),
 		createPugFormatPlugin(),
 		createTypeScriptDocCommentTemplatePlugin(ts),
-		createTypescriptSemanticTokensPlugin(getTsPluginClient),
+		createTypescriptSemanticTokensPlugin(tsPluginClient),
 		createTypeScriptSyntacticPlugin(ts),
 		createVueAutoSpacePlugin(),
-		createVueAutoDotValuePlugin(ts, getTsPluginClient),
+		createVueAutoDotValuePlugin(ts, tsPluginClient),
 		createVueCompilerDomErrorsPlugin(),
-		createVueComponentSemanticTokensPlugin(getTsPluginClient),
-		createVueDocumentDropPlugin(ts, getTsPluginClient),
+		createVueComponentSemanticTokensPlugin(tsPluginClient),
+		createVueDocumentDropPlugin(ts, tsPluginClient),
+		createVueDocumentHighlightsPlugin(tsPluginClient),
 		createVueDirectiveCommentsPlugin(),
-		createVueExtractFilePlugin(ts, getTsPluginClient),
+		createVueExtractFilePlugin(ts, tsPluginClient),
 		createVueGlobalTypesErrorPlugin(),
 		createVueInlayHintsPlugin(ts),
-		createVueMissingPropsHintsPlugin(getTsPluginClient),
+		createVueMissingPropsHintsPlugin(tsPluginClient),
 		createVueScopedClassLinksPlugin(),
 		createVueSfcPlugin(),
 		createVueSuggestDefineAssignmentPlugin(),
-		createVueTemplatePlugin('html', getTsPluginClient),
-		createVueTemplatePlugin('pug', getTsPluginClient),
+		createVueTemplatePlugin('html', tsPluginClient),
+		createVueTemplatePlugin('pug', tsPluginClient),
 		createVueTemplateRefLinksPlugin(),
-		createVueTwoslashQueriesPlugin(getTsPluginClient),
+		createVueTwoslashQueriesPlugin(tsPluginClient),
 		createEmmetPlugin({
 			mappedLanguages: {
 				'vue-root-tags': 'html',
 				'postcss': 'scss',
 			},
 		}),
 	];
-	if (tsPluginClient) {
-		plugins.push(createVueDocumentHighlightsPlugin(tsPluginClient.getDocumentHighlights));
-	}
 	return plugins;
 }
diff --git a/packages/language-service/lib/plugins/typescript-semantic-tokens.ts b/packages/language-service/lib/plugins/typescript-semantic-tokens.ts
@@ -1,11 +1,9 @@
-import type { LanguageServiceContext, LanguageServicePlugin } from '@volar/language-service';
+import type { LanguageServicePlugin } from '@volar/language-service';
 import { convertClassificationsToSemanticTokens } from 'volar-service-typescript/lib/semanticFeatures/semanticTokens';
 import { getEmbeddedInfo } from './utils';
 
 export function create(
-	getTsPluginClient?: (
-		context: LanguageServiceContext,
-	) => import('@vue/typescript-plugin/lib/requests').Requests | undefined,
+	tsPluginClient: import('@vue/typescript-plugin/lib/requests').Requests | undefined,
 ): LanguageServicePlugin {
 	return {
 		name: 'typescript-semantic-tokens',
@@ -38,8 +36,6 @@ export function create(
 			},
 		},
 		create(context) {
-			const tsPluginClient = getTsPluginClient?.(context);
-
 			return {
 				async provideDocumentSemanticTokens(document, range, legend) {
 					const info = getEmbeddedInfo(context, document, 'main');
diff --git a/packages/language-service/lib/plugins/vue-autoinsert-dotvalue.ts b/packages/language-service/lib/plugins/vue-autoinsert-dotvalue.ts
@@ -1,13 +1,11 @@
-import type { LanguageServiceContext, LanguageServicePlugin, TextDocument } from '@volar/language-service';
+import type { LanguageServicePlugin, TextDocument } from '@volar/language-service';
 import { hyphenateAttr } from '@vue/language-core';
 import type * as ts from 'typescript';
 import { getEmbeddedInfo, sleep } from './utils';
 
 export function create(
 	ts: typeof import('typescript'),
-	getTsPluginClient?: (
-		context: LanguageServiceContext,
-	) => import('@vue/typescript-plugin/lib/requests').Requests | undefined,
+	tsPluginClient: import('@vue/typescript-plugin/lib/requests').Requests | undefined,
 ): LanguageServicePlugin {
 	return {
 		name: 'vue-autoinsert-dotvalue',
@@ -18,7 +16,6 @@ export function create(
 			},
 		},
 		create(context) {
-			const tsPluginClient = getTsPluginClient?.(context);
 			let currentReq = 0;
 
 			return {
diff --git a/packages/language-service/lib/plugins/vue-component-semantic-tokens.ts b/packages/language-service/lib/plugins/vue-component-semantic-tokens.ts
@@ -1,12 +1,10 @@
-import type { LanguageServiceContext, LanguageServicePlugin, SemanticToken } from '@volar/language-service';
+import type { LanguageServicePlugin, SemanticToken } from '@volar/language-service';
 import { forEachElementNode, hyphenateTag } from '@vue/language-core';
 import type * as ts from 'typescript';
 import { getEmbeddedInfo } from './utils';
 
 export function create(
-	getTsPluginClient?: (
-		context: LanguageServiceContext,
-	) => import('@vue/typescript-plugin/lib/requests').Requests | undefined,
+	tsPluginClient: import('@vue/typescript-plugin/lib/requests').Requests | undefined,
 ): LanguageServicePlugin {
 	return {
 		name: 'vue-component-semantic-tokens',
@@ -19,8 +17,6 @@ export function create(
 			},
 		},
 		create(context) {
-			const tsPluginClient = getTsPluginClient?.(context);
-
 			return {
 				async provideDocumentSemanticTokens(document, range, legend) {
 					const info = getEmbeddedInfo(context, document, 'template');
diff --git a/packages/language-service/lib/plugins/vue-document-drop.ts b/packages/language-service/lib/plugins/vue-document-drop.ts
@@ -1,9 +1,4 @@
-import type {
-	InsertTextFormat,
-	LanguageServiceContext,
-	LanguageServicePlugin,
-	WorkspaceEdit,
-} from '@volar/language-service';
+import type { InsertTextFormat, LanguageServicePlugin, WorkspaceEdit } from '@volar/language-service';
 import { forEachEmbeddedCode } from '@vue/language-core';
 import { camelize, capitalize, hyphenate } from '@vue/shared';
 import { posix as path } from 'path-browserify';
@@ -15,18 +10,14 @@ import { getEmbeddedInfo } from './utils';
 
 export function create(
 	ts: typeof import('typescript'),
-	getTsPluginClient?: (
-		context: LanguageServiceContext,
-	) => import('@vue/typescript-plugin/lib/requests').Requests | undefined,
+	tsPluginClient: import('@vue/typescript-plugin/lib/requests').Requests | undefined,
 ): LanguageServicePlugin {
 	return {
 		name: 'vue-document-drop',
 		capabilities: {
 			documentDropEditsProvider: true,
 		},
 		create(context) {
-			const tsPluginClient = getTsPluginClient?.(context);
-
 			return {
 				async provideDocumentDropEdits(document, _position, dataTransfer) {
 					const info = getEmbeddedInfo(context, document, 'template', 'html');
diff --git a/packages/language-service/lib/plugins/vue-document-highlights.ts b/packages/language-service/lib/plugins/vue-document-highlights.ts
@@ -1,9 +1,8 @@
 import type { DocumentHighlightKind, LanguageServicePlugin } from '@volar/language-service';
-import type * as ts from 'typescript';
 import { getEmbeddedInfo } from './utils';
 
 export function create(
-	getDocumentHighlights: (fileName: string, position: number) => Promise<ts.DocumentHighlights[] | null>,
+	tsPluginClient: import('@vue/typescript-plugin/lib/requests').Requests | undefined,
 ): LanguageServicePlugin {
 	return {
 		name: 'vue-document-highlights',
@@ -19,7 +18,7 @@ export function create(
 					}
 					const { root } = info;
 
-					const result = await getDocumentHighlights(root.fileName, document.offsetAt(position));
+					const result = await tsPluginClient?.getDocumentHighlights(root.fileName, document.offsetAt(position));
 
 					return result
 						?.filter(({ fileName }) => fileName === root.fileName)
diff --git a/packages/language-service/lib/plugins/vue-extract-file.ts b/packages/language-service/lib/plugins/vue-extract-file.ts
@@ -1,10 +1,4 @@
-import type {
-	CreateFile,
-	LanguageServiceContext,
-	LanguageServicePlugin,
-	TextDocumentEdit,
-	TextEdit,
-} from '@volar/language-service';
+import type { CreateFile, LanguageServicePlugin, TextDocumentEdit, TextEdit } from '@volar/language-service';
 import type { ExpressionNode, TemplateChildNode } from '@vue/compiler-dom';
 import { type Sfc, tsCodegen } from '@vue/language-core';
 import type * as ts from 'typescript';
@@ -21,9 +15,7 @@ const unicodeReg = /\\u/g;
 
 export function create(
 	ts: typeof import('typescript'),
-	getTsPluginClient?: (
-		context: LanguageServiceContext,
-	) => import('@vue/typescript-plugin/lib/requests').Requests | undefined,
+	tsPluginClient: import('@vue/typescript-plugin/lib/requests').Requests | undefined,
 ): LanguageServicePlugin {
 	return {
 		name: 'vue-extract-file',
@@ -34,7 +26,6 @@ export function create(
 			},
 		},
 		create(context) {
-			const tsPluginClient = getTsPluginClient?.(context);
 			return {
 				provideCodeActions(document, range, ctx) {
 					if (ctx.only && !ctx.only.includes('refactor')) {
@@ -99,9 +90,6 @@ export function create(
 					}
 
 					const toExtract = await tsPluginClient?.collectExtractProps(root.fileName, templateCodeRange) ?? [];
-					if (!toExtract) {
-						return codeAction;
-					}
 
 					const templateInitialIndent =
 						await context.env.getConfiguration!<boolean>('vue.format.template.initialIndent') ?? true;
diff --git a/packages/language-service/lib/plugins/vue-missing-props-hints.ts b/packages/language-service/lib/plugins/vue-missing-props-hints.ts
@@ -11,17 +11,14 @@ import { AttrNameCasing, checkCasing } from '../nameCasing';
 import { getEmbeddedInfo } from './utils';
 
 export function create(
-	getTsPluginClient?: (
-		context: LanguageServiceContext,
-	) => import('@vue/typescript-plugin/lib/requests').Requests | undefined,
+	tsPluginClient: import('@vue/typescript-plugin/lib/requests').Requests | undefined,
 ): LanguageServicePlugin {
 	return {
 		name: 'vue-missing-props-hints',
 		capabilities: {
 			inlayHintProvider: {},
 		},
 		create(context) {
-			const tsPluginClient = getTsPluginClient?.(context);
 			let intrinsicElementNames: Set<string>;
 
 			return {
diff --git a/packages/language-service/lib/plugins/vue-template.ts b/packages/language-service/lib/plugins/vue-template.ts
@@ -3,7 +3,6 @@ import type {
 	CompletionItemTag,
 	CompletionList,
 	Disposable,
-	LanguageServiceContext,
 	LanguageServicePlugin,
 	TextDocument,
 } from '@volar/language-service';
@@ -38,9 +37,7 @@ let modelData: html.HTMLDataV1;
 
 export function create(
 	mode: 'html' | 'pug',
-	getTsPluginClient?: (
-		context: LanguageServiceContext,
-	) => import('@vue/typescript-plugin/lib/requests').Requests | undefined,
+	tsPluginClient: import('@vue/typescript-plugin/lib/requests').Requests | undefined,
 ): LanguageServicePlugin {
 	let customData: html.IHTMLDataProvider[] = [];
 	let extraCustomData: html.IHTMLDataProvider[] = [];
@@ -92,7 +89,6 @@ export function create(
 			hoverProvider: true,
 		},
 		create(context) {
-			const tsPluginClient = getTsPluginClient?.(context);
 			const baseServiceInstance = baseService.create(context);
 
 			builtInData ??= loadTemplateData(context.env.locale ?? 'en');
diff --git a/packages/language-service/lib/plugins/vue-twoslash-queries.ts b/packages/language-service/lib/plugins/vue-twoslash-queries.ts
@@ -1,21 +1,18 @@
-import type { InlayHint, LanguageServiceContext, LanguageServicePlugin, Position } from '@volar/language-service';
+import type { InlayHint, LanguageServicePlugin, Position } from '@volar/language-service';
 import { getEmbeddedInfo } from './utils';
 
 const twoslashTemplateReg = /<!--\s*\^\?\s*-->/g;
 const twoslashScriptReg = /(?<=^|\n)\s*\/\/\s*\^\?/g;
 
 export function create(
-	getTsPluginClient?: (
-		context: LanguageServiceContext,
-	) => import('@vue/typescript-plugin/lib/requests').Requests | undefined,
+	tsPluginClient: import('@vue/typescript-plugin/lib/requests').Requests | undefined,
 ): LanguageServicePlugin {
 	return {
 		name: 'vue-twoslash-queries',
 		capabilities: {
 			inlayHintProvider: {},
 		},
 		create(context) {
-			const tsPluginClient = getTsPluginClient?.(context);
 			return {
 				async provideInlayHints(document, range) {
 					const info = getEmbeddedInfo(
diff --git a/packages/typescript-plugin/lib/requests/index.ts b/packages/typescript-plugin/lib/requests/index.ts
@@ -13,6 +13,7 @@ export type Requests = {
 	getComponentSlots: ToRequest<typeof import('./getComponentSlots.js')['getComponentSlots']>;
 	getElementAttrs: ToRequest<typeof import('./getElementAttrs.js')['getElementAttrs']>;
 	getElementNames: ToRequest<typeof import('./getElementNames.js')['getElementNames']>;
+	getDocumentHighlights: ToRequest<(fileName: string, position: number) => ts.DocumentHighlights[]>;
 	getEncodedSemanticClassifications: ToRequest<(fileName: string, span: ts.TextSpan) => ts.Classifications>;
 	getQuickInfoAtPosition: ToRequest<(fileName: string, position: ts.LineAndCharacter) => string>;
 };
