Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(language-core): intersect __VLS_slots with __VLS_ctx.$slots #5083

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/language-core/lib/codegen/globalTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@ export function generateGlobalTypes(lib: string, target: number, strictTemplates
'__ctx' extends keyof __VLS_PickNotAny<K, {}> ? K extends { __ctx?: infer Ctx } ? Ctx : never : any
, T extends (props: any, ctx: infer Ctx) => any ? Ctx : any
>>;
type __VLS_OmitStringIndex<T> = {
[K in keyof T as string extends K ? never : K]: T[K];
};
type __VLS_UseTemplateRef<T> = Readonly<import('${lib}').ShallowRef<T | null>>;

function __VLS_getVForSourceType(source: number): [number, number, number][];
Expand Down
6 changes: 3 additions & 3 deletions packages/language-core/lib/codegen/template/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,14 +106,14 @@ export function createTemplateCodegenContext(options: Pick<TemplateCodegenOption
const accessExternalVariables = new Map<string, Set<number>>();
const slots: {
name: string;
loc?: number;
offset?: number;
tagRange: [number, number];
varName: string;
nodeLoc: any;
propsVar: string;
}[] = [];
const dynamicSlots: {
expVar: string;
varName: string;
propsVar: string;
}[] = [];
const hasSlotElements = new Set<CompilerDOM.ElementNode>();;
const blockConditions: string[] = [];
Expand Down
15 changes: 8 additions & 7 deletions packages/language-core/lib/codegen/template/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,21 +54,23 @@ export function* generateTemplate(options: TemplateCodegenOptions): Generator<Co
}

function* generateSlots(options: TemplateCodegenOptions, ctx: TemplateCodegenContext): Generator<Code> {
const name = getSlotsPropertyName(options.vueCompilerOptions.target);

if (!options.hasDefineSlots) {
yield `var __VLS_slots!: `;
for (const { expVar, varName } of ctx.dynamicSlots) {
yield `var __VLS_slots!: __VLS_OmitStringIndex<typeof __VLS_ctx.${name}> & `;
for (const { expVar, propsVar } of ctx.dynamicSlots) {
ctx.hasSlot = true;
yield `Partial<Record<NonNullable<typeof ${expVar}>, (_: typeof ${varName}) => any>> &${newLine}`;
yield `Partial<Record<NonNullable<typeof ${expVar}>, (props: typeof ${propsVar}) => any>> &${newLine}`;
}
yield `{${newLine}`;
for (const slot of ctx.slots) {
ctx.hasSlot = true;
if (slot.name && slot.loc !== undefined) {
if (slot.name && slot.offset !== undefined) {
yield* generateObjectProperty(
options,
ctx,
slot.name,
slot.loc,
slot.offset,
ctx.codeFeatures.withoutHighlightAndCompletion,
slot.nodeLoc
);
Expand All @@ -81,11 +83,10 @@ function* generateSlots(options: TemplateCodegenOptions, ctx: TemplateCodegenCon
`default`
);
}
yield `?(_: typeof ${slot.varName}): any,${newLine}`;
yield `?(props: typeof ${slot.propsVar}): any,${newLine}`;
}
yield `}${endOfLine}`;
}
const name = getSlotsPropertyName(options.vueCompilerOptions.target);
yield `var ${name}!: typeof ${options.slotsAssignName ?? '__VLS_slots'}${endOfLine}`;
}

Expand Down
26 changes: 12 additions & 14 deletions packages/language-core/lib/codegen/template/slotOutlet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export function* generateSlotOutlet(
node: CompilerDOM.SlotOutletNode
): Generator<Code> {
const startTagOffset = node.loc.start.offset + options.template.content.slice(node.loc.start.offset).indexOf(node.tag);
const varSlot = ctx.getInternalVariable();
const propsVar = ctx.getInternalVariable();
const nameProp = node.props.find(prop => {
if (prop.type === CompilerDOM.NodeTypes.ATTRIBUTE) {
return prop.name === 'name';
Expand Down Expand Up @@ -43,7 +43,7 @@ export function* generateSlotOutlet(
? `'${nameProp.value.content}'`
: nameProp?.type === CompilerDOM.NodeTypes.DIRECTIVE && nameProp.exp?.type === CompilerDOM.NodeTypes.SIMPLE_EXPRESSION
? nameProp.exp.content
: `('default' as const)`
: `'default'`
),
`]`
);
Expand All @@ -59,7 +59,7 @@ export function* generateSlotOutlet(
yield `)${endOfLine}`;
}
else {
yield `var ${varSlot} = {${newLine}`;
yield `var ${propsVar} = {${newLine}`;
yield* generateElementProps(options, ctx, node, node.props.filter(prop => prop !== nameProp), options.vueCompilerOptions.strictTemplates, true);
yield `}${endOfLine}`;

Expand All @@ -69,10 +69,10 @@ export function* generateSlotOutlet(
) {
ctx.slots.push({
name: nameProp.value.content,
loc: nameProp.loc.start.offset + nameProp.loc.source.indexOf(nameProp.value.content, nameProp.name.length),
offset: nameProp.loc.start.offset + nameProp.loc.source.indexOf(nameProp.value.content, nameProp.name.length),
tagRange: [startTagOffset, startTagOffset + node.tag.length],
varName: varSlot,
nodeLoc: node.loc,
propsVar,
});
}
else if (
Expand All @@ -83,31 +83,29 @@ export function* generateSlotOutlet(
if (isShortHand) {
ctx.inlayHints.push(createVBindShorthandInlayHintInfo(nameProp.exp.loc, 'name'));
}
const slotExpVar = ctx.getInternalVariable();
yield `var ${slotExpVar} = `;
const expVar = ctx.getInternalVariable();
yield `var ${expVar} = __VLS_tryAsConstant(`;
yield* generateInterpolation(
options,
ctx,
'template',
ctx.codeFeatures.all,
nameProp.exp.content,
nameProp.exp.loc.start.offset,
nameProp.exp,
'(',
')'
nameProp.exp
);
yield ` as const${endOfLine}`;
yield `)${endOfLine}`;
ctx.dynamicSlots.push({
expVar: slotExpVar,
varName: varSlot,
expVar,
propsVar,
});
}
else {
ctx.slots.push({
name: 'default',
tagRange: [startTagOffset, startTagOffset + node.tag.length],
varName: varSlot,
nodeLoc: node.loc,
propsVar,
});
}
}
Expand Down
30 changes: 18 additions & 12 deletions packages/tsc/tests/__snapshots__/dts.spec.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@ declare const _default: <Row extends BaseRow>(__VLS_props: NonNullable<Awaited<t
} & Partial<{}>> & (import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps);
expose(exposed: import("vue").ShallowUnwrapRef<{}>): void;
attrs: any;
slots: {
default?(_: {
slots: __VLS_OmitStringIndex<Readonly<{
[name: string]: import("vue").Slot<any>;
}>> & {
default?(props: {
row: Row;
}): any;
};
Expand Down Expand Up @@ -619,15 +621,17 @@ export {};
exports[`vue-tsc-dts > Input: template-slots/component.vue, Output: template-slots/component.vue.d.ts 1`] = `
"declare function __VLS_template(): {
attrs: Partial<{}>;
slots: {
'no-bind'?(_: {}): any;
default?(_: {
slots: __VLS_OmitStringIndex<Readonly<{
[name: string]: import("vue").Slot<any>;
}>> & {
'no-bind'?(props: {}): any;
default?(props: {
num: number;
}): any;
'named-slot'?(_: {
'named-slot'?(props: {
str: string;
}): any;
vbind?(_: {
vbind?(props: {
num: number;
str: string;
}): any;
Expand Down Expand Up @@ -721,15 +725,17 @@ type __VLS_WithTemplateSlots<T, S> = T & {
exports[`vue-tsc-dts > Input: template-slots/component-no-script.vue, Output: template-slots/component-no-script.vue.d.ts 1`] = `
"declare function __VLS_template(): {
attrs: Partial<{}>;
slots: {
'no-bind'?(_: {}): any;
default?(_: {
slots: __VLS_OmitStringIndex<Readonly<{
[name: string]: import("vue").Slot<any>;
}>> & {
'no-bind'?(props: {}): any;
default?(props: {
num: number;
}): any;
'named-slot'?(_: {
'named-slot'?(props: {
str: string;
}): any;
vbind?(_: {
vbind?(props: {
num: number;
str: string;
}): any;
Expand Down
13 changes: 9 additions & 4 deletions test-workspace/tsc/passedFixtures/vue3/slots/main.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<template>
<!-- $slots type -->
<!-- component slots type -->
<Comp value="1">
<template #foo="bindings">{{ exactType(bindings, {} as string) }}</template>
</Comp>
Expand All @@ -26,7 +26,10 @@
</template>

<script lang="ts">
export default { name: 'Self' };
export default {
name: 'Self',
slots: Object as SlotsType<{ foo?: (_: any) => any }>,
};

declare const Comp: new <T>(props: { value: T; }) => {
$props: typeof props;
Expand All @@ -37,13 +40,15 @@ declare const Comp: new <T>(props: { value: T; }) => {
</script>

<script lang="ts" setup>
import { ref, useSlots, VNode } from 'vue';
import { ref, type SlotsType, useSlots, type VNode } from 'vue';
import { exactType } from '../../shared';

const baz = ref('baz' as const);

const slots = useSlots();
exactType(slots, {} as {
exactType(slots, {} as Readonly<{
foo?(_: any): any;
}> & {
bar?(_: { str: string; num: number; }): any;
} & {
baz?(_: { str: string; num: number; }): any;
Expand Down
Loading