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 extension rule vue/quotes #2463

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/rules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,7 @@ The following rules extend the rules provided by ESLint itself and apply them to
| [vue/operator-linebreak](./operator-linebreak.md) | Enforce consistent linebreak style for operators in `<template>` | :wrench: | :lipstick: |
| [vue/prefer-template](./prefer-template.md) | Require template literals instead of string concatenation in `<template>` | :wrench: | :hammer: |
| [vue/quote-props](./quote-props.md) | Require quotes around object literal property names in `<template>` | :wrench: | :lipstick: |
| [vue/quotes](./quotes.md) | Enforce the consistent use of either backticks, double, or single quotes in `<template>` | :wrench: | :lipstick: |
| [vue/space-in-parens](./space-in-parens.md) | Enforce consistent spacing inside parentheses in `<template>` | :wrench: | :lipstick: |
| [vue/space-infix-ops](./space-infix-ops.md) | Require spacing around infix operators in `<template>` | :wrench: | :lipstick: |
| [vue/space-unary-ops](./space-unary-ops.md) | Enforce consistent spacing before or after unary operators in `<template>` | :wrench: | :lipstick: |
Expand Down
28 changes: 28 additions & 0 deletions docs/rules/quotes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
pageClass: rule-details
sidebarDepth: 0
title: vue/quotes
description: Enforce the consistent use of either backticks, double, or single quotes in `<template>`
---

# vue/quotes

> Enforce the consistent use of either backticks, double, or single quotes in `<template>`

- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> _**This rule has not been released yet.**_ </badge>
- :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 stylistic [quotes] rule but it applies to the expressions in `<template>`.

## :book: Rule Details

- [quotes]

[quotes]: https://eslint.style/rules/js/quotes

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/quotes.js)
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/quotes.js)

<sup>Taken with ❤️ [from ESLint Stylistic](https://eslint.style/rules/ts/quotes)</sup>
1 change: 1 addition & 0 deletions lib/configs/no-layout-rules.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ module.exports = {
'vue/padding-line-between-tags': 'off',
'vue/padding-lines-in-component-definition': 'off',
'vue/quote-props': 'off',
'vue/quotes': 'off',
'vue/script-indent': 'off',
'vue/singleline-html-element-content-newline': 'off',
'vue/space-in-parens': 'off',
Expand Down
1 change: 1 addition & 0 deletions lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,7 @@
'prefer-true-attribute-shorthand': require('./rules/prefer-true-attribute-shorthand'),
'prop-name-casing': require('./rules/prop-name-casing'),
'quote-props': require('./rules/quote-props'),
quotes: require('./rules/quotes'),
'require-component-is': require('./rules/require-component-is'),
'require-default-prop': require('./rules/require-default-prop'),
'require-direct-export': require('./rules/require-direct-export'),
Expand Down Expand Up @@ -277,7 +278,7 @@
vue: require('./processor')
},
environments: {
// TODO Remove in the next major version

Check warning on line 281 in lib/index.js

View workflow job for this annotation

GitHub Actions / Lint

Unexpected 'todo' comment: 'TODO Remove in the next major version'
/** @deprecated */
'setup-compiler-macros': {
globals: {
Expand Down
10 changes: 10 additions & 0 deletions lib/rules/quotes.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/**
* @author Nhan Nguyen
* See LICENSE file in root directory for full license.
*/
'use strict'

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

// eslint-disable-next-line internal/no-invalid-meta
module.exports = wrapStylisticOrCoreRule('quotes')
113 changes: 113 additions & 0 deletions tests/lib/rules/quotes.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
/**
* @author Nhan Nguyen
* See LICENSE file in root directory for full license.
*/
'use strict'

const RuleTester = require('../../eslint-compat').RuleTester
const rule = require('../../../lib/rules/quotes')

const tester = new RuleTester({
languageOptions: {
parser: require('vue-eslint-parser'),
ecmaVersion: 2020,
sourceType: 'module'
}
})

tester.run('quotes', rule, {
valid: [
`<template>
<div>{{ "hello" }}</div>
</template>`,
`<template>
<div>'This string contains "single" quotes'</div>
</template>`,
{
code: `
<template>
<div>{{ 'hello' }}</div>
</template>`,
options: ['single']
},
{
code: `
<template>
<div>{{ \`hello\` }}</div>
</template>`,
options: ['backtick']
},
{
code: `
<template>
<div>"This string contains 'single' quotes"</div>
</template>`,
options: ['single', { avoidEscape: true }]
},
{
code: `
<template>
<div>'This string contains "double" quotes'</div>
</template>`,
options: ['double', { avoidEscape: true }]
}
],
invalid: [
{
code: `
<template>
<div>{{ 'hello' }}</div>
</template>
`,
output: `
<template>
<div>{{ "hello" }}</div>
</template>
`,
errors: [
{
message: 'Strings must use doublequote.',
line: 3
}
]
},
{
code: `
<template>
<div>{{ "hello" }}</div>
</template>
`,
output: `
<template>
<div>{{ 'hello' }}</div>
</template>
`,
options: ['single'],
errors: [
{
message: 'Strings must use singlequote.',
line: 3
}
]
},
{
code: `
<template>
<div>{{ 'hello' }}</div>
</template>
`,
output: `
<template>
<div>{{ \`hello\` }}</div>
</template>
`,
options: ['backtick'],
errors: [
{
message: 'Strings must use backtick.',
line: 3
}
]
}
]
})
Loading