refactor(language-core): extract binding collectors

Author: KazariEX

packages/language-core/index.ts

@@ -1,10 +1,10 @@
 export * from './lib/codegen/globalTypes';
 export * from './lib/codegen/template';
-export * from './lib/codegen/utils';
 export * from './lib/languagePlugin';
 export * from './lib/parsers/scriptSetupRanges';
 export * from './lib/plugins';
 export * from './lib/types';
+export * from './lib/utils/collectBindings';
 export * from './lib/utils/parseSfc';
 export * from './lib/utils/shared';
 export * from './lib/utils/ts';

packages/language-core/lib/codegen/template/interpolation.ts

@@ -1,9 +1,10 @@
 import { isGloballyAllowed, makeMap } from '@vue/shared';
 import type * as ts from 'typescript';
 import type { Code, VueCodeInformation } from '../../types';
+import { collectBindingNames } from '../../utils/collectBindings';
 import { getNodeText, getStartEnd } from '../../utils/shared';
 import type { ScriptCodegenOptions } from '../script';
-import { collectBindingNames, createTsAst, identifierRegex } from '../utils';
+import { createTsAst, identifierRegex } from '../utils';
 import type { TemplateCodegenContext } from './context';
 import type { TemplateCodegenOptions } from './index';
 

packages/language-core/lib/codegen/template/vFor.ts

@@ -1,6 +1,7 @@
 import * as CompilerDOM from '@vue/compiler-dom';
 import type { Code } from '../../types';
-import { collectBindingNames, createTsAst, endOfLine, newLine } from '../utils';
+import { collectBindingNames } from '../../utils/collectBindings';
+import { createTsAst, endOfLine, newLine } from '../utils';
 import type { TemplateCodegenContext } from './context';
 import { generateElementChildren } from './elementChildren';
 import type { TemplateCodegenOptions } from './index';

packages/language-core/lib/codegen/template/vSlot.ts

@@ -1,8 +1,9 @@
 import * as CompilerDOM from '@vue/compiler-dom';
 import type * as ts from 'typescript';
 import type { Code } from '../../types';
+import { collectBindingNames } from '../../utils/collectBindings';
 import { getStartEnd } from '../../utils/shared';
-import { collectBindingNames, createTsAst, endOfLine, newLine } from '../utils';
+import { createTsAst, endOfLine, newLine } from '../utils';
 import { wrapWith } from '../utils/wrapWith';
 import type { TemplateCodegenContext } from './context';
 import { generateElementChildren } from './elementChildren';

packages/language-core/lib/codegen/utils/index.ts

@@ -1,53 +1,12 @@
 import type * as CompilerDOM from '@vue/compiler-dom';
 import type * as ts from 'typescript';
 import type { Code, SfcBlock, VueCodeInformation } from '../../types';
-import { getNodeText } from '../../utils/shared';
 
 export const newLine = `\n`;
 export const endOfLine = `;${newLine}`;
 export const combineLastMapping: VueCodeInformation = { __combineOffset: 1 };
 export const identifierRegex = /^[a-zA-Z_$][0-9a-zA-Z_$]*$/;
 
