Skip to content

Commit 59727a4

Browse files
authored
Add vue/no-deprecated-functional-template rule (#1119)
1 parent 424bcc2 commit 59727a4

File tree

6 files changed

+158
-0
lines changed

6 files changed

+158
-0
lines changed

docs/rules/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Enforce all the rules in this category, as well as all higher priority rules, wi
4242
| [vue/no-deprecated-data-object-declaration](./no-deprecated-data-object-declaration.md) | disallow using deprecated object declaration on data (in Vue.js 3.0.0+) | :wrench: |
4343
| [vue/no-deprecated-events-api](./no-deprecated-events-api.md) | disallow using deprecated events api (in Vue.js 3.0.0+) | |
4444
| [vue/no-deprecated-filter](./no-deprecated-filter.md) | disallow using deprecated filters syntax (in Vue.js 3.0.0+) | |
45+
| [vue/no-deprecated-functional-template](./no-deprecated-functional-template.md) | disallow using deprecated the `functional` template (in Vue.js 3.0.0+) | |
4546
| [vue/no-deprecated-html-element-is](./no-deprecated-html-element-is.md) | disallow using deprecated the `is` attribute on HTML elements (in Vue.js 3.0.0+) | |
4647
| [vue/no-deprecated-inline-template](./no-deprecated-inline-template.md) | disallow using deprecated `inline-template` attribute (in Vue.js 3.0.0+) | |
4748
| [vue/no-deprecated-scope-attribute](./no-deprecated-scope-attribute.md) | disallow deprecated `scope` attribute (in Vue.js 2.5.0+) | :wrench: |
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
pageClass: rule-details
3+
sidebarDepth: 0
4+
title: vue/no-deprecated-functional-template
5+
description: disallow using deprecated the `functional` template (in Vue.js 3.0.0+)
6+
---
7+
# vue/no-deprecated-functional-template
8+
> disallow using deprecated the `functional` template (in Vue.js 3.0.0+)
9+
10+
- :gear: This rule is included in all of `"plugin:vue/vue3-essential"`, `"plugin:vue/vue3-strongly-recommended"` and `"plugin:vue/vue3-recommended"`.
11+
12+
## :book: Rule Details
13+
14+
This rule reports deprecated the `functional` template (in Vue.js 3.0.0+)
15+
16+
<eslint-code-block :rules="{'vue/no-deprecated-functional-template': ['error']}">
17+
18+
```vue
19+
<!-- ✗ BAD -->
20+
<template functional>
21+
<!-- ... -->
22+
</template>
23+
```
24+
25+
</eslint-code-block>
26+
27+
### :wrench: Options
28+
29+
Nothing.
30+
31+
## :books: Further Reading
32+
33+
- [Vue RFCs - 0007-functional-async-api-change](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0007-functional-async-api-change.md)
34+
- [Guide - Functional Components](https://vuejs.org/v2/guide/render-function.html#Functional-Components)
35+
36+
## :mag: Implementation
37+
38+
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-deprecated-functional-template.js)
39+
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-deprecated-functional-template.js)

lib/configs/vue3-essential.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ module.exports = {
1010
'vue/no-deprecated-data-object-declaration': 'error',
1111
'vue/no-deprecated-events-api': 'error',
1212
'vue/no-deprecated-filter': 'error',
13+
'vue/no-deprecated-functional-template': 'error',
1314
'vue/no-deprecated-html-element-is': 'error',
1415
'vue/no-deprecated-inline-template': 'error',
1516
'vue/no-deprecated-scope-attribute': 'error',

lib/index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ module.exports = {
4343
'no-deprecated-data-object-declaration': require('./rules/no-deprecated-data-object-declaration'),
4444
'no-deprecated-events-api': require('./rules/no-deprecated-events-api'),
4545
'no-deprecated-filter': require('./rules/no-deprecated-filter'),
46+
'no-deprecated-functional-template': require('./rules/no-deprecated-functional-template'),
4647
'no-deprecated-html-element-is': require('./rules/no-deprecated-html-element-is'),
4748
'no-deprecated-inline-template': require('./rules/no-deprecated-inline-template'),
4849
'no-deprecated-scope-attribute': require('./rules/no-deprecated-scope-attribute'),
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
/**
2+
* @author Yosuke Ota
3+
* See LICENSE file in root directory for full license.
4+
*/
5+
'use strict'
6+
7+
// ------------------------------------------------------------------------------
8+
// Requirements
9+
// ------------------------------------------------------------------------------
10+
11+
const utils = require('../utils')
12+
13+
// ------------------------------------------------------------------------------
14+
// Rule Definition
15+
// ------------------------------------------------------------------------------
16+
17+
module.exports = {
18+
meta: {
19+
type: 'problem',
20+
docs: {
21+
description: 'disallow using deprecated the `functional` template (in Vue.js 3.0.0+)',
22+
categories: ['vue3-essential'],
23+
url: 'https://eslint.vuejs.org/rules/no-deprecated-functional-template.html'
24+
},
25+
fixable: null,
26+
schema: [],
27+
messages: {
28+
unexpected: 'The `functional` template are deprecated.'
29+
}
30+
},
31+
32+
create (context) {
33+
return {
34+
Program (program) {
35+
const element = program.templateBody
36+
if (element == null) {
37+
return
38+
}
39+
40+
const functional = utils.getAttribute(element, 'functional')
41+
42+
if (functional) {
43+
context.report({
44+
node: functional,
45+
messageId: 'unexpected'
46+
})
47+
}
48+
}
49+
}
50+
}
51+
}
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/**
2+
* @author Yosuke Ota
3+
* See LICENSE file in root directory for full license.
4+
*/
5+
'use strict'
6+
7+
// ------------------------------------------------------------------------------
8+
// Requirements
9+
// ------------------------------------------------------------------------------
10+
11+
const rule = require('../../../lib/rules/no-deprecated-functional-template')
12+
const RuleTester = require('eslint').RuleTester
13+
14+
// ------------------------------------------------------------------------------
15+
// Tests
16+
// ------------------------------------------------------------------------------
17+
18+
const ruleTester = new RuleTester({
19+
parser: require.resolve('vue-eslint-parser'),
20+
parserOptions: { ecmaVersion: 2019 }
21+
})
22+
23+
ruleTester.run('no-deprecated-functional-template', rule, {
24+
valid: [
25+
{
26+
filename: 'test.vue',
27+
code: '<template></template>'
28+
},
29+
{
30+
filename: 'test.vue',
31+
code: '<template><div /></template>'
32+
},
33+
{
34+
filename: 'test.vue',
35+
code: '<template f><div /></template>'
36+
}
37+
],
38+
39+
invalid: [
40+
{
41+
filename: 'test.vue',
42+
code: '<template functional></template>',
43+
errors: [
44+
{
45+
line: 1,
46+
column: 11,
47+
messageId: 'unexpected',
48+
endLine: 1,
49+
endColumn: 21
50+
}
51+
]
52+
},
53+
{
54+
filename: 'test.vue',
55+
code: '<template functional><div /></template>',
56+
errors: [
57+
{
58+
line: 1,
59+
column: 11,
60+
messageId: 'unexpected'
61+
}
62+
]
63+
}
64+
]
65+
})

0 commit comments

Comments
 (0)