Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add vue/prefer-template rule #1141

Merged
merged 1 commit into from May 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/rules/README.md
Expand Up @@ -292,6 +292,7 @@ For example:
| [vue/no-unsupported-features](./no-unsupported-features.md) | disallow unsupported Vue.js syntax on the specified version | :wrench: |
| [vue/object-curly-spacing](./object-curly-spacing.md) | enforce consistent spacing inside braces | :wrench: |
| [vue/padding-line-between-blocks](./padding-line-between-blocks.md) | require or disallow padding lines between blocks | :wrench: |
| [vue/prefer-template](./prefer-template.md) | require template literals instead of string concatenation | :wrench: |
| [vue/require-direct-export](./require-direct-export.md) | require the component to be directly exported | |
| [vue/require-explicit-emits](./require-explicit-emits.md) | require `emits` option with name triggered by `$emit()` | |
| [vue/require-name-property](./require-name-property.md) | require a name property in Vue components | |
Expand Down
23 changes: 23 additions & 0 deletions docs/rules/prefer-template.md
@@ -0,0 +1,23 @@
---
pageClass: rule-details
sidebarDepth: 0
title: vue/prefer-template
description: require template literals instead of string concatenation
---
# vue/prefer-template
> require template literals instead of string concatenation

- :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.

This rule is the same rule as core [prefer-template] rule but it applies to the expressions in `<template>`.

## :books: Further reading

- [prefer-template]

[prefer-template]: https://eslint.org/docs/rules/prefer-template

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/prefer-template.js)
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/prefer-template.js)
1 change: 1 addition & 0 deletions lib/index.js
Expand Up @@ -89,6 +89,7 @@ module.exports = {
'object-curly-spacing': require('./rules/object-curly-spacing'),
'order-in-components': require('./rules/order-in-components'),
'padding-line-between-blocks': require('./rules/padding-line-between-blocks'),
'prefer-template': require('./rules/prefer-template'),
'prop-name-casing': require('./rules/prop-name-casing'),
'require-component-is': require('./rules/require-component-is'),
'require-default-prop': require('./rules/require-default-prop'),
Expand Down
11 changes: 11 additions & 0 deletions lib/rules/prefer-template.js
@@ -0,0 +1,11 @@
/**
* @author Yosuke Ota
*/
'use strict'

const { wrapCoreRule } = require('../utils')

// eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
module.exports = wrapCoreRule(
require('eslint/lib/rules/prefer-template')
)
63 changes: 63 additions & 0 deletions tests/lib/rules/prefer-template.js
@@ -0,0 +1,63 @@
/**
* @author Yosuke Ota
*/
'use strict'

const RuleTester = require('eslint').RuleTester
const rule = require('../../../lib/rules/prefer-template')

const tester = new RuleTester({
parser: require.resolve('vue-eslint-parser'),
parserOptions: { ecmaVersion: 2020 }
})

tester.run('prefer-template', rule, {
valid: [
`
<template>
<div :class="[\`foo-\${bar}\`]" />
</template>
`,
`
<template>
<div :[\`foo\${bar}\`]="value" />
</template>
`
],
invalid: [
{
code: `
<template>
<div :class="['foo-' + bar]" />
</template>
`,
output: `
<template>
<div :class="[\`foo-\${ bar}\`]" />
</template>
`,
errors: [
{
message: 'Unexpected string concatenation.',
line: 3
}
]
},
{
code: `
<template>
<div :['foo'+bar]="value" />
</template>`,
output: `
<template>
<div :[\`foo\${bar}\`]="value" />
</template>`,
errors: [
{
message: 'Unexpected string concatenation.',
line: 3
}
]
}
]
})