Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 1cec36d

Browse files
committed
⭐️New: Add vue/block-spacing rule
1 parent 9c49dcc commit 1cec36d

File tree

6 files changed

+115
-0
lines changed

6 files changed

+115
-0
lines changed

docs/rules/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ For example:
140140
| Rule ID | Description | |
141141
|:--------|:------------|:---|
142142
| [vue/array-bracket-spacing](./array-bracket-spacing.md) | enforce consistent spacing inside array brackets | :wrench: |
143+
| [vue/block-spacing](./block-spacing.md) | disallow or enforce spaces inside of blocks after opening block and before closing block | :wrench: |
143144
| [vue/component-name-in-template-casing](./component-name-in-template-casing.md) | enforce specific casing for the component naming style in template | :wrench: |
144145
| [vue/eqeqeq](./eqeqeq.md) | require the use of `===` and `!==` | :wrench: |
145146
| [vue/key-spacing](./key-spacing.md) | enforce consistent spacing between keys and values in object literal properties | :wrench: |

docs/rules/block-spacing.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
pageClass: rule-details
3+
sidebarDepth: 0
4+
title: vue/block-spacing
5+
description: disallow or enforce spaces inside of blocks after opening block and before closing block
6+
---
7+
# vue/block-spacing
8+
> disallow or enforce spaces inside of blocks after opening block and before closing block
9+
10+
- :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.
11+
12+
This rule is the same rule as core [block-spacing] rule but it applies to the expressions in `<template>`.
13+
14+
## :books: Further reading
15+
16+
- [block-spacing]
17+
18+
[block-spacing]: https://eslint.org/docs/rules/block-spacing
19+
20+
## :mag: Implementation
21+
22+
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/block-spacing.js)
23+
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/block-spacing.js)

lib/configs/no-layout-rules.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
module.exports = {
77
rules: {
88
'vue/array-bracket-spacing': 'off',
9+
'vue/block-spacing': 'off',
910
'vue/html-closing-bracket-newline': 'off',
1011
'vue/html-closing-bracket-spacing': 'off',
1112
'vue/html-indent': 'off',

lib/index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ module.exports = {
1010
'array-bracket-spacing': require('./rules/array-bracket-spacing'),
1111
'attribute-hyphenation': require('./rules/attribute-hyphenation'),
1212
'attributes-order': require('./rules/attributes-order'),
13+
'block-spacing': require('./rules/block-spacing'),
1314
'comment-directive': require('./rules/comment-directive'),
1415
'component-name-in-template-casing': require('./rules/component-name-in-template-casing'),
1516
'eqeqeq': require('./rules/eqeqeq'),

lib/rules/block-spacing.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/**
2+
* @author Yosuke Ota
3+
*/
4+
'use strict'
5+
6+
const { wrapCoreRule } = require('../utils')
7+
8+
// eslint-disable-next-line
9+
module.exports = wrapCoreRule(require('eslint/lib/rules/block-spacing'))

tests/lib/rules/block-spacing.js

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
/**
2+
* @author Yosuke Ota
3+
*/
4+
'use strict'
5+
6+
const RuleTester = require('eslint').RuleTester
7+
const rule = require('../../../lib/rules/block-spacing')
8+
9+
const tester = new RuleTester({
10+
parser: 'vue-eslint-parser',
11+
parserOptions: { ecmaVersion: 2015 }
12+
})
13+
14+
tester.run('block-spacing', rule, {
15+
valid: [
16+
'<template><div :attr="function foo() { return true; }" /></template>'
17+
],
18+
invalid: [
19+
{
20+
code: `
21+
<template>
22+
<div :attr="function foo() {return true;}" />
23+
</template>`,
24+
output: `
25+
<template>
26+
<div :attr="function foo() { return true; }" />
27+
</template>`,
28+
errors: [
29+
{
30+
messageId: 'missing',
31+
data: {
32+
location: 'after',
33+
token: '{'
34+
},
35+
// message: 'Requires a space after \'{\'',
36+
line: 3
37+
},
38+
{
39+
messageId: 'missing',
40+
data: {
41+
location: 'before',
42+
token: '}'
43+
},
44+
// message: 'Requires a space before \'}\'',
45+
line: 3
46+
}
47+
]
48+
},
49+
{
50+
code: `
51+
<template>
52+
<button @click="() => {return true;}" />
53+
</template>`,
54+
output: `
55+
<template>
56+
<button @click="() => { return true; }" />
57+
</template>`,
58+
errors: [
59+
{
60+
messageId: 'missing',
61+
data: {
62+
location: 'after',
63+
token: '{'
64+
},
65+
// message: 'Requires a space after \'{\'',
66+
line: 3
67+
},
68+
{
69+
messageId: 'missing',
70+
data: {
71+
location: 'before',
72+
token: '}'
73+
},
74+
// message: 'Requires a space before \'}\'',
75+
line: 3
76+
}
77+
]
78+
}
79+
]
80+
})

0 commit comments

Comments
 (0)