chore: update testing infrastructure (#5848)

Author: johnsoncodehk

.vscode/launch.json

@@ -10,7 +10,7 @@
 			"runtimeExecutable": "${execPath}",
 			"args": [
 				"--extensionDevelopmentPath=${workspaceRoot}/extensions/vscode",
-				"--folder-uri=${workspaceRoot}/test-workspace"
+				"--folder-uri=${workspaceRoot}/test-workspace/tsc"
 			],
 			"outFiles": [
 				"${workspaceRoot}/**/*.js"

.vscode/settings.json

@@ -1,4 +1,6 @@
 {
+	"vue.server.path": "packages/language-server",
+	"typescript.tsdk": "node_modules/typescript/lib",
 	"dprint.path": "node_modules/dprint/dprint",
 	"[javascript]": {
 		"editor.defaultFormatter": "dprint.dprint"
@@ -20,6 +22,5 @@
 		"packages/*/lib/**/*.d.ts": true,
 		"packages/*/lib/**/*.js": true,
 		"packages/*/lib/**/*.map": true
-	},
-	"typescript.tsdk": "node_modules/typescript/lib"
+	}
 }

packages/tsc/tests/__snapshots__/dts.spec.ts.snap

@@ -1,6 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`vue-tsc-dts > Input: component-name-description/component.vue, Output: component-name-description/component.vue.d.ts 1`] = `
+exports[`Input: component-name-description/component.vue, Output: component-name-description/component.vue.d.ts 1`] = `
 "/**
  * My awesome component description
  */
@@ -38,7 +38,7 @@ declare const __VLS_export: import("vue").DefineComponent2<{
 "
 `;
 
-exports[`vue-tsc-dts > Input: component-name-description/component-no-name.vue, Output: component-name-description/component-no-name.vue.d.ts 1`] = `
+exports[`Input: component-name-description/component-no-name.vue, Output: component-name-description/component-no-name.vue.d.ts 1`] = `
 "/**
  * Component without explicit name
  */
@@ -74,7 +74,7 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: component-name-description/component-ts.ts, Output: component-name-description/component-ts.d.ts 1`] = `
+exports[`Input: component-name-description/component-ts.ts, Output: component-name-description/component-ts.d.ts 1`] = `
 "/**
  * TypeScript component with description
  */
@@ -111,7 +111,7 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: empty-component/component.vue, Output: empty-component/component.vue.d.ts 1`] = `
+exports[`Input: empty-component/component.vue, Output: empty-component/component.vue.d.ts 1`] = `
 "declare const __VLS_export: import("vue").DefineComponent2<{
     setup(): {};
     data(): {};
@@ -138,7 +138,7 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: empty-component/custom-extension-component.cext, Output: empty-component/custom-extension-component.cext.d.ts 1`] = `
+exports[`Input: empty-component/custom-extension-component.cext, Output: empty-component/custom-extension-component.cext.d.ts 1`] = `
 "declare const __VLS_export: import("vue").DefineComponent2<{
     setup(): {};
     data(): {};
@@ -165,7 +165,7 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: generic/component.vue, Output: generic/component.vue.d.ts 1`] = `
+exports[`Input: generic/component.vue, Output: generic/component.vue.d.ts 1`] = `
 "declare const __VLS_export: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
     props: __VLS_PrettifyLocal<({
         foo: number;
@@ -200,7 +200,7 @@ type __VLS_PrettifyLocal<T> = (T extends any ? {
 "
 `;
 