-export function collectBindingNames(
-	ts: typeof import('typescript'),
-	node: ts.Node,
-	ast: ts.SourceFile,
-) {
-	return collectIdentifiers(ts, node).map(({ id }) => getNodeText(ts, id, ast));
-}
-
-export function collectIdentifiers(
-	ts: typeof import('typescript'),
-	node: ts.Node,
-	results: {
-		id: ts.Identifier;
-		isRest: boolean;
-		initializer: ts.Expression | undefined;
-	}[] = [],
-	isRest = false,
-	initializer: ts.Expression | undefined = undefined,
-) {
-	if (ts.isIdentifier(node)) {
-		results.push({ id: node, isRest, initializer });
-	}
-	else if (ts.isObjectBindingPattern(node)) {
-		for (const el of node.elements) {
-			collectIdentifiers(ts, el.name, results, !!el.dotDotDotToken, el.initializer);
-		}
-	}
-	else if (ts.isArrayBindingPattern(node)) {
-		for (const el of node.elements) {
-			if (ts.isBindingElement(el)) {
-				collectIdentifiers(ts, el.name, results, !!el.dotDotDotToken);
-			}
-		}
-	}
-	else {
-		ts.forEachChild(node, node => collectIdentifiers(ts, node, results, false));
-	}
-	return results;
-}
-
 export function normalizeAttributeValue(node: CompilerDOM.TextNode): [string, number] {
 	let offset = node.loc.start.offset;
 	let content = node.loc.source;

packages/language-core/lib/parsers/scriptSetupRanges.ts

@@ -1,6 +1,6 @@
 import type * as ts from 'typescript';
-import { collectIdentifiers } from '../codegen/utils';
 import type { TextRange, VueCompilerOptions } from '../types';
+import { collectBindingIdentifiers, collectBindingRanges } from '../utils/collectBindings';
 import { getNodeText, getStartEnd } from '../utils/shared';
 
 const tsCheckReg = /^\/\/\s*@ts-(?:no)?check($|\s)/;
@@ -236,7 +236,7 @@ export function parseScriptSetupRanges(
 				};
 				if (ts.isVariableDeclaration(parent) && ts.isObjectBindingPattern(parent.name)) {
 					defineProps.destructured = new Map();
-					const identifiers = collectIdentifiers(ts, parent.name);
+					const identifiers = collectBindingIdentifiers(ts, parent.name);
 					for (const { id, isRest, initializer } of identifiers) {
 						const name = _getNodeText(id);
 						if (isRest) {
@@ -374,8 +374,8 @@ export function parseBindingRanges(ts: typeof import('typescript'), ast: ts.Sour
 	ts.forEachChild(ast, node => {
 		if (ts.isVariableStatement(node)) {
 			for (const decl of node.declarationList.declarations) {
-				const vars = _findBindingVars(decl.name);
-				bindings.push(...vars.map(range => ({ range })));
+				const ranges = collectBindingRanges(ts, decl.name, ast);
+				bindings.push(...ranges.map(range => ({ range })));
 			}
 		}
 		else if (ts.isFunctionDeclaration(node)) {
@@ -445,47 +445,6 @@ export function parseBindingRanges(ts: typeof import('typescript'), ast: ts.Sour
 	function _getNodeText(node: ts.Node) {
 		return getNodeText(ts, node, ast);
 	}
-
-	function _findBindingVars(left: ts.BindingName) {
-		return findBindingVars(ts, left, ast);
-	}
-}
-
-export function findBindingVars(
-	ts: typeof import('typescript'),
-	left: ts.BindingName,
-	ast: ts.SourceFile,
-) {
-	const vars: TextRange[] = [];
-	worker(left);
-	return vars;
-	function worker(node: ts.Node) {
-		if (ts.isIdentifier(node)) {
-			vars.push(getStartEnd(ts, node, ast));
-		}
-		// { ? } = ...
-		// [ ? ] = ...
-		else if (ts.isObjectBindingPattern(node) || ts.isArrayBindingPattern(node)) {
-			for (const property of node.elements) {
-				if (ts.isBindingElement(property)) {
-					worker(property.name);
-				}
-			}
-		}
-		// { foo: ? } = ...
-		else if (ts.isPropertyAssignment(node)) {
-			worker(node.initializer);
-		}
-		// { foo } = ...
-		else if (ts.isShorthandPropertyAssignment(node)) {
-			vars.push(getStartEnd(ts, node.name, ast));
-		}
-		// { ...? } = ...
-		// [ ...? ] = ...
-		else if (ts.isSpreadAssignment(node) || ts.isSpreadElement(node)) {
-			worker(node.expression);
-		}
-	}
 }
 
 function getStatementRange(

packages/language-core/lib/utils/collectBindings.ts

@@ -0,0 +1,45 @@
+import type * as ts from 'typescript';
+import { getNodeText, getStartEnd } from './shared';
+
+export function collectBindingNames(
+	ts: typeof import('typescript'),
+	node: ts.Node,
+	ast: ts.SourceFile,
+) {
+	return collectBindingIdentifiers(ts, node).map(({ id }) => getNodeText(ts, id, ast));
+}
+
+export function collectBindingRanges(
+	ts: typeof import('typescript'),
+	node: ts.Node,
+	ast: ts.SourceFile,
+) {
+	return collectBindingIdentifiers(ts, node).map(({ id }) => getStartEnd(ts, id, ast));
+}
+
+export function collectBindingIdentifiers(
+	ts: typeof import('typescript'),
+	node: ts.Node,
+	results: {
+		id: ts.Identifier;
+		isRest: boolean;
+		initializer: ts.Expression | undefined;
+	}[] = [],
+	isRest = false,
+	initializer: ts.Expression | undefined = undefined,
+) {
+	if (ts.isIdentifier(node)) {
+		results.push({ id: node, isRest, initializer });
+	}
+	else if (ts.isArrayBindingPattern(node) || ts.isObjectBindingPattern(node)) {
+		for (const el of node.elements) {
+			if (ts.isBindingElement(el)) {
+				collectBindingIdentifiers(ts, el.name, results, !!el.dotDotDotToken, el.initializer);
+			}
+		}
+	}
+	else {
+		ts.forEachChild(node, node => collectBindingIdentifiers(ts, node, results, false));
+	}
+	return results;
+}

packages/language-server/lib/reactivityAnalyze.ts

@@ -1,4 +1,4 @@
-import { findBindingVars, hyphenateAttr, type TextRange } from '@vue/language-core';
+import { collectBindingRanges, hyphenateAttr, type TextRange } from '@vue/language-core';
 import type * as ts from 'typescript';
 
 const enum TrackKind {
@@ -164,8 +164,8 @@ export function analyze(
 	}
 
 	function findSubscribers(refName: ts.BindingName, trackKinds: TrackKind[], visited = new Set<number>()) {
-		return findBindingVars(ts, refName, sourceFile)
-			.map(binding => findSubscribersWorker(binding, trackKinds, visited))
+		return collectBindingRanges(ts, refName, sourceFile)
+			.map(range => findSubscribersWorker(range, trackKinds, visited))
 			.flat();
 	}
 

packages/language-service/lib/plugins/vue-inlayhints.ts

@@ -1,5 +1,5 @@
 import type { InlayHint, InlayHintKind, LanguageServicePlugin } from '@volar/language-service';
-import { collectIdentifiers, tsCodegen, VueVirtualCode } from '@vue/language-core';
+import { collectBindingIdentifiers, tsCodegen, VueVirtualCode } from '@vue/language-core';
 import type * as ts from 'typescript';
 import { URI } from 'vscode-uri';
 
@@ -198,7 +198,7 @@ export function findDestructuredProps(
 			&& ts.isCallExpression(initializer)
 			&& initializer.expression.getText(ast) === 'defineProps';
 
-		for (const { id } of collectIdentifiers(ts, name)) {
+		for (const { id } of collectBindingIdentifiers(ts, name)) {
 			if (isDefineProps) {
 				excludedIds.add(id);
 			}
@@ -215,7 +215,7 @@ export function findDestructuredProps(
 		}
 
 		for (const p of parameters) {
-			for (const { id } of collectIdentifiers(ts, p)) {
+			for (const { id } of collectBindingIdentifiers(ts, p)) {
 				registerLocalBinding(id);
 			}
 		}