Skip to content

fix(component-meta): filter events out of props #5547

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

Merged
merged 4 commits into from
Jul 24, 2025
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions packages/component-meta/lib/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ interface ComponentMeta<T> {
let _slots: ReturnType<typeof getSlots> | undefined;
let _exposed: ReturnType<typeof getExposed> | undefined;

return {
const meta = {
get type() {
return _type ?? (_type = getType());
},
Expand All @@ -258,6 +258,8 @@ interface ComponentMeta<T> {
},
};

return meta;

function getType() {
const $type = symbolProperties.find(prop => prop.escapedName === 'type');

Expand All @@ -278,6 +280,10 @@ interface ComponentMeta<T> {
const type = typeChecker.getTypeOfSymbolAtLocation($props, symbolNode);
const properties = type.getProperties();

const eventProps = new Set(
meta.events.map(event => `on${event.name.charAt(0).toUpperCase()}${event.name.slice(1)}`),
);

result = properties
.map(prop => {
const {
Expand All @@ -286,7 +292,7 @@ interface ComponentMeta<T> {

return resolveNestedProperties(prop);
})
.filter(prop => !vnodeEventRegex.test(prop.name));
.filter(prop => !vnodeEventRegex.test(prop.name) && !eventProps.has(prop.name));
}

// fill global
Expand Down
15 changes: 15 additions & 0 deletions packages/component-meta/tests/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1168,6 +1168,21 @@ const worker = (checker: ComponentMetaChecker, withTsconfig: boolean) =>
`);
});

test('component with both props and events', () => {
const componentPath = path.resolve(__dirname, '../../../test-workspace/component-meta/#5546/main.vue');
const meta = checker.getComponentMeta(componentPath);

expect(meta.type).toEqual(TypeMeta.Class);

// Nothing special about this prop
expect(meta.props.find(prop => prop.name === 'title')).toBeDefined();
// Event
expect(meta.props.find(prop => prop.name === 'onClose')).toBeUndefined();
expect(meta.events.find(event => event.name === 'close')).toBeDefined();
// Prop that starts with `on`
expect(meta.props.find(prop => prop.name === 'onCompleted')).toBeDefined();
});

test('non-component', () => {
const componentPath = path.resolve(
__dirname,
Expand Down
14 changes: 14 additions & 0 deletions test-workspace/component-meta/#5546/main.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<script lang="ts" setup>
defineProps<{
title: string;
onCompleted: () => void;
}>()

defineEmits<{
close: []
}>()
</script>

<template>
<div></div>
</template>
Loading