Skip to content

Fix false positives for type-only defineProps in vue/require-default-prop rule #1592

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

Merged
merged 2 commits into from
Aug 3, 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions lib/rules/require-default-prop.js
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,12 @@ module.exports = {
withDefaults &&
withDefaultsExpressions
) {
if (prop.required) {
continue
}
if (prop.types.length === 1 && prop.types[0] === 'Boolean') {
continue
}
if (!withDefaultsExpressions[prop.propName]) {
context.report({
node: prop.node,
Expand Down
55 changes: 51 additions & 4 deletions tests/lib/rules/require-default-prop.js
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ ruleTester.run('require-default-prop', rule, {
code: `
<script setup lang="ts">
interface Props {
foo: number
foo?: number
}
defineProps<Props>()
</script>
Expand All @@ -251,7 +251,7 @@ ruleTester.run('require-default-prop', rule, {
code: `
<script setup lang="ts">
interface Props {
foo: number
foo?: number
}
withDefaults(defineProps<Props>(), {foo:42})
</script>
Expand All @@ -267,7 +267,7 @@ ruleTester.run('require-default-prop', rule, {
code: `
<script setup lang="ts">
interface Props {
foo: number
foo?: number
}
defineProps<Props>({
foo:{
Expand All @@ -281,6 +281,53 @@ ruleTester.run('require-default-prop', rule, {
...parserOptions,
parser: require.resolve('@typescript-eslint/parser')
}
},
{
// https://github.com/vuejs/eslint-plugin-vue/issues/1591
filename: 'test.vue',
code: `
<template>
<div>
{{ required }}
{{ optional }}
</div>
</template>

<script setup lang="ts">
import { defineProps, withDefaults } from 'vue';

interface Props {
required: boolean;
optional?: boolean;
}

const props = withDefaults(defineProps<Props>(), {
optional: false,
});
</script>
`,
parser: require.resolve('vue-eslint-parser'),
parserOptions: {
...parserOptions,
parser: require.resolve('@typescript-eslint/parser')
}
},
{
filename: 'test.vue',
code: `
<script setup lang="ts">
interface Props {
optional?: boolean;
}

const props = defineProps<Props>();
</script>
`,
parser: require.resolve('vue-eslint-parser'),
parserOptions: {
...parserOptions,
parser: require.resolve('@typescript-eslint/parser')
}
}
],

Expand Down Expand Up @@ -503,7 +550,7 @@ ruleTester.run('require-default-prop', rule, {
code: `
<script setup lang="ts">
interface Props {
foo: number
foo?: number
}
withDefaults(defineProps<Props>(), {bar:42})
</script>
Expand Down
16 changes: 10 additions & 6 deletions tests/lib/utils/index.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
'use strict'

const babelEslint = require('babel-eslint')
const espree = require('espree')
const utils = require('../../../lib/utils/index')
const assert = require('assert')

describe('getComputedProperties', () => {
const parse = function (code) {
return babelEslint.parse(code).body[0].declarations[0].init
return espree.parse(code, { ecmaVersion: 2020 }).body[0].declarations[0]
.init
}

it('should return empty array when there is no computed property', () => {
Expand Down Expand Up @@ -112,7 +112,8 @@ describe('getComputedProperties', () => {

describe('getStaticPropertyName', () => {
const parse = function (code) {
return babelEslint.parse(code).body[0].declarations[0].init
return espree.parse(code, { ecmaVersion: 2020 }).body[0].declarations[0]
.init
}

it('should parse property expression with identifier', () => {
Expand All @@ -137,7 +138,8 @@ describe('getStaticPropertyName', () => {

describe('getStringLiteralValue', () => {
const parse = function (code) {
return babelEslint.parse(code).body[0].declarations[0].init
return espree.parse(code, { ecmaVersion: 2020 }).body[0].declarations[0]
.init
}

it('should parse literal', () => {
Expand Down Expand Up @@ -275,7 +277,8 @@ describe('getMemberChaining', () => {

describe('getRegisteredComponents', () => {
const parse = function (code) {
return babelEslint.parse(code).body[0].declarations[0].init
return espree.parse(code, { ecmaVersion: 2020 }).body[0].declarations[0]
.init
}

it('should return empty array when there are no components registered', () => {
Expand Down Expand Up @@ -335,7 +338,8 @@ describe('getRegisteredComponents', () => {

describe('getComponentProps', () => {
const parse = function (code) {
const data = babelEslint.parse(code).body[0].declarations[0].init
const data = espree.parse(code, { ecmaVersion: 2020 }).body[0]
.declarations[0].init
return utils.getComponentProps(data)
}

Expand Down