Skip to content

fix(vue3): Fix the declared camelCase event cannot be recognized #2051

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.

Sign up for GitHub

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 2 commits into from
Feb 4, 2024
Merged

fix(vue3): Fix the declared camelCase event cannot be recognized #2051

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
793b3d2
fix: Fix the unmatch the case problem that results the emitted event …
Azurewarth0920 Apr 13, 2023
64b175c
fix: Keep the spelling-case when matching the events
Azurewarth0920 Aug 30, 2023
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
14 changes: 9 additions & 5 deletions packages/app-backend-vue3/src/components/data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { BackendContext } from '@vue-devtools/app-backend-api'
import { getInstanceName, getUniqueComponentId } from './util'
import { camelize, StateEditor, SharedData } from '@vue-devtools/shared-utils'
import { camelize, StateEditor, SharedData, kebabize } from '@vue-devtools/shared-utils'
import { ComponentInstance, CustomState, HookPayloads, Hooks, InspectedComponentData } from '@vue/devtools-api'
import { returnError } from '../util'

Expand Down Expand Up @@ -371,20 +371,24 @@ function processRefs (instance) {
function processEventListeners (instance) {
const emitsDefinition = instance.type.emits
const declaredEmits = Array.isArray(emitsDefinition) ? emitsDefinition : Object.keys(emitsDefinition ?? {})
const declaredEmitsMap = declaredEmits.reduce((emitsMap, key) => {
emitsMap[kebabize(key)] = key
return emitsMap
}, {})
const keys = Object.keys(instance.vnode.props ?? {})
const result = []
for (const key of keys) {
const [prefix, ...eventNameParts] = key.split(/(?=[A-Z])/)
if (prefix === 'on') {
const eventName = eventNameParts.join('-').toLowerCase()
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line makes the eventName kebabized.

But the variable declaredEmits is a mixed case array, which will cause a mismatch.

const isDeclared = declaredEmits.includes(eventName)
const normalizedEventName = declaredEmitsMap[eventName]
result.push({
type: 'event listeners',
key: eventName,
key: normalizedEventName || eventName,
value: {
_custom: {
display: isDeclared ? '✅ Declared' : '⚠️ Not declared',
tooltip: !isDeclared ? `The event <code>${eventName}</code> is not declared in the <code>emits</code> option. It will leak into the component's attributes (<code>$attrs</code>).` : null,
display: normalizedEventName ? '✅ Declared' : '⚠️ Not declared',
tooltip: !normalizedEventName ? `The event <code>${eventName}</code> is not declared in the <code>emits</code> option. It will leak into the component's attributes (<code>$attrs</code>).` : null,
},
},
})
Expand Down