feat(language-core): add fallthroughAttributes compiler option

vuejs · Aug 27, 2024 · ebb8490 · ebb8490
1 parent d94bd3c
commit ebb8490
Show file tree

Hide file tree

Showing 30 changed files with 36 additions and 28 deletions.
diff --git a/packages/language-core/lib/codegen/template/element.ts b/packages/language-core/lib/codegen/template/element.ts
@@ -288,8 +288,11 @@ export function* generateComponent(
 	}
 
 	if (
-		node.props.some(prop => prop.type === CompilerDOM.NodeTypes.DIRECTIVE && prop.name === 'bind' && prop.exp?.loc.source === '$attrs')
-		|| node === ctx.singleRootNode
+		options.vueCompilerOptions.fallthroughAttributes
+		&& (
+			node.props.some(prop => prop.type === CompilerDOM.NodeTypes.DIRECTIVE && prop.name === 'bind' && prop.exp?.loc.source === '$attrs')
+			|| node === ctx.singleRootNode
+		)
 	) {
 		const varAttrs = ctx.getInternalVariable();
 		ctx.inheritedAttrVars.add(varAttrs);
@@ -386,8 +389,11 @@ export function* generateElement(
 	}
 
 	if (
-		node.props.some(prop => prop.type === CompilerDOM.NodeTypes.DIRECTIVE && prop.name === 'bind' && prop.exp?.loc.source === '$attrs')
-		|| node === ctx.singleRootNode
+		options.vueCompilerOptions.fallthroughAttributes
+		&& (
+			node.props.some(prop => prop.type === CompilerDOM.NodeTypes.DIRECTIVE && prop.name === 'bind' && prop.exp?.loc.source === '$attrs')
+			|| node === ctx.singleRootNode
+		)
 	) {
 		ctx.inheritedAttrVars.add(`__VLS_intrinsicElements.${node.tag}`);
 	}

diff --git a/packages/language-core/lib/types.ts b/packages/language-core/lib/types.ts
@@ -30,6 +30,7 @@ export interface VueCompilerOptions {
 	jsxSlots: boolean;
 	strictTemplates: boolean;
 	skipTemplateCodegen: boolean;
+	fallthroughAttributes: boolean;
 	dataAttributes: string[];
 	htmlAttributes: string[];
 	optionsWrapper: [string, string] | [];

diff --git a/packages/language-core/lib/utils/ts.ts b/packages/language-core/lib/utils/ts.ts
@@ -216,6 +216,7 @@ export function resolveVueCompilerOptions(vueOptions: Partial<VueCompilerOptions
 		jsxSlots: vueOptions.jsxSlots ?? false,
 		strictTemplates: vueOptions.strictTemplates ?? false,
 		skipTemplateCodegen: vueOptions.skipTemplateCodegen ?? false,
+		fallthroughAttributes: vueOptions.fallthroughAttributes ?? false,
 		dataAttributes: vueOptions.dataAttributes ?? [],
 		htmlAttributes: vueOptions.htmlAttributes ?? ['aria-*'],
 		optionsWrapper: vueOptions.optionsWrapper ?? (

diff --git a/packages/language-core/schemas/vue-tsconfig.schema.json b/packages/language-core/schemas/vue-tsconfig.schema.json
@@ -47,8 +47,14 @@
 				},
 				"skipTemplateCodegen": {
 					"type": "boolean",
+					"default": false,
 					"markdownDescription": "https://github.com/vuejs/language-tools/issues/577"
 				},
+				"fallthroughAttributes": {
+					"type": "boolean",
+					"default": false,
+					"markdownDescription": "Enable to support typed fallthrough attributes. Please note that enabling may significantly slow down type checking."
+				},
 				"dataAttributes": {
 					"type": "array",
 					"default": [ ],

diff --git a/packages/tsc/tests/__snapshots__/dts.spec.ts.snap b/packages/tsc/tests/__snapshots__/dts.spec.ts.snap
@@ -170,30 +170,8 @@ type __VLS_Prettify<T> = {
 `;
 
 exports[`vue-tsc-dts > Input: generic/main.vue, Output: generic/main.vue.d.ts 1`] = `
-"declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<__VLS_OmitIndexSignature<Partial<{
-    "onUpdate:title"?: (title: string) => any;
-    onBar?: (data: number) => any;
-    title?: string;
-    foo: number;
-} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps>>>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<__VLS_OmitIndexSignature<Partial<{
-    "onUpdate:title"?: (title: string) => any;
-    onBar?: (data: number) => any;
-    title?: string;
-    foo: number;
-} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps>>>>>, {}, {}>;
+"declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
 export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToOption<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: import('vue').PropType<T[K]>;
-        required: true;
-    };
-};
-type __VLS_OmitIndexSignature<T> = {
-    [K in keyof T as {} extends Record<K, unknown> ? never : K]: T[K];
-};
 "
 `;
 

diff --git a/test-workspace/tsc/passedFixtures/fallthroughAttributes/tsconfig.json b/test-workspace/tsc/passedFixtures/fallthroughAttributes/tsconfig.json
@@ -0,0 +1,7 @@
+{
+	"extends": "../../../tsconfig.base.json",
+	"vueCompilerOptions": {
+		"fallthroughAttributes": true,
+	},
+	"include": [ "**/*" ],
+}
diff --git a/...es/vue3/inheritAttrs_unknownTag/basic.vue → ...allthroughAttributes/unknownTag/basic.vue b/...es/vue3/inheritAttrs_unknownTag/basic.vue → ...allthroughAttributes/unknownTag/basic.vue
diff --git a/...res/vue3/inheritAttrs_unknownTag/main.vue → ...fallthroughAttributes/unknownTag/main.vue b/...res/vue3/inheritAttrs_unknownTag/main.vue → ...fallthroughAttributes/unknownTag/main.vue
diff --git a/.../vue3_strictTemplate/#4699/HelloWorld.vue → ...butes_strictTemplate/#4699/HelloWorld.vue b/.../vue3_strictTemplate/#4699/HelloWorld.vue → ...butes_strictTemplate/#4699/HelloWorld.vue
diff --git a/...xtures/vue3_strictTemplate/#4699/main.vue → ...hAttributes_strictTemplate/#4699/main.vue b/...xtures/vue3_strictTemplate/#4699/main.vue → ...hAttributes_strictTemplate/#4699/main.vue
diff --git a/...ue3_strictTemplate/inheritAttrs/basic.vue → ...hAttributes_strictTemplate/base/basic.vue b/...ue3_strictTemplate/inheritAttrs/basic.vue → ...hAttributes_strictTemplate/base/basic.vue
diff --git a/...ue3_strictTemplate/inheritAttrs/child.vue → ...hAttributes_strictTemplate/base/child.vue b/...ue3_strictTemplate/inheritAttrs/child.vue → ...hAttributes_strictTemplate/base/child.vue
diff --git a/...rs/define-options-inherit-attrs-false.vue → ...se/define-options-inherit-attrs-false.vue b/...rs/define-options-inherit-attrs-false.vue → ...se/define-options-inherit-attrs-false.vue
diff --git a/...heritAttrs/inherit-attrs-false-v-bind.vue → ...plate/base/inherit-attrs-false-v-bind.vue b/...heritAttrs/inherit-attrs-false-v-bind.vue → ...plate/base/inherit-attrs-false-v-bind.vue
diff --git a/...late/inheritAttrs/inherit-attrs-false.vue → ...rictTemplate/base/inherit-attrs-false.vue b/...late/inheritAttrs/inherit-attrs-false.vue → ...rictTemplate/base/inherit-attrs-false.vue
diff --git a/...vue3_strictTemplate/inheritAttrs/main.vue → ...ghAttributes_strictTemplate/base/main.vue b/...vue3_strictTemplate/inheritAttrs/main.vue → ...ghAttributes_strictTemplate/base/main.vue
diff --git a/...inheritAttrs_duplicateNameEvent/basic.vue → ...rictTemplate/duplicateNameEvent/basic.vue b/...inheritAttrs_duplicateNameEvent/basic.vue → ...rictTemplate/duplicateNameEvent/basic.vue
diff --git a/...inheritAttrs_duplicateNameEvent/child.vue → ...rictTemplate/duplicateNameEvent/child.vue b/...inheritAttrs_duplicateNameEvent/child.vue → ...rictTemplate/duplicateNameEvent/child.vue
diff --git a/.../inheritAttrs_duplicateNameEvent/main.vue → ...trictTemplate/duplicateNameEvent/main.vue b/.../inheritAttrs_duplicateNameEvent/main.vue → ...trictTemplate/duplicateNameEvent/main.vue
diff --git a/.../inheritAttrs_duplicateNameProp/basic.vue → ...trictTemplate/duplicateNameProp/basic.vue b/.../inheritAttrs_duplicateNameProp/basic.vue → ...trictTemplate/duplicateNameProp/basic.vue
diff --git a/.../inheritAttrs_duplicateNameProp/child.vue → ...trictTemplate/duplicateNameProp/child.vue b/.../inheritAttrs_duplicateNameProp/child.vue → ...trictTemplate/duplicateNameProp/child.vue
diff --git a/...e/inheritAttrs_duplicateNameProp/main.vue → ...strictTemplate/duplicateNameProp/main.vue b/...e/inheritAttrs_duplicateNameProp/main.vue → ...strictTemplate/duplicateNameProp/main.vue
diff --git a/...plate/inheritAttrs_requiredProp/basic.vue → ...tes_strictTemplate/requiredProp/basic.vue b/...plate/inheritAttrs_requiredProp/basic.vue → ...tes_strictTemplate/requiredProp/basic.vue
diff --git a/...plate/inheritAttrs_requiredProp/child.vue → ...tes_strictTemplate/requiredProp/child.vue b/...plate/inheritAttrs_requiredProp/child.vue → ...tes_strictTemplate/requiredProp/child.vue
diff --git a/...mplate/inheritAttrs_requiredProp/main.vue → ...utes_strictTemplate/requiredProp/main.vue b/...mplate/inheritAttrs_requiredProp/main.vue → ...utes_strictTemplate/requiredProp/main.vue
diff --git a/test-workspace/tsc/passedFixtures/fallthroughAttributes_strictTemplate/tsconfig.json b/test-workspace/tsc/passedFixtures/fallthroughAttributes_strictTemplate/tsconfig.json
@@ -0,0 +1,8 @@
+{
+	"extends": "../../../tsconfig.base.json",
+	"vueCompilerOptions": {
+		"fallthroughAttributes": true,
+		"strictTemplates": true,
+	},
+	"include": [ "**/*" ],
+}
diff --git a/...emplate/inheritAttrs_unknownTag/basic.vue → ...butes_strictTemplate/unknownTag/basic.vue b/...emplate/inheritAttrs_unknownTag/basic.vue → ...butes_strictTemplate/unknownTag/basic.vue
diff --git a/...Template/inheritAttrs_unknownTag/main.vue → ...ibutes_strictTemplate/unknownTag/main.vue b/...Template/inheritAttrs_unknownTag/main.vue → ...ibutes_strictTemplate/unknownTag/main.vue
diff --git a/test-workspace/tsc/passedFixtures/vue2_strictTemplate/tsconfig.json b/test-workspace/tsc/passedFixtures/vue2_strictTemplate/tsconfig.json
@@ -12,6 +12,5 @@
 		"../vue3_strictTemplate/#3140",
 		"../vue3_strictTemplate/#3718",
 		"../vue3_strictTemplate/intrinsicProps",
-		"../vue3_strictTemplate/inheritAttrs",
 	]
 }
diff --git a/test-workspace/tsc/tsconfig.json b/test-workspace/tsc/tsconfig.json
@@ -14,6 +14,8 @@
 		{ "path": "./passedFixtures/#3819" },
 		{ "path": "./passedFixtures/#4503" },
 		{ "path": "./passedFixtures/core#9923" },
+		{ "path": "./passedFixtures/fallthroughAttributes" },
+		{ "path": "./passedFixtures/fallthroughAttributes_strictTemplate" },
 		{ "path": "./passedFixtures/noPropertyAccessFromIndexSignature" },
 		// { "path": "./passedFixtures/petite-vue" },
 		{ "path": "./passedFixtures/pug" },