Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add optional-props-using-with-defaults
- Loading branch information
Showing
5 changed files
with
818 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
pageClass: rule-details | ||
sidebarDepth: 0 | ||
title: vue/optional-props-using-with-defaults | ||
description: enforce props with default values to be optional | ||
--- | ||
# vue/optional-props-using-with-defaults | ||
|
||
> enforce props with default values to be optional | ||
- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. | ||
|
||
## :book: Rule Details | ||
|
||
This rule enforce props with default values to be optional. | ||
Because when a required prop declared with a default value, but it doesn't be passed value when using it, it will be assigned the default value. So a required prop with default value is same as a optional prop. | ||
|
||
<eslint-code-block fix :rules="{'vue/optional-props-using-with-defaults': ['error']}"> | ||
|
||
```vue | ||
<script setup lang="ts"> | ||
/* ✓ GOOD */ | ||
const props = withDefaults( | ||
defineProps<{ | ||
name?: string | number | ||
age?: number | ||
}>(), | ||
{ | ||
name: "Foo", | ||
} | ||
); | ||
/* ✗ BAD */ | ||
const props = withDefaults( | ||
defineProps<{ | ||
name: string | number | ||
age?: number | ||
}>(), | ||
{ | ||
name: "Foo", | ||
} | ||
); | ||
</script> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
## :wrench: Options | ||
|
||
Nothing. | ||
|
||
## :mag: Implementation | ||
|
||
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/optional-props-using-with-defaults.js) | ||
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/optional-props-using-with-defaults.js) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
/** | ||
* @author @neferqiqi | ||
* See LICENSE file in root directory for full license. | ||
*/ | ||
'use strict' | ||
// ------------------------------------------------------------------------------ | ||
// Requirements | ||
// ------------------------------------------------------------------------------ | ||
|
||
const utils = require('../utils') | ||
/** | ||
* @typedef {import('../utils').ComponentTypeProp} ComponentTypeProp | ||
*/ | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Helpers | ||
// ------------------------------------------------------------------------------ | ||
|
||
// ... | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Rule Definition | ||
// ------------------------------------------------------------------------------ | ||
|
||
module.exports = { | ||
meta: { | ||
type: 'suggestion', | ||
docs: { | ||
description: 'enforce props with default values to be optional', | ||
categories: undefined, | ||
url: 'https://eslint.vuejs.org/rules/optional-props-using-with-defaults.html' | ||
}, | ||
fixable: 'code', | ||
schema: [], | ||
messages: { | ||
// ... | ||
} | ||
}, | ||
/** @param {RuleContext} context */ | ||
create(context) { | ||
/** | ||
* @param {ComponentTypeProp} prop | ||
* @param {Token[]} tokens | ||
* */ | ||
const findKeyToken = (prop, tokens) => | ||
tokens.find((token) => { | ||
const isKeyIdentifierEqual = | ||
prop.key.type === 'Identifier' && token.value === prop.key.name | ||
const isKeyLiteralEqual = | ||
prop.key.type === 'Literal' && token.value === prop.key.raw | ||
return isKeyIdentifierEqual || isKeyLiteralEqual | ||
}) | ||
|
||
return utils.defineScriptSetupVisitor(context, { | ||
onDefinePropsEnter(node, props) { | ||
if (!utils.hasWithDefaults(node)) { | ||
return | ||
} | ||
const withDefaultsProps = Object.keys( | ||
utils.getWithDefaultsPropExpressions(node) | ||
) | ||
const requiredProps = props.flatMap((item) => | ||
item.type === 'type' && item.required ? [item] : [] | ||
) | ||
|
||
for (const prop of requiredProps) { | ||
if (withDefaultsProps.includes(prop.propName)) { | ||
const firstToken = context.getSourceCode().getFirstToken(prop.node) | ||
// skip setter & getter case | ||
if (firstToken.value === 'get' || firstToken.value === 'set') { | ||
return | ||
} | ||
// skip computed | ||
if (prop.node.computed) { | ||
return | ||
} | ||
const keyToken = findKeyToken( | ||
prop, | ||
context.getSourceCode().getTokens(prop.node) | ||
) | ||
if (!keyToken) return | ||
context.report({ | ||
node: prop.node, | ||
loc: prop.node.loc, | ||
data: { | ||
key: prop.propName | ||
}, | ||
message: `Prop "{{ key }}" should be optional.`, | ||
fix: (fixer) => fixer.insertTextAfter(keyToken, '?') | ||
}) | ||
} | ||
} | ||
} | ||
}) | ||
} | ||
} |
Oops, something went wrong.