-exports[`vue-tsc-dts > Input: generic/custom-extension-component.cext, Output: generic/custom-extension-component.cext.d.ts 1`] = `
+exports[`Input: generic/custom-extension-component.cext, Output: generic/custom-extension-component.cext.d.ts 1`] = `
 "declare const __VLS_export: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
     props: __VLS_PrettifyLocal<({
         foo: number;
@@ -235,7 +235,7 @@ type __VLS_PrettifyLocal<T> = (T extends any ? {
 "
 `;
 
-exports[`vue-tsc-dts > Input: generic/main.vue, Output: generic/main.vue.d.ts 1`] = `
+exports[`Input: generic/main.vue, Output: generic/main.vue.d.ts 1`] = `
 "declare const __VLS_export: import("vue").DefineComponent2<{
     setup(): {};
     data(): {};
@@ -262,13 +262,13 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: non-component/component.ts, Output: non-component/component.d.ts 1`] = `
+exports[`Input: non-component/component.ts, Output: non-component/component.d.ts 1`] = `
 "declare const _default: {};
 export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: options-api/component.ts, Output: options-api/component.d.ts 1`] = `
+exports[`Input: options-api/component.ts, Output: options-api/component.d.ts 1`] = `
 "interface SubmitPayload {
     /**
      * email of user
@@ -337,7 +337,7 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-events/component.vue, Output: reference-type-events/component.vue.d.ts 1`] = `
+exports[`Input: reference-type-events/component.vue, Output: reference-type-events/component.vue.d.ts 1`] = `
 "import type { MyEvents } from './my-events';
 declare const __VLS_export: import("vue").DefineComponent2<{
     setup(): {};
@@ -365,7 +365,7 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-events/my-events.ts, Output: reference-type-events/my-events.d.ts 1`] = `
+exports[`Input: reference-type-events/my-events.ts, Output: reference-type-events/my-events.d.ts 1`] = `
 "/**
  * Emitted when the foo property is changed.
  */
@@ -384,7 +384,7 @@ export {};
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-exposed/component.vue, Output: reference-type-exposed/component.vue.d.ts 1`] = `
+exports[`Input: reference-type-exposed/component.vue, Output: reference-type-exposed/component.vue.d.ts 1`] = `
 "declare const __VLS_export: import("vue").DefineComponent2<{
     setup(): {
         /**
@@ -416,7 +416,7 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-model/component.vue, Output: reference-type-model/component.vue.d.ts 1`] = `
+exports[`Input: reference-type-model/component.vue, Output: reference-type-model/component.vue.d.ts 1`] = `
 "type __VLS_ModelProps = {
     /**
      * required number modelValue
@@ -463,7 +463,7 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-props/component.vue, Output: reference-type-props/component.vue.d.ts 1`] = `
+exports[`Input: reference-type-props/component.vue, Output: reference-type-props/component.vue.d.ts 1`] = `
 "import { MyProps } from './my-props';
 declare const __VLS_export: import("vue").DefineComponent2<{
     setup(): {};
@@ -494,7 +494,7 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-props/component-destructure.vue, Output: reference-type-props/component-destructure.vue.d.ts 1`] = `
+exports[`Input: reference-type-props/component-destructure.vue, Output: reference-type-props/component-destructure.vue.d.ts 1`] = `
 "type __VLS_Props = {
     text: string;
 };
@@ -524,7 +524,7 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-props/component-js.vue, Output: reference-type-props/component-js.vue.d.ts 1`] = `
+exports[`Input: reference-type-props/component-js.vue, Output: reference-type-props/component-js.vue.d.ts 1`] = `
 "declare const _default: typeof __VLS_export;
 export default _default;
 declare const __VLS_export: import("vue").DefineComponent2<{
@@ -574,7 +574,7 @@ declare const __VLS_export: import("vue").DefineComponent2<{
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-props/component-js-setup.vue, Output: reference-type-props/component-js-setup.vue.d.ts 1`] = `
+exports[`Input: reference-type-props/component-js-setup.vue, Output: reference-type-props/component-js-setup.vue.d.ts 1`] = `
 "declare const __VLS_export: import("vue").DefineComponent2<{
     setup(): {};
     data(): {};
@@ -641,7 +641,7 @@ export default _default;
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-props/my-props.ts, Output: reference-type-props/my-props.d.ts 1`] = `
+exports[`Input: reference-type-props/my-props.ts, Output: reference-type-props/my-props.d.ts 1`] = `
 "export interface MyNestedProps {
     /**
      * nested prop documentation
@@ -752,7 +752,7 @@ export {};
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-slots/component.vue, Output: reference-type-slots/component.vue.d.ts 1`] = `
+exports[`Input: reference-type-slots/component.vue, Output: reference-type-slots/component.vue.d.ts 1`] = `
 "declare var __VLS_1: {}, __VLS_3: {
     num: number;
 }, __VLS_5: {
@@ -802,7 +802,7 @@ type __VLS_WithSlots<T, S> = T & {
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-slots/component-define-slots.vue, Output: reference-type-slots/component-define-slots.vue.d.ts 1`] = `
+exports[`Input: reference-type-slots/component-define-slots.vue, Output: reference-type-slots/component-define-slots.vue.d.ts 1`] = `
 "import type { VNode } from 'vue';
 type __VLS_Slots = {
     default: (props: {
@@ -849,7 +849,7 @@ type __VLS_WithSlots<T, S> = T & {
 "
 `;
 
-exports[`vue-tsc-dts > Input: reference-type-slots/component-no-script.vue, Output: reference-type-slots/component-no-script.vue.d.ts 1`] = `
+exports[`Input: reference-type-slots/component-no-script.vue, Output: reference-type-slots/component-no-script.vue.d.ts 1`] = `
 "declare var __VLS_1: {}, __VLS_3: {
     num: number;
 }, __VLS_5: {
@@ -899,7 +899,7 @@ type __VLS_WithSlots<T, S> = T & {
 "
 `;
 
-exports[`vue-tsc-dts > Input: ts-component/PropDefinitions.ts, Output: ts-component/PropDefinitions.d.ts 1`] = `
+exports[`Input: ts-component/PropDefinitions.ts, Output: ts-component/PropDefinitions.d.ts 1`] = `
 "export interface MyProps {
     /**
      * string foo
@@ -913,11 +913,11 @@ exports[`vue-tsc-dts > Input: ts-component/PropDefinitions.ts, Output: ts-compon
 "
 `;
 
-exports[`vue-tsc-dts > Input: ts-component/component.ts, Output: ts-component/component.d.ts 1`] = `undefined`;
+exports[`Input: ts-component/component.ts, Output: ts-component/component.d.ts 1`] = `undefined`;
 
-exports[`vue-tsc-dts > Input: ts-component/component.tsx, Output: ts-component/component.d.ts 1`] = `undefined`;
+exports[`Input: ts-component/component.tsx, Output: ts-component/component.d.ts 1`] = `undefined`;
 
-exports[`vue-tsc-dts > Input: ts-named-export/component.ts, Output: ts-named-export/component.d.ts 1`] = `
+exports[`Input: ts-named-export/component.ts, Output: ts-named-export/component.d.ts 1`] = `
 "export declare const Foo: import("vue").DefineSetupFnComponent<{
     foo: string;
 }, string[], {}, {

packages/tsc/tests/dts.spec.ts

@@ -3,73 +3,70 @@ import * as core from '@vue/language-core';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 import * as ts from 'typescript';
-import { describe, expect, it } from 'vitest';
+import { expect, test } from 'vitest';
 
 const workspace = path.resolve(__dirname, '../../../test-workspace/component-meta');
 const normalizePath = (filename: string) => filename.replace(/\\/g, '/');
 const normalizeNewline = (text: string) => text.replace(/\r\n/g, '\n');
 const windowsPathReg = /\\/g;
 
-describe('vue-tsc-dts', () => {
-	const compilerOptions: ts.CompilerOptions = {
-		rootDir: workspace,
-		declaration: true,
-		emitDeclarationOnly: true,
-		allowNonTsExtensions: true,
-	};
-	const host = ts.createCompilerHost(compilerOptions);
-	const options: ts.CreateProgramOptions = {
-		host,
-		rootNames: readFilesRecursive(workspace),
-		options: compilerOptions,
-	};
+const compilerOptions: ts.CompilerOptions = {
+	rootDir: workspace,
+	declaration: true,
+	emitDeclarationOnly: true,
+	allowNonTsExtensions: true,
+};
+const host = ts.createCompilerHost(compilerOptions);
+const options: ts.CreateProgramOptions = {
+	host,
+	rootNames: readFilesRecursive(workspace),
+	options: compilerOptions,
+};
 
-	let vueOptions: core.VueCompilerOptions;
+let vueOptions: core.VueCompilerOptions;
 
-	const createProgram = proxyCreateProgram(ts, ts.createProgram, (ts, options) => {
-		const { configFilePath } = options.options;
-		if (typeof configFilePath === 'string') {
-			vueOptions = core.createParsedCommandLine(ts, ts.sys, configFilePath.replace(windowsPathReg, '/')).vueOptions;
-		}
-		else {
-			vueOptions =
-				core.createParsedCommandLineByJson(ts, ts.sys, workspace.replace(windowsPathReg, '/'), {}).vueOptions;
-			vueOptions.target = 99;
-			vueOptions.extensions = ['vue', 'cext'];
-		}
-		vueOptions.globalTypesPath = core.createGlobalTypesWriter(vueOptions, ts.sys.writeFile);
-		const vueLanguagePlugin = core.createVueLanguagePlugin<string>(
-			ts,
-			options.options,
-			vueOptions,
-			id => id,
-		);
-		return [vueLanguagePlugin];
-	});
-	const program = createProgram(options);
-
-	for (const intputFile of options.rootNames) {
-		const expectedOutputFile = intputFile.endsWith('.ts')
-			? intputFile.slice(0, -'.ts'.length) + '.d.ts'
-			: intputFile.endsWith('.tsx')
-			? intputFile.slice(0, -'.tsx'.length) + '.d.ts'
-			: intputFile + '.d.ts';
-		it(`Input: ${shortenPath(intputFile)}, Output: ${shortenPath(expectedOutputFile)}`, () => {
-			let outputText: string | undefined;
-			const sourceFile = program.getSourceFile(intputFile);
-			program.emit(
-				sourceFile,
-				(outputFile, text) => {
-					expect(outputFile.replace(windowsPathReg, '/')).toBe(expectedOutputFile.replace(windowsPathReg, '/'));
-					outputText = text;
-				},
-				undefined,
-				true,
-			);
-			expect(outputText ? normalizeNewline(outputText) : undefined).toMatchSnapshot();
-		});
+const createProgram = proxyCreateProgram(ts, ts.createProgram, (ts, options) => {
+	const { configFilePath } = options.options;
+	if (typeof configFilePath === 'string') {
+		vueOptions = core.createParsedCommandLine(ts, ts.sys, configFilePath.replace(windowsPathReg, '/')).vueOptions;
 	}
+	else {
+		vueOptions = core.createParsedCommandLineByJson(ts, ts.sys, workspace.replace(windowsPathReg, '/'), {}).vueOptions;
+		vueOptions.target = 99;
+		vueOptions.extensions = ['vue', 'cext'];
+	}
+	vueOptions.globalTypesPath = core.createGlobalTypesWriter(vueOptions, ts.sys.writeFile);
+	const vueLanguagePlugin = core.createVueLanguagePlugin<string>(
+		ts,
+		options.options,
+		vueOptions,
+		id => id,
+	);
+	return [vueLanguagePlugin];
 });
+const program = createProgram(options);
+
+for (const intputFile of options.rootNames) {
+	const expectedOutputFile = intputFile.endsWith('.ts')
+		? intputFile.slice(0, -'.ts'.length) + '.d.ts'
+		: intputFile.endsWith('.tsx')
+		? intputFile.slice(0, -'.tsx'.length) + '.d.ts'
+		: intputFile + '.d.ts';
+	test(`Input: ${shortenPath(intputFile)}, Output: ${shortenPath(expectedOutputFile)}`, () => {
+		let outputText: string | undefined;
+		const sourceFile = program.getSourceFile(intputFile);
+		program.emit(
+			sourceFile,
+			(outputFile, text) => {
+				expect(outputFile.replace(windowsPathReg, '/')).toBe(expectedOutputFile.replace(windowsPathReg, '/'));
+				outputText = text;
+			},
+			undefined,
+			true,
+		);
+		expect(outputText ? normalizeNewline(outputText) : undefined).toMatchSnapshot();
+	});
+}
 
 function readFilesRecursive(dir: string) {
 	if (path.relative(workspace, dir).startsWith('#')) {