feat: support auto-complete for template local variables

close #1284
vuejs · May 15, 2022 · 7d8c939 · 7d8c939
1 parent ef261c4
commit 7d8c939
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 7 deletions.
diff --git a/packages/vue-code-gen/src/generators/template.ts b/packages/vue-code-gen/src/generators/template.ts
@@ -497,6 +497,13 @@ export function generate(
 			}
 			tsCodeGen.addText(`) {\n`);
 
+			// fix https://github.com/johnsoncodehk/volar/issues/1284
+			tsCodeGen.addText(`declare const __VLS_ctx: typeof __VLS_ctxBase & {\n`);
+			for (const localVar in localVars) {
+				tsCodeGen.addText(`${localVar}: typeof ${localVar},\n`);
+			}
+			tsCodeGen.addText(`};\n`);
+
 			for (const childNode of node.children) {
 				visitNode(childNode, parentEl);
 			}
@@ -595,6 +602,14 @@ export function generate(
 
 				for (const varName of slotBlockVars)
 					localVars[varName] = (localVars[varName] ?? 0) + 1;
+
+				if (slotBlockVars.length) {
+					tsCodeGen.addText(`declare const __VLS_ctx: typeof __VLS_ctxBase & {\n`);
+					for (const localVar of slotBlockVars) {
+						tsCodeGen.addText(`${localVar}: typeof ${localVar},\n`);
+					}
+					tsCodeGen.addText(`};\n`);
+				}
 			}
 			writeDirectives(node);
 			writeElReferences(node); // <el ref="foo" />

diff --git a/packages/vue-typescript/src/use/useSfcTemplateScript.ts b/packages/vue-typescript/src/use/useSfcTemplateScript.ts
@@ -98,7 +98,7 @@ export function useSfcTemplateScript(
 
 		writeImportTypes();
 
-		codeGen.addText(`declare var __VLS_ctx: InstanceType<typeof __VLS_component> & {\n`);
+		codeGen.addText(`declare const __VLS_ctxBase: InstanceType<typeof __VLS_component> & {\n`);
 		/* CSS Module */
 		const cssModuleMappingsArr: ReturnType<typeof writeCssClassProperties>[] = [];
 		for (const moduleName in cssModuleClasses.value) {
@@ -108,15 +108,16 @@ export function useSfcTemplateScript(
 			codeGen.addText('};\n');
 		}
 		codeGen.addText(`};\n`);
+		codeGen.addText(`declare const __VLS_ctx: typeof __VLS_ctxBase;\n`);
 
-		codeGen.addText(`declare var __VLS_vmUnwrap: typeof __VLS_options & { components: { } };\n`);
+		codeGen.addText(`declare const __VLS_vmUnwrap: typeof __VLS_options & { components: { } };\n`);
 
 		/* Components */
 		codeGen.addText('/* Components */\n');
-		codeGen.addText('declare var __VLS_otherComponents: NonNullable<typeof __VLS_component extends { components: infer C } ? C : {}> & __VLS_types.GlobalComponents & typeof __VLS_vmUnwrap.components & __VLS_types.PickComponents<typeof __VLS_ctx>;\n');
-		codeGen.addText('declare var __VLS_ownComponent: __VLS_types.SelfComponent<typeof __VLS_name, typeof __VLS_component>;\n');
-		codeGen.addText('declare var __VLS_allComponents: typeof __VLS_otherComponents & Omit<typeof __VLS_ownComponent, keyof typeof __VLS_otherComponents>;\n');
-		codeGen.addText('declare var __VLS_rawComponents: __VLS_types.ConvertInvalidComponents<typeof __VLS_allComponents> & JSX.IntrinsicElements;\n'); // sort by priority
+		codeGen.addText('declare const __VLS_otherComponents: NonNullable<typeof __VLS_component extends { components: infer C } ? C : {}> & __VLS_types.GlobalComponents & typeof __VLS_vmUnwrap.components & __VLS_types.PickComponents<typeof __VLS_ctx>;\n');
+		codeGen.addText('declare const __VLS_ownComponent: __VLS_types.SelfComponent<typeof __VLS_name, typeof __VLS_component>;\n');
+		codeGen.addText('declare const __VLS_allComponents: typeof __VLS_otherComponents & Omit<typeof __VLS_ownComponent, keyof typeof __VLS_otherComponents>;\n');
+		codeGen.addText('declare const __VLS_rawComponents: __VLS_types.ConvertInvalidComponents<typeof __VLS_allComponents> & JSX.IntrinsicElements;\n'); // sort by priority
 
 		codeGen.addText(`__VLS_allComponents.${SearchTexts.Components};\n`);
 		codeGen.addText(`({} as __VLS_types.GlobalAttrs).${SearchTexts.GlobalAttrs};\n`);
@@ -126,7 +127,7 @@ export function useSfcTemplateScript(
 		codeGen.addText('type __VLS_StyleScopedClasses = {\n');
 		const cssScopedMappings = writeCssClassProperties(cssScopedClasses.value, true, 'boolean', true);
 		codeGen.addText('};\n');
-		codeGen.addText('declare var __VLS_styleScopedClasses: __VLS_StyleScopedClasses | keyof __VLS_StyleScopedClasses | (keyof __VLS_StyleScopedClasses)[];\n');
+		codeGen.addText('declare const __VLS_styleScopedClasses: __VLS_StyleScopedClasses | keyof __VLS_StyleScopedClasses | (keyof __VLS_StyleScopedClasses)[];\n');
 
 		codeGen.addText(`/* CSS variable injection */\n`);
 		writeCssVars();