Skip to content
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.

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

Update vue/require-prop-types rule to support <script setup> #1546

Merged
merged 1 commit into from Jul 6, 2021
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 18 additions & 6 deletions lib/rules/require-prop-types.js
Expand Up @@ -92,12 +92,24 @@ module.exports = {
// Public
// ----------------------------------------------------------------------

return utils.executeOnVue(context, (obj) => {
const props = utils.getComponentProps(obj)
return utils.compositingVisitors(
utils.defineScriptSetupVisitor(context, {
onDefinePropsEnter(_node, props) {
for (const prop of props) {
if (prop.type === 'type') {
continue
}
checkProperty(prop)
}
}
}),
utils.executeOnVue(context, (obj) => {
const props = utils.getComponentProps(obj)

for (const prop of props) {
checkProperty(prop)
}
})
for (const prop of props) {
checkProperty(prop)
}
})
)
}
}
60 changes: 60 additions & 0 deletions tests/lib/rules/require-prop-types.js
Expand Up @@ -158,6 +158,32 @@ ruleTester.run('require-prop-types', rule, {
`,
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
parser: require.resolve('@typescript-eslint/parser')
},
{
filename: 'test.vue',
code: `
<script setup>
defineProps({
foo: String
})
</script>
`,
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
parser: require.resolve('vue-eslint-parser')
},
{
filename: 'test.vue',
code: `
<script setup lang="ts">
defineProps<{foo:string}>()
</script>
`,
parserOptions: {
ecmaVersion: 6,
sourceType: 'module',
parser: require.resolve('@typescript-eslint/parser')
},
parser: require.resolve('vue-eslint-parser')
}
],

Expand Down Expand Up @@ -305,6 +331,40 @@ ruleTester.run('require-prop-types', rule, {
line: 4
}
]
},
{
filename: 'test.vue',
code: `
<script setup>
defineProps({
foo: {}
})
</script>
`,
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
parser: require.resolve('vue-eslint-parser'),
errors: [
{
message: 'Prop "foo" should define at least its type.',
line: 4
}
]
},
{
filename: 'test.vue',
code: `
<script setup>
defineProps(['foo'])
</script>
`,
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
parser: require.resolve('vue-eslint-parser'),
errors: [
{
message: 'Prop "foo" should define at least its type.',
line: 3
}
]
}
]
})