-
-
Notifications
You must be signed in to change notification settings - Fork 663
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
vue/return-in-emits-validator
rule (#1129)
- Loading branch information
Showing
6 changed files
with
450 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,63 @@ | ||
--- | ||
pageClass: rule-details | ||
sidebarDepth: 0 | ||
title: vue/return-in-emits-validator | ||
description: enforce that a return statement is present in emits validator | ||
--- | ||
# vue/return-in-emits-validator | ||
> enforce that a return statement is present in emits validator | ||
- :gear: This rule is included in all of `"plugin:vue/vue3-essential"`, `"plugin:vue/vue3-strongly-recommended"` and `"plugin:vue/vue3-recommended"`. | ||
|
||
## :book: Rule Details | ||
|
||
This rule enforces that a `return` statement is present in `emits` validators. | ||
|
||
<eslint-code-block :rules="{'vue/return-in-emits-validator': ['error']}"> | ||
|
||
```vue | ||
<script> | ||
export default { | ||
emits: { | ||
/* ✓ GOOD */ | ||
foo (evt) { | ||
if (evt) { | ||
return true | ||
} else { | ||
return false | ||
} | ||
}, | ||
bar: function () { | ||
return true | ||
}, | ||
baz (evt) { | ||
if (evt) { | ||
return true | ||
} | ||
}, | ||
/* ✗ BAD */ | ||
qux: function () {}, | ||
quux (evt) { | ||
if (!evt) { | ||
return false | ||
} | ||
} | ||
} | ||
} | ||
</script> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
## :wrench: Options | ||
|
||
Nothing. | ||
|
||
## :books: Further reading | ||
|
||
- [Vue RFCs - 0030-emits-option](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0030-emits-option.md) | ||
|
||
## :mag: Implementation | ||
|
||
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/return-in-emits-validator.js) | ||
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/return-in-emits-validator.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
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,109 @@ | ||
/** | ||
* @author Yosuke Ota | ||
* See LICENSE file in root directory for full license. | ||
*/ | ||
'use strict' | ||
|
||
const utils = require('../utils') | ||
|
||
/** | ||
* @typedef {import('vue-eslint-parser').AST.ESLintExpression} Expression | ||
*/ | ||
|
||
/** | ||
* Checks if the given node value is falsy. | ||
* @param {Expression} node The node to check | ||
* @returns {boolean} If `true`, the given node value is falsy. | ||
*/ | ||
function isFalsy (node) { | ||
if (node.type === 'Literal') { | ||
if (node.bigint) { | ||
return node.bigint === '0' | ||
} else if (!node.value) { | ||
return true | ||
} | ||
} else if (node.type === 'Identifier') { | ||
if (node.name === 'undefined' || node.name === 'NaN') { | ||
return true | ||
} | ||
} | ||
return false | ||
} | ||
// ------------------------------------------------------------------------------ | ||
// Rule Definition | ||
// ------------------------------------------------------------------------------ | ||
|
||
module.exports = { | ||
meta: { | ||
type: 'problem', | ||
docs: { | ||
description: 'enforce that a return statement is present in emits validator', | ||
categories: ['vue3-essential'], | ||
url: 'https://eslint.vuejs.org/rules/return-in-emits-validator.html' | ||
}, | ||
fixable: null, // or "code" or "whitespace" | ||
schema: [] | ||
}, | ||
|
||
create (context) { | ||
const emitsValidators = [] | ||
|
||
// ---------------------------------------------------------------------- | ||
// Public | ||
// ---------------------------------------------------------------------- | ||
|
||
let scopeStack = null | ||
|
||
return Object.assign({}, | ||
utils.defineVueVisitor(context, | ||
{ | ||
ObjectExpression (obj, { node: vueNode }) { | ||
if (obj !== vueNode) { | ||
return | ||
} | ||
for (const emits of utils.getComponentEmits(obj)) { | ||
const emitsValue = emits.value | ||
if (!emitsValue) { | ||
continue | ||
} | ||
if (emitsValue.type !== 'FunctionExpression' && emitsValue.type !== 'ArrowFunctionExpression') { | ||
continue | ||
} | ||
emitsValidators.push(emits) | ||
} | ||
}, | ||
':function' (node) { | ||
scopeStack = { upper: scopeStack, functionNode: node, hasReturnValue: false, possibleOfReturnTrue: false } | ||
}, | ||
ReturnStatement (node) { | ||
if (node.argument) { | ||
scopeStack.hasReturnValue = true | ||
|
||
if (!isFalsy(node.argument)) { | ||
scopeStack.possibleOfReturnTrue = true | ||
} | ||
} | ||
}, | ||
':function:exit' (node) { | ||
if (!scopeStack.possibleOfReturnTrue) { | ||
const emits = emitsValidators.find(e => e.value === node) | ||
if (emits) { | ||
context.report({ | ||
node, | ||
message: scopeStack.hasReturnValue | ||
? 'Expected to return a true value in "{{name}}" emits validator.' | ||
: 'Expected to return a boolean value in "{{name}}" emits validator.', | ||
data: { | ||
name: emits.emitName | ||
} | ||
}) | ||
} | ||
} | ||
|
||
scopeStack = scopeStack.upper | ||
} | ||
} | ||
), | ||
) | ||
} | ||
} |
Oops, something went wrong.