-
-
Notifications
You must be signed in to change notification settings - Fork 666
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
272 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/valid-v-is | ||
description: enforce valid `v-is` directives | ||
--- | ||
# vue/valid-v-is | ||
> enforce valid `v-is` directives | ||
- :gear: This rule is included in all of `"plugin:vue/vue3-essential"`, `"plugin:vue/vue3-strongly-recommended"` and `"plugin:vue/vue3-recommended"`. | ||
|
||
This rule checks whether every `v-is` directive is valid. | ||
|
||
## :book: Rule Details | ||
|
||
This rule reports `v-is` directives in the following cases: | ||
|
||
- The directive has that argument. E.g. `<div v-is:aaa="foo"></div>` | ||
- The directive has that modifier. E.g. `<div v-is.bbb="foo"></div>` | ||
- The directive does not have that attribute value. E.g. `<div v-is></div>` | ||
- The directive is on Vue-components. E.g. `<MyComponent v-is="foo"></MyComponent>` | ||
|
||
<eslint-code-block :rules="{'vue/valid-v-is': ['error']}"> | ||
|
||
```vue | ||
<template> | ||
<!-- ✓ GOOD --> | ||
<tr v-is="'blog-post-row'"></tr> | ||
<tr v-is="foo"></tr> | ||
<!-- ✗ BAD --> | ||
<tr v-is:a="foo"></tr> | ||
<tr v-is.m="foo"></tr> | ||
<tr v-is></tr> | ||
<tr v-is=""></tr> | ||
<MyComponent v-is="foo" /> | ||
</template> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
::: warning Note | ||
This rule does not check syntax errors in directives because it's checked by [vue/no-parsing-error] rule. | ||
::: | ||
|
||
## :wrench: Options | ||
|
||
Nothing. | ||
|
||
## :couple: Related Rules | ||
|
||
- [vue/no-parsing-error] | ||
|
||
[vue/no-parsing-error]: ./no-parsing-error.md | ||
|
||
## :books: Further Reading | ||
|
||
- [API - v-is](https://v3.vuejs.org/api/directives.html#v-is) | ||
|
||
## :mag: Implementation | ||
|
||
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/valid-v-is.js) | ||
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/valid-v-is.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,95 @@ | ||
/** | ||
* @fileoverview enforce valid `v-is` directives | ||
* @author Yosuke Ota | ||
*/ | ||
'use strict' | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Requirements | ||
// ------------------------------------------------------------------------------ | ||
|
||
const utils = require('../utils') | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Helpers | ||
// ------------------------------------------------------------------------------ | ||
|
||
/** | ||
* Check whether the given node is valid or not. | ||
* @param {VElement} node The element node to check. | ||
* @returns {boolean} `true` if the node is valid. | ||
*/ | ||
function isValidElement(node) { | ||
if ( | ||
utils.isHtmlElementNode(node) && | ||
!utils.isHtmlWellKnownElementName(node.rawName) | ||
) { | ||
// Vue-component | ||
return false | ||
} | ||
return true | ||
} | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Rule Definition | ||
// ------------------------------------------------------------------------------ | ||
|
||
module.exports = { | ||
meta: { | ||
type: 'problem', | ||
docs: { | ||
description: 'enforce valid `v-is` directives', | ||
categories: ['vue3-essential'], | ||
url: 'https://eslint.vuejs.org/rules/valid-v-is.html' | ||
}, | ||
fixable: null, | ||
schema: [], | ||
messages: { | ||
unexpectedArgument: "'v-is' directives require no argument.", | ||
unexpectedModifier: "'v-is' directives require no modifier.", | ||
expectedValue: "'v-is' directives require that attribute value.", | ||
ownerMustBeHTMLElement: | ||
"'v-is' directive must be owned by a native HTML element, but '{{name}}' is not." | ||
} | ||
}, | ||
/** @param {RuleContext} context */ | ||
create(context) { | ||
return utils.defineTemplateBodyVisitor(context, { | ||
"VAttribute[directive=true][key.name.name='is']"(node) { | ||
if (node.key.argument) { | ||
context.report({ | ||
node, | ||
loc: node.loc, | ||
messageId: 'unexpectedArgument' | ||
}) | ||
} | ||
if (node.key.modifiers.length > 0) { | ||
context.report({ | ||
node, | ||
loc: node.loc, | ||
messageId: 'unexpectedModifier' | ||
}) | ||
} | ||
if (!node.value || utils.isEmptyValueDirective(node, context)) { | ||
context.report({ | ||
node, | ||
loc: node.loc, | ||
messageId: 'expectedValue' | ||
}) | ||
} | ||
|
||
const element = node.parent.parent | ||
|
||
if (!isValidElement(element)) { | ||
const name = element.name | ||
context.report({ | ||
node, | ||
loc: node.loc, | ||
messageId: 'ownerMustBeHTMLElement', | ||
data: { name } | ||
}) | ||
} | ||
} | ||
}) | ||
} | ||
} |
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 | ||
*/ | ||
'use strict' | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Requirements | ||
// ------------------------------------------------------------------------------ | ||
|
||
const RuleTester = require('eslint').RuleTester | ||
const rule = require('../../../lib/rules/valid-v-is') | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Tests | ||
// ------------------------------------------------------------------------------ | ||
|
||
const tester = new RuleTester({ | ||
parser: require.resolve('vue-eslint-parser'), | ||
parserOptions: { ecmaVersion: 2020 } | ||
}) | ||
|
||
tester.run('valid-v-is', rule, { | ||
valid: [ | ||
{ | ||
filename: 'test.vue', | ||
code: '' | ||
}, | ||
{ | ||
filename: 'test.vue', | ||
code: '<template><div v-is="foo" /></template>' | ||
}, | ||
{ | ||
filename: 'test.vue', | ||
code: '<template><div v-bind:foo="foo" /></template>' | ||
}, | ||
{ | ||
filename: 'test.vue', | ||
code: `<template><div v-is="'foo'" /></template>` | ||
}, | ||
// parsing error | ||
{ | ||
filename: 'parsing-error.vue', | ||
code: '<template><div v-is="." /></template>' | ||
}, | ||
// comment value (parsing error) | ||
{ | ||
filename: 'comment-value.vue', | ||
code: '<template><div v-is="/**/" /></template>' | ||
} | ||
], | ||
invalid: [ | ||
{ | ||
filename: 'test.vue', | ||
code: '<template><div v-is:a="foo" /></template>', | ||
errors: [ | ||
{ | ||
message: "'v-is' directives require no argument.", | ||
column: 16, | ||
endColumn: 28 | ||
} | ||
] | ||
}, | ||
{ | ||
filename: 'test.vue', | ||
code: '<template><div v-is.a="foo" /></template>', | ||
errors: [ | ||
{ | ||
message: "'v-is' directives require no modifier.", | ||
column: 16, | ||
endColumn: 28 | ||
} | ||
] | ||
}, | ||
{ | ||
filename: 'test.vue', | ||
code: '<template><div v-is /></template>', | ||
errors: [ | ||
{ | ||
message: "'v-is' directives require that attribute value.", | ||
column: 16, | ||
endColumn: 20 | ||
} | ||
] | ||
}, | ||
{ | ||
filename: 'test.vue', | ||
code: '<template><div v-is="" /></template>', | ||
errors: [ | ||
{ | ||
message: "'v-is' directives require that attribute value.", | ||
column: 16, | ||
endColumn: 23 | ||
} | ||
] | ||
}, | ||
{ | ||
filename: 'test.vue', | ||
code: '<template><MyComponent v-is="foo" /></template>', | ||
errors: [ | ||
{ | ||
message: | ||
"'v-is' directive must be owned by a native HTML element, but 'mycomponent' is not.", | ||
column: 24, | ||
endColumn: 34 | ||
} | ||
] | ||
} | ||
] | ||
}) |
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