Skip to content

Commit 8d7cadf

Browse files
authored
Change document style for new rules added & Fixed new rule test cases to work with eslint v6 (#1011)
1 parent b19843c commit 8d7cadf

6 files changed

+41
-12
lines changed

docs/rules/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,11 @@ For example:
154154
| [vue/no-boolean-default](./no-boolean-default.md) | disallow boolean defaults | :wrench: |
155155
| [vue/no-deprecated-scope-attribute](./no-deprecated-scope-attribute.md) | disallow deprecated `scope` attribute (in Vue.js 2.5.0+) | :wrench: |
156156
| [vue/no-empty-pattern](./no-empty-pattern.md) | disallow empty destructuring patterns | |
157+
| [vue/no-reserved-component-names](./no-reserved-component-names.md) | disallow the use of reserved names in component definitions | |
157158
| [vue/no-restricted-syntax](./no-restricted-syntax.md) | disallow specified syntax | |
158159
| [vue/object-curly-spacing](./object-curly-spacing.md) | enforce consistent spacing inside braces | :wrench: |
159160
| [vue/require-direct-export](./require-direct-export.md) | require the component to be directly exported | |
161+
| [vue/require-name-property](./require-name-property.md) | require a name property in Vue components | |
160162
| [vue/script-indent](./script-indent.md) | enforce consistent indentation in `<script>` | :wrench: |
161163
| [vue/space-infix-ops](./space-infix-ops.md) | require spacing around infix operators | :wrench: |
162164
| [vue/space-unary-ops](./space-unary-ops.md) | enforce consistent spacing before or after unary operators | :wrench: |

docs/rules/no-reserved-component-names.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
---
2+
pageClass: rule-details
3+
sidebarDepth: 0
4+
title: vue/no-reserved-component-names
5+
description: disallow the use of reserved names in component definitions
6+
---
17
# vue/no-reserved-component-names
28
> disallow the use of reserved names in component definitions
39
4-
- :gear: This rule is included in all of `"plugin:vue/essential"`, `"plugin:vue/recommended"`, and `"plugin:vue/strongly-recommended"`.
5-
610
## :book: Rule Details
711

812
This rule prevents name collisions between vue components and standard html elements.
@@ -25,4 +29,9 @@ export default {
2529
- [List of html elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element)
2630
- [List of SVG elements](https://developer.mozilla.org/en-US/docs/Web/SVG/Element)
2731
- [Kebab case elements](https://stackoverflow.com/questions/22545621/do-custom-elements-require-a-dash-in-their-name/22545622#22545622)
28-
- [Valid custom element name](https://w3c.github.io/webcomponents/spec/custom/#valid-custom-element-name)
32+
- [Valid custom element name](https://w3c.github.io/webcomponents/spec/custom/#valid-custom-element-name)
33+
34+
## :mag: Implementation
35+
36+
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-reserved-component-names.js)
37+
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-reserved-component-names.js)

docs/rules/require-name-property.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/require-name-property
5-
description: require a component name property
5+
description: require a name property in Vue components
66
---
77
# vue/require-name-property
8-
> require a component name property
8+
> require a name property in Vue components
99
1010
## :book: Rule Details
1111

@@ -19,11 +19,27 @@ This rule requires a `name` property to be set on components.
1919
export default {
2020
name: 'OurButton'
2121
}
22+
</script>
23+
```
24+
25+
</eslint-code-block>
2226

27+
<eslint-code-block :rules="{'vue/require-name-property': ['error']}">
28+
29+
```vue
30+
<script>
2331
/* ✗ BAD */
2432
export default {
2533
}
34+
</script>
35+
```
36+
37+
</eslint-code-block>
2638

39+
<eslint-code-block :rules="{'vue/require-name-property': ['error']}">
40+
41+
```vue
42+
<script>
2743
/* ✗ BAD */
2844
export default {
2945
notName: 'OurButton'

docs/rules/static-class-names-order.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ description: enforce static class names order
99
1010
- :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.
1111

12-
### Example
12+
## :book: Rule Details
13+
14+
This rule aims to enforce the order of static class names.
1315

1416
<eslint-code-block fix :rules="{'vue/static-class-names-order': ['error']}">
1517

@@ -25,11 +27,9 @@ description: enforce static class names order
2527

2628
</eslint-code-block>
2729

28-
## :books: Further reading
29-
30-
- [static-class-names-order]
30+
## :wrench: Options
3131

32-
[static-class-names-order]: https://eslint.org/docs/rules/static-class-names-order
32+
Nothing.
3333

3434
## :mag: Implementation
3535

lib/index.js

+2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ module.exports = {
4242
'no-empty-pattern': require('./rules/no-empty-pattern'),
4343
'no-multi-spaces': require('./rules/no-multi-spaces'),
4444
'no-parsing-error': require('./rules/no-parsing-error'),
45+
'no-reserved-component-names': require('./rules/no-reserved-component-names'),
4546
'no-reserved-keys': require('./rules/no-reserved-keys'),
4647
'no-restricted-syntax': require('./rules/no-restricted-syntax'),
4748
'no-shared-component-data': require('./rules/no-shared-component-data'),
@@ -60,6 +61,7 @@ module.exports = {
6061
'require-component-is': require('./rules/require-component-is'),
6162
'require-default-prop': require('./rules/require-default-prop'),
6263
'require-direct-export': require('./rules/require-direct-export'),
64+
'require-name-property': require('./rules/require-name-property'),
6365
'require-prop-type-constructor': require('./rules/require-prop-type-constructor'),
6466
'require-prop-types': require('./rules/require-prop-types'),
6567
'require-render-return': require('./rules/require-render-return'),

tests/lib/rules/no-reserved-component-names.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ ruleTester.run('no-reserved-component-names', rule, {
297297
}
298298
</script>
299299
`,
300-
parser: 'vue-eslint-parser',
300+
parser: require.resolve('vue-eslint-parser'),
301301
parserOptions
302302
},
303303
{
@@ -309,7 +309,7 @@ ruleTester.run('no-reserved-component-names', rule, {
309309
}
310310
</script>
311311
`,
312-
parser: 'vue-eslint-parser',
312+
parser: require.resolve('vue-eslint-parser'),
313313
parserOptions
314314
}
315315
],

0 commit comments

Comments
 (0)