Skip to content

Fix unable to autofix event name with update:. #1648

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 1 commit into from
Oct 5, 2021
Merged

Fix unable to autofix event name with update:. #1648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 16 additions & 15 deletions lib/rules/v-on-event-hyphenation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,16 @@ module.exports = {
const ignoredAttributes = (optionsPayload && optionsPayload.ignore) || []
const autofix = Boolean(optionsPayload && optionsPayload.autofix)

const caseConverter = casing.getExactConverter(
const caseConverter = casing.getConverter(
useHyphenated ? 'kebab-case' : 'camelCase'
)

/**
* @param {VDirective} node
* @param {VIdentifier} argument
* @param {string} name
*/
function reportIssue(node, name) {
function reportIssue(node, argument, name) {
const text = sourceCode.getText(node.key)

context.report({
Expand All @@ -71,13 +72,14 @@ module.exports = {
data: {
text
},
fix: autofix
? (fixer) =>
fixer.replaceText(
node.key,
text.replace(name, caseConverter(name))
)
: null
fix:
autofix &&
// It cannot be converted in snake_case.
!name.includes('_')
? (fixer) => {
return fixer.replaceText(argument, caseConverter(name))
}
: null
})
}

Expand All @@ -99,14 +101,13 @@ module.exports = {
return utils.defineTemplateBodyVisitor(context, {
"VAttribute[directive=true][key.name.name='on']"(node) {
if (!utils.isCustomComponent(node.parent.parent)) return

const name =
node.key.argument &&
node.key.argument.type === 'VIdentifier' &&
node.key.argument.rawName
if (!node.key.argument || node.key.argument.type !== 'VIdentifier') {
return
}
const name = node.key.argument.rawName
if (!name || isIgnoredAttribute(name)) return

reportIssue(node, name)
reportIssue(node, node.key.argument, name)
}
})
}
Expand Down
80 changes: 80 additions & 0 deletions tests/lib/rules/v-on-event-hyphenation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,86 @@ tester.run('v-on-event-hyphenation', rule, {
</template>
`,
errors: ["v-on event 'v-on:custom-event' can't be hyphenated."]
},
{
code: `
<template>
<VueComponent @update:modelValue="foo"/>
<VueComponent @update:model-value="foo"/>
</template>
`,
options: ['always', { autofix: true }],
output: `
<template>
<VueComponent @update:model-value="foo"/>
<VueComponent @update:model-value="foo"/>
</template>
`,
errors: ["v-on event '@update:modelValue' must be hyphenated."]
},
{
code: `
<template>
<VueComponent @update:modelValue="foo"/>
<VueComponent @update:model-value="foo"/>
</template>
`,
options: ['never', { autofix: true }],
output: `
<template>
<VueComponent @update:modelValue="foo"/>
<VueComponent @update:modelValue="foo"/>
</template>
`,
errors: ["v-on event '@update:model-value' can't be hyphenated."]
},
{
code: `
<template>
<VueComponent @upDate:modelValue="foo"/>
<VueComponent @up-date:modelValue="foo"/>
<VueComponent @upDate:model-value="foo"/>
<VueComponent @up-date:model-value="foo"/>
</template>
`,
options: ['always', { autofix: true }],
output: `
<template>
<VueComponent @up-date:model-value="foo"/>
<VueComponent @up-date:model-value="foo"/>
<VueComponent @up-date:model-value="foo"/>
<VueComponent @up-date:model-value="foo"/>
</template>
`,
errors: [
"v-on event '@upDate:modelValue' must be hyphenated.",
"v-on event '@up-date:modelValue' must be hyphenated.",
"v-on event '@upDate:model-value' must be hyphenated."
]
},
{
code: `
<template>
<VueComponent @upDate:modelValue="foo"/>
<VueComponent @up-date:modelValue="foo"/>
<VueComponent @upDate:model-value="foo"/>
<VueComponent @up-date:model-value="foo"/>
</template>
`,
options: ['never', { autofix: true }],
output: `
<template>
<VueComponent @upDate:modelValue="foo"/>
<VueComponent @upDate:modelValue="foo"/>
<VueComponent @upDate:modelValue="foo"/>
<VueComponent @upDate:modelValue="foo"/>
</template>
`,
errors: [
"v-on event '@up-date:modelValue' can't be hyphenated.",
"v-on event '@upDate:model-value' can't be hyphenated.",
"v-on event '@up-date:model-value' can't be hyphenated."
]
}
]
})