Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 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
56 changes: 46 additions & 10 deletions lib/rules/require-explicit-slots.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,21 @@ function getSlotsName(node) {
return null
}

/**
* @param {VElement} node
* @return {VAttribute | VDirective | undefined}
*/
function getSlotNameNode(node) {
return node.startTag.attributes.find(
(node) =>
(!node.directive && node.key.name === 'name') ||
(node.directive &&
node.key.name.name === 'bind' &&
node.key.argument?.type === 'VIdentifier' &&
node.key.argument?.name === 'name')
)
}

module.exports = {
meta: {
type: 'problem',
Expand Down Expand Up @@ -68,6 +83,19 @@ module.exports = {
}
const slotsDefined = new Set()

/**
* @param {VElement} node
* @param {string | undefined} slotName
*/
function reportMissingSlot(node, slotName) {
if (!slotsDefined.has(slotName)) {
context.report({
node,
messageId: 'requireExplicitSlots'
})
}
}

return utils.compositingVisitors(
utils.defineScriptSetupVisitor(context, {
onDefineSlotsEnter(node) {
Expand Down Expand Up @@ -137,20 +165,28 @@ module.exports = {
}
}),
utils.defineTemplateBodyVisitor(context, {
/** @param {VElement} node */
"VElement[name='slot']"(node) {
let slotName = 'default'

const slotNameAttr = utils.getAttribute(node, 'name')
const nameNode = getSlotNameNode(node)

if (slotNameAttr?.value) {
slotName = slotNameAttr.value.value
// if no slot name is declared, default to 'default'
if (!nameNode) {
reportMissingSlot(node, 'default')
return
}

if (!slotsDefined.has(slotName)) {
context.report({
node,
messageId: 'requireExplicitSlots'
})
if (nameNode.directive) {
const expression = nameNode.value?.expression
// ignore attribute binding except string literal
if (!expression || !utils.isStringLiteral(expression)) {
return
}

const name = utils.getStringLiteralValue(expression) || undefined
reportMissingSlot(node, name)
} else {
// check and report if slot name is declared or is undefined
reportMissingSlot(node, nameNode.value?.value)
}
}
})
Expand Down
51 changes: 51 additions & 0 deletions tests/lib/rules/require-explicit-slots.js
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,37 @@ tester.run('require-explicit-slots', rule, {
parser: null
}
}
},
// attribute binding
{
filename: 'test.vue',
code: `
<template>
<div>
<slot :name="'foo'"></slot>
<slot :name="\`bar\`"></slot>
</div>
</template>
<script setup lang="ts">
defineSlots<{
foo(props: { msg: string }): any
bar(props: { msg: string }): any
}>()
</script>`
},
{
filename: 'test.vue',
code: `
<template>
<div>
<slot :name="bar"></slot>
</div>
</template>
<script setup lang="ts">
defineSlots<{
default(props: { msg: string }): any
}>()
</script>`
}
],
invalid: [
Expand Down Expand Up @@ -291,6 +322,26 @@ tester.run('require-explicit-slots', rule, {
}
]
},
{
// ignore attribute binding except string literal
filename: 'test.vue',
code: `
<template>
<div>
<slot :name="'foo'"></slot>
</div>
</template>
<script setup lang="ts">
defineSlots<{
default(props: { msg: string }): any
}>()
</script>`,
errors: [
{
message: 'Slots must be explicitly defined.'
}
]
},
{
filename: 'test.vue',
code: `
Expand Down
Loading