Skip to content
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
5 changes: 5 additions & 0 deletions .changeset/lemon-turtles-visit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'eslint-plugin-vue': patch
---

Fixed false positives in `vue/define-props-destructuring` rule when imported types are passed to `defineProps`
6 changes: 4 additions & 2 deletions lib/rules/define-props-destructuring.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,10 @@ module.exports = {
return utils.compositingVisitors(
utils.defineScriptSetupVisitor(context, {
onDefinePropsEnter(node, props) {
const hasNoArgs = props.filter((prop) => prop.propName).length === 0
if (hasNoArgs) {
const hasArgs = props.some(
(prop) => prop.propName || (prop.type === 'unknown' && prop.node)
)
if (!hasArgs) {
return
}

Expand Down
136 changes: 136 additions & 0 deletions tests/lib/rules/define-props-destructuring.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,30 @@ tester.run('define-props-destructuring', rule, {
parserOptions: { parser: require.resolve('@typescript-eslint/parser') }
}
},
{
filename: 'test.vue',
code: `
<script setup lang="ts">
import type { Props } from './type'
const { foo } = defineProps<Props>()
</script>
`,
languageOptions: {
parserOptions: { parser: require.resolve('@typescript-eslint/parser') }
}
},
{
filename: 'test.vue',
code: `
<script setup lang="ts">
import { propsObj } from './type'
const { foo } = defineProps(propsObj)
</script>
`,
languageOptions: {
parserOptions: { parser: require.resolve('@typescript-eslint/parser') }
}
},
{
filename: 'test.vue',
code: `
Expand Down Expand Up @@ -73,6 +97,32 @@ tester.run('define-props-destructuring', rule, {
languageOptions: {
parserOptions: { parser: require.resolve('@typescript-eslint/parser') }
}
},
{
filename: 'test.vue',
code: `
<script setup lang="ts">
import type { Props } from './type'
const props = defineProps<Props>()
</script>
`,
options: [{ destructure: 'never' }],
languageOptions: {
parserOptions: { parser: require.resolve('@typescript-eslint/parser') }
}
},
{
filename: 'test.vue',
code: `
<script setup lang="ts">
import { propsObj } from './type'
const props = defineProps(propsObj)
</script>
`,
options: [{ destructure: 'never' }],
languageOptions: {
parserOptions: { parser: require.resolve('@typescript-eslint/parser') }
}
}
],
invalid: [
Expand Down Expand Up @@ -167,6 +217,48 @@ tester.run('define-props-destructuring', rule, {
}
]
},
{
filename: 'test.vue',
code: `
<script setup lang="ts">
import type { Props } from './type'
const props = defineProps<Props>()
</script>
`,
languageOptions: {
parserOptions: { parser: require.resolve('@typescript-eslint/parser') }
},
errors: [
{
messageId: 'preferDestructuring',
line: 4,
column: 21,
endLine: 4,
endColumn: 41
}
]
},
{
filename: 'test.vue',
code: `
<script setup lang="ts">
import { propsObj } from './type'
const props = defineProps(propsObj)
</script>
`,
languageOptions: {
parserOptions: { parser: require.resolve('@typescript-eslint/parser') }
},
errors: [
{
messageId: 'preferDestructuring',
line: 4,
column: 21,
endLine: 4,
endColumn: 42
}
]
},
{
filename: 'test.vue',
code: `
Expand Down Expand Up @@ -223,6 +315,50 @@ tester.run('define-props-destructuring', rule, {
endColumn: 54
}
]
},
{
filename: 'test.vue',
code: `
<script setup lang="ts">
import type { Props } from './type'
const { foo } = defineProps<Props>()
</script>
`,
options: [{ destructure: 'never' }],
languageOptions: {
parserOptions: { parser: require.resolve('@typescript-eslint/parser') }
},
errors: [
{
messageId: 'avoidDestructuring',
line: 4,
column: 23,
endLine: 4,
endColumn: 43
}
]
},
{
filename: 'test.vue',
code: `
<script setup lang="ts">
import { propsObj } from './type'
const { foo } = defineProps(propsObj)
</script>
`,
options: [{ destructure: 'never' }],
languageOptions: {
parserOptions: { parser: require.resolve('@typescript-eslint/parser') }
},
errors: [
{
messageId: 'avoidDestructuring',
line: 4,
column: 23,
endLine: 4,
endColumn: 44
}
]
}
]
})
Loading