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

feat(component-meta): add typing resolution for defineModel modifiers #4175

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/component-meta/tests/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,17 @@ const worker = (checker: ComponentMetaChecker, withTsconfig: boolean) => describ
const bar = meta.props.find(prop => prop.name === 'bar');
const onUpdateBar = meta.events.find(event => event.name === 'update:bar')

const qux = meta.props.find(prop => prop.name === 'qux');
const quxModifiers = meta.props.find(prop => prop.name === 'quxModifiers');
const onUpdateQux = meta.events.find(event => event.name === 'update:qux')

expect(foo).toBeDefined();
expect(bar).toBeDefined();
expect(qux).toBeDefined();
expect(quxModifiers).toBeDefined();
expect(onUpdateFoo).toBeDefined();
expect(onUpdateBar).toBeDefined();
expect(onUpdateQux).toBeDefined();
})

test('reference-type-props', () => {
Expand Down
17 changes: 17 additions & 0 deletions packages/language-core/lib/generators/script.ts
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,7 @@ export function* generate(
const start = getGeneratedLength();
definePropMirrors.set(propName, start);
yield _(propName);

}
else {
yield _(propName);
Expand All @@ -646,6 +647,22 @@ export function* generate(
else {
yield _(`import('${vueCompilerOptions.lib}').PropType<${type}>,\n`);
}

if (defineProp.modifierType) {
let propModifierName = 'modelModifiers';

if (defineProp.name) {
propModifierName = `${scriptSetup.content.substring(defineProp.name.start + 1, defineProp.name.end - 1)}Modifiers`;
}

const modifierType = scriptSetup.content.substring(defineProp.modifierType.start, defineProp.modifierType.end);

const start = getGeneratedLength();
definePropMirrors.set(propModifierName, start);
yield _(propModifierName);
yield _(`: `);
yield _(`import('${vueCompilerOptions.lib}').PropType<Record<${modifierType}, true>>,\n`);
}
}
yield _(`};\n`);
}
Expand Down
2 changes: 2 additions & 0 deletions packages/language-core/lib/parsers/scriptSetupRanges.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export function parseScriptSetupRanges(
name: TextRange | undefined;
nameIsString: boolean;
type: TextRange | undefined;
modifierType?: TextRange | undefined;
defaultValue: TextRange | undefined;
required: boolean;
isModel?: boolean;
Expand Down Expand Up @@ -132,6 +133,7 @@ export function parseScriptSetupRanges(
name,
nameIsString: true,
type: node.typeArguments?.length ? _getStartEnd(node.typeArguments[0]) : undefined,
modifierType: node.typeArguments && node.typeArguments?.length >= 2 ? _getStartEnd(node.typeArguments[1]) : undefined,
defaultValue: undefined,
required,
isModel: true,
Expand Down
6 changes: 6 additions & 0 deletions packages/tsc/tests/__snapshots__/dts.spec.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -317,15 +317,21 @@ exports[`vue-tsc-dts > Input: reference-type-model/component.vue, Output: refere
"declare const _default: import("vue").DefineComponent<{
foo: import("vue").PropType<number>;
bar: import("vue").PropType<string[]>;
qux: import("vue").PropType<string>;
quxModifiers: import("vue").PropType<Record<"trim" | "lazy", true>>;
}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
"update:foo": (foo: number) => void;
"update:bar": (bar: string[]) => void;
"update:qux": (qux: string) => void;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
foo: import("vue").PropType<number>;
bar: import("vue").PropType<string[]>;
qux: import("vue").PropType<string>;
quxModifiers: import("vue").PropType<Record<"trim" | "lazy", true>>;
}>> & {
"onUpdate:foo"?: (foo: number) => any;
"onUpdate:bar"?: (bar: string[]) => any;
"onUpdate:qux"?: (qux: string) => any;
}, {}, {}>;
export default _default;
"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<script setup lang="ts">
const bar = defineModel<number>("foo")
const baz = defineModel<string[]>("bar")
const [qux, modifiers] = defineModel<string, 'lazy' | 'trim'>("qux")
</script>