-
-
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.
feat(no-this-in-before-router-enter): create rule (#1506)
* feat(no-this-in-before-router-enter): create rule * Update lib/rules/no-this-in-before-route-enter.js Co-authored-by: Yosuke Ota <otameshiyo23@gmail.com> * Update docs/rules/no-this-in-before-route-enter.md Co-authored-by: Yosuke Ota <otameshiyo23@gmail.com> * feat(no-this-in-before-router-enter): create rule Update lib/rules/no-this-in-before-route-enter.js Co-authored-by: Yosuke Ota <otameshiyo23@gmail.com> Update docs/rules/no-this-in-before-route-enter.md Co-authored-by: Yosuke Ota <otameshiyo23@gmail.com> * (feat): update test assertions for no-this-in-before-route-enter rule * (feat): update docs for no-this-in-before-route-enter Co-authored-by: Yosuke Ota <otameshiyo23@gmail.com>
- Loading branch information
1 parent
ea6f9f0
commit 76f835a
Showing
5 changed files
with
398 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,115 @@ | ||
--- | ||
pageClass: rule-details | ||
sidebarDepth: 0 | ||
title: vue/no-this-in-before-route-enter | ||
description: disallow this usage in a beforeRouteEnter method | ||
--- | ||
# vue/no-this-in-before-route-enter | ||
|
||
> disallow this usage in a beforeRouteEnter method | ||
- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> ***This rule has not been released yet.*** </badge> | ||
|
||
## Rule Details | ||
|
||
Because lack of `this` in the `beforeRouteEnter` [(docs)](https://router.vuejs.org/guide/advanced/navigation-guards.html#in-component-guards). This behavior isn't obvious, so it's pretty easy to make a `TypeError`. Especially during some refactor. | ||
|
||
Bad: | ||
|
||
<eslint-code-block :rules="{'vue/no-this-in-before-route-enter': ['error']}"> | ||
|
||
```vue | ||
<script> | ||
export default { | ||
beforeRouteEnter() { | ||
this.method(); // Uncaught TypeError: Cannot read property 'method' of undefined | ||
} | ||
} | ||
</script> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
Bad: | ||
|
||
<eslint-code-block :rules="{'vue/no-this-in-before-route-enter': ['error']}"> | ||
|
||
```vue | ||
<script> | ||
export default { | ||
beforeRouteEnter() { | ||
this.attribute = 42; | ||
} | ||
} | ||
</script> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
Bad: | ||
|
||
<eslint-code-block :rules="{'vue/no-this-in-before-route-enter': ['error']}"> | ||
|
||
```vue | ||
<script> | ||
export default { | ||
beforeRouteEnter() { | ||
if (this.value === 42) { | ||
} | ||
} | ||
} | ||
</script> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
|
||
Bad: | ||
|
||
<eslint-code-block :rules="{'vue/no-this-in-before-route-enter': ['error']}"> | ||
|
||
```vue | ||
<script> | ||
export default { | ||
beforeRouteEnter() { | ||
this.attribute = this.method(); | ||
} | ||
} | ||
</script> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
Good: | ||
|
||
<eslint-code-block :rules="{'vue/no-this-in-before-route-enter': ['error']}"> | ||
|
||
```vue | ||
<script> | ||
export default { | ||
beforeRouteEnter() { | ||
// anything without this | ||
} | ||
} | ||
</script> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
### Options | ||
|
||
Nothing. | ||
|
||
## When Not To Use It | ||
|
||
When [vue-router](https://router.vuejs.org/) is not installed. | ||
|
||
## Further Reading | ||
|
||
[vue-router - in-component-guards](https://router.vuejs.org/guide/advanced/navigation-guards.html#in-component-guards) | ||
|
||
## :mag: Implementation | ||
|
||
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-this-in-before-route-enter.js) | ||
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-this-in-before-route-enter.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,91 @@ | ||
/** | ||
* @fileoverview Don't use this in a beforeRouteEnter method | ||
* @author Przemyslaw Jan Beigert | ||
*/ | ||
'use strict' | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Requirements | ||
// ------------------------------------------------------------------------------ | ||
|
||
const utils = require('../utils') | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Rule Definition | ||
// ------------------------------------------------------------------------------ | ||
|
||
module.exports = { | ||
meta: { | ||
type: 'problem', | ||
docs: { | ||
description: 'disallow this usage in a beforeRouteEnter method', | ||
categories: null, | ||
url: 'https://eslint.vuejs.org/rules/no-this-in-before-route-enter.html' | ||
}, | ||
fixable: null, | ||
schema: [], | ||
messages: { | ||
disallow: | ||
"'beforeRouteEnter' does NOT have access to `this` component instance. https://router.vuejs.org/guide/advanced/navigation-guards.html#in-component-guards." | ||
} | ||
}, | ||
/** @param {RuleContext} context */ | ||
create(context) { | ||
/** | ||
* @typedef {object} ScopeStack | ||
* @property {ScopeStack | null} upper | ||
* @property {FunctionExpression | FunctionDeclaration} node | ||
* @property {boolean} beforeRouteEnter | ||
*/ | ||
/** @type {Set<FunctionExpression>} */ | ||
const beforeRouteEnterFunctions = new Set() | ||
/** @type {ScopeStack | null} */ | ||
let scopeStack = null | ||
|
||
/** | ||
* @param {FunctionExpression | FunctionDeclaration | ArrowFunctionExpression} node | ||
*/ | ||
function onFunctionEnter(node) { | ||
if (node.type === 'ArrowFunctionExpression') { | ||
return | ||
} | ||
scopeStack = { | ||
upper: scopeStack, | ||
node, | ||
beforeRouteEnter: beforeRouteEnterFunctions.has( | ||
/** @type {never} */ (node) | ||
) | ||
} | ||
} | ||
|
||
/** | ||
* @param {FunctionExpression | FunctionDeclaration | ArrowFunctionExpression} node | ||
*/ | ||
function onFunctionExit(node) { | ||
if (scopeStack && scopeStack.node === node) { | ||
scopeStack = scopeStack.upper | ||
} | ||
} | ||
return utils.defineVueVisitor(context, { | ||
onVueObjectEnter(node) { | ||
const beforeRouteEnter = utils.findProperty(node, 'beforeRouteEnter') | ||
if ( | ||
beforeRouteEnter && | ||
beforeRouteEnter.value.type === 'FunctionExpression' | ||
) { | ||
beforeRouteEnterFunctions.add(beforeRouteEnter.value) | ||
} | ||
}, | ||
':function': onFunctionEnter, | ||
':function:exit': onFunctionExit, | ||
ThisExpression(node) { | ||
if (scopeStack && scopeStack.beforeRouteEnter) { | ||
context.report({ | ||
node, | ||
messageId: 'disallow' | ||
}) | ||
} | ||
} | ||
}) | ||
} | ||
} |
Oops, something went wrong.