Skip to content

fix(require-explicit-slots): Add support for type reference #2484

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

Closed
wants to merge 1 commit into from
Closed

fix(require-explicit-slots): Add support for type reference #2484

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
27 changes: 27 additions & 0 deletions lib/rules/require-explicit-slots.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
'use strict'

const utils = require('../utils')
const { getComponentPropsFromTypeDefine } = require('../utils/ts-utils')

/**
* @typedef {import('@typescript-eslint/types').TSESTree.TypeNode} TypeNode
Expand Down Expand Up @@ -95,6 +96,32 @@ module.exports = {
slotsDefined.add(slotName)
}
}
} else if (
param.type === 'TSTypeReference' &&
param.typeName.type === 'Identifier'
) {
const componentPropsFromTypeDefine =
getComponentPropsFromTypeDefine(context, typeArguments?.params[0])
Copy link
Member

Choose a reason for hiding this comment

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

Hmm... I'm not sure if there's any problem using getComponentPropsFromTypeDefine since it's just a helper for Props. Can you please fix the issue without using getComponentPropsFromTypeDefine?


for (const memberNode of componentPropsFromTypeDefine) {
const slotName = memberNode.propName

if (!slotName || !memberNode.node) {
continue
}

if (slotsDefined.has(slotName)) {
context.report({
node: memberNode.node,
messageId: 'alreadyDefinedSlot',
data: {
slotName
}
})
} else {
slotsDefined.add(slotName)
}
}
}
}
}),
Expand Down
79 changes: 79 additions & 0 deletions tests/lib/rules/require-explicit-slots.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,36 @@ tester.run('require-explicit-slots', rule, {
parser: null
}
}
},
{
filename: 'test.vue',
code: `
<template>
<div>
<slot></slot>
</div>
</template>
<script lang="ts" setup>
interface Slots {
default: () => string;
}
defineSlots<Slots>()
</script>`
},
{
filename: 'test.vue',
code: `
<template>
<div>
<slot name="foo"></slot>
</div>
</template>
<script setup lang="ts">
interface MySlots {
foo: (msg: string) => any
}
defineSlots<MySlots>()
</script>`
}
],
invalid: [
Expand Down Expand Up @@ -333,6 +363,55 @@ tester.run('require-explicit-slots', rule, {
message: 'Slot foo is already defined.'
}
]
},
{
filename: 'test.vue',
code: `
<template>
<div>
<slot name="foo" />
</div>
</template>
<script setup lang="ts">
interface MySlots {
default: any;
foo: (message: string) => any;
}
defineSlots<MySlots>()
defineSlots<{
default(props: { msg: string }): any,
}>()
</script>`,
errors: [
{
message: 'Slot default is already defined.'
}
]
},
{
filename: 'test.vue',
code: `
<template>
<div>
<slot name="foo" />
</div>
</template>
<script setup lang="ts">
interface MySlots {
default: any;
foo: (message: string) => any;
}
defineSlots<MySlots>()
defineSlots<MySlots>()
</script>`,
errors: [
{
message: 'Slot default is already defined.'
},
{
message: 'Slot foo is already defined.'
}
]
}
]
})