Skip to content

Commit 86a104a

Browse files
committed
Move to scoped package
1 parent fb40b9a commit 86a104a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+214
-214
lines changed

README.md

Lines changed: 63 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You can try this plugin on the Web.
2020
## :cd: Installation
2121

2222
```bash
23-
npm install --save-dev eslint eslint-plugin-vue
23+
npm install --save-dev eslint @vue/eslint-plugin
2424
```
2525

2626
## :rocket: Usage
@@ -34,11 +34,11 @@ module.exports = {
3434
extends: [
3535
// add more generic rulesets here, such as:
3636
// 'eslint:recommended',
37-
'plugin:vue/essential'
37+
'plugin:@vue/essential'
3838
],
3939
rules: {
4040
// override/add rules settings here, such as:
41-
// 'vue/no-unused-vars': 'error'
41+
// '@vue/no-unused-vars': 'error'
4242
}
4343
}
4444
```
@@ -88,10 +88,10 @@ If you want to disallow `eslint-disable` functionality, please disable [vue/comm
8888
## :gear: Configs
8989

9090
This plugin provides two predefined configs:
91-
- `plugin:vue/base` - Settings and rules to enable correct ESLint parsing
92-
- `plugin:vue/essential` - Above, plus rules to prevent errors or unintended behavior
93-
- `plugin:vue/strongly-recommended` - Above, plus rules to considerably improve code readability and/or dev experience
94-
- `plugin:vue/recommended` - Above, plus rules to enforce subjective community defaults to ensure consistency
91+
- `plugin:@vue/base` - Settings and rules to enable correct ESLint parsing
92+
- `plugin:@vue/essential` - Above, plus rules to prevent errors or unintended behavior
93+
- `plugin:@vue/strongly-recommended` - Above, plus rules to considerably improve code readability and/or dev experience
94+
- `plugin:@vue/recommended` - Above, plus rules to enforce subjective community defaults to ensure consistency
9595

9696
## :bulb: Rules
9797

@@ -105,106 +105,106 @@ Enforce all the rules in this category, as well as all higher priority rules, wi
105105

106106
```json
107107
{
108-
"extends": "plugin:vue/base"
108+
"extends": "plugin:@vue/base"
109109
}
110110
```
111111

112112
| | Rule ID | Description |
113113
|:---|:--------|:------------|
114-
| | [vue/comment-directive](./docs/rules/comment-directive.md) | support comment-directives in `<template>` |
115-
| | [vue/jsx-uses-vars](./docs/rules/jsx-uses-vars.md) | prevent variables used in JSX to be marked as unused |
114+
| | [@vue/comment-directive](./docs/rules/comment-directive.md) | support comment-directives in `<template>` |
115+
| | [@vue/jsx-uses-vars](./docs/rules/jsx-uses-vars.md) | prevent variables used in JSX to be marked as unused |
116116

117117
### Priority A: Essential (Error Prevention)
118118

119119
Enforce all the rules in this category, as well as all higher priority rules, with:
120120

121121
```json
122122
{
123-
"extends": "plugin:vue/essential"
123+
"extends": "plugin:@vue/essential"
124124
}
125125
```
126126

127127
| | Rule ID | Description |
128128
|:---|:--------|:------------|
129-
| | [vue/no-async-in-computed-properties](./docs/rules/no-async-in-computed-properties.md) | disallow asynchronous actions in computed properties |
130-
| | [vue/no-dupe-keys](./docs/rules/no-dupe-keys.md) | disallow duplication of field names |
131-
| | [vue/no-duplicate-attributes](./docs/rules/no-duplicate-attributes.md) | disallow duplication of attributes |
132-
| | [vue/no-parsing-error](./docs/rules/no-parsing-error.md) | disallow parsing errors in `<template>` |
133-
| | [vue/no-reserved-keys](./docs/rules/no-reserved-keys.md) | disallow overwriting reserved keys |
134-
| :wrench: | [vue/no-shared-component-data](./docs/rules/no-shared-component-data.md) | enforce component's data property to be a function |
135-
| | [vue/no-side-effects-in-computed-properties](./docs/rules/no-side-effects-in-computed-properties.md) | disallow side effects in computed properties |
136-
| | [vue/no-template-key](./docs/rules/no-template-key.md) | disallow `key` attribute on `<template>` |
137-
| | [vue/no-textarea-mustache](./docs/rules/no-textarea-mustache.md) | disallow mustaches in `<textarea>` |
138-
| | [vue/no-unused-vars](./docs/rules/no-unused-vars.md) | disallow unused variable definitions of v-for directives or scope attributes |
139-
| | [vue/require-component-is](./docs/rules/require-component-is.md) | require `v-bind:is` of `<component>` elements |
140-
| | [vue/require-render-return](./docs/rules/require-render-return.md) | enforce render function to always return value |
141-
| | [vue/require-v-for-key](./docs/rules/require-v-for-key.md) | require `v-bind:key` with `v-for` directives |
142-
| | [vue/require-valid-default-prop](./docs/rules/require-valid-default-prop.md) | enforce props default values to be valid |
143-
| | [vue/return-in-computed-property](./docs/rules/return-in-computed-property.md) | enforce that a return statement is present in computed property |
144-
| | [vue/valid-template-root](./docs/rules/valid-template-root.md) | enforce valid template root |
145-
| | [vue/valid-v-bind](./docs/rules/valid-v-bind.md) | enforce valid `v-bind` directives |
146-
| | [vue/valid-v-cloak](./docs/rules/valid-v-cloak.md) | enforce valid `v-cloak` directives |
147-
| | [vue/valid-v-else-if](./docs/rules/valid-v-else-if.md) | enforce valid `v-else-if` directives |
148-
| | [vue/valid-v-else](./docs/rules/valid-v-else.md) | enforce valid `v-else` directives |
149-
| | [vue/valid-v-for](./docs/rules/valid-v-for.md) | enforce valid `v-for` directives |
150-
| | [vue/valid-v-html](./docs/rules/valid-v-html.md) | enforce valid `v-html` directives |
151-
| | [vue/valid-v-if](./docs/rules/valid-v-if.md) | enforce valid `v-if` directives |
152-
| | [vue/valid-v-model](./docs/rules/valid-v-model.md) | enforce valid `v-model` directives |
153-
| | [vue/valid-v-on](./docs/rules/valid-v-on.md) | enforce valid `v-on` directives |
154-
| | [vue/valid-v-once](./docs/rules/valid-v-once.md) | enforce valid `v-once` directives |
155-
| | [vue/valid-v-pre](./docs/rules/valid-v-pre.md) | enforce valid `v-pre` directives |
156-
| | [vue/valid-v-show](./docs/rules/valid-v-show.md) | enforce valid `v-show` directives |
157-
| | [vue/valid-v-text](./docs/rules/valid-v-text.md) | enforce valid `v-text` directives |
129+
| | [@vue/no-async-in-computed-properties](./docs/rules/no-async-in-computed-properties.md) | disallow asynchronous actions in computed properties |
130+
| | [@vue/no-dupe-keys](./docs/rules/no-dupe-keys.md) | disallow duplication of field names |
131+
| | [@vue/no-duplicate-attributes](./docs/rules/no-duplicate-attributes.md) | disallow duplication of attributes |
132+
| | [@vue/no-parsing-error](./docs/rules/no-parsing-error.md) | disallow parsing errors in `<template>` |
133+
| | [@vue/no-reserved-keys](./docs/rules/no-reserved-keys.md) | disallow overwriting reserved keys |
134+
| :wrench: | [@vue/no-shared-component-data](./docs/rules/no-shared-component-data.md) | enforce component's data property to be a function |
135+
| | [@vue/no-side-effects-in-computed-properties](./docs/rules/no-side-effects-in-computed-properties.md) | disallow side effects in computed properties |
136+
| | [@vue/no-template-key](./docs/rules/no-template-key.md) | disallow `key` attribute on `<template>` |
137+
| | [@vue/no-textarea-mustache](./docs/rules/no-textarea-mustache.md) | disallow mustaches in `<textarea>` |
138+
| | [@vue/no-unused-vars](./docs/rules/no-unused-vars.md) | disallow unused variable definitions of v-for directives or scope attributes |
139+
| | [@vue/require-component-is](./docs/rules/require-component-is.md) | require `v-bind:is` of `<component>` elements |
140+
| | [@vue/require-render-return](./docs/rules/require-render-return.md) | enforce render function to always return value |
141+
| | [@vue/require-v-for-key](./docs/rules/require-v-for-key.md) | require `v-bind:key` with `v-for` directives |
142+
| | [@vue/require-valid-default-prop](./docs/rules/require-valid-default-prop.md) | enforce props default values to be valid |
143+
| | [@vue/return-in-computed-property](./docs/rules/return-in-computed-property.md) | enforce that a return statement is present in computed property |
144+
| | [@vue/valid-template-root](./docs/rules/valid-template-root.md) | enforce valid template root |
145+
| | [@vue/valid-v-bind](./docs/rules/valid-v-bind.md) | enforce valid `v-bind` directives |
146+
| | [@vue/valid-v-cloak](./docs/rules/valid-v-cloak.md) | enforce valid `v-cloak` directives |
147+
| | [@vue/valid-v-else-if](./docs/rules/valid-v-else-if.md) | enforce valid `v-else-if` directives |
148+
| | [@vue/valid-v-else](./docs/rules/valid-v-else.md) | enforce valid `v-else` directives |
149+
| | [@vue/valid-v-for](./docs/rules/valid-v-for.md) | enforce valid `v-for` directives |
150+
| | [@vue/valid-v-html](./docs/rules/valid-v-html.md) | enforce valid `v-html` directives |
151+
| | [@vue/valid-v-if](./docs/rules/valid-v-if.md) | enforce valid `v-if` directives |
152+
| | [@vue/valid-v-model](./docs/rules/valid-v-model.md) | enforce valid `v-model` directives |
153+
| | [@vue/valid-v-on](./docs/rules/valid-v-on.md) | enforce valid `v-on` directives |
154+
| | [@vue/valid-v-once](./docs/rules/valid-v-once.md) | enforce valid `v-once` directives |
155+
| | [@vue/valid-v-pre](./docs/rules/valid-v-pre.md) | enforce valid `v-pre` directives |
156+
| | [@vue/valid-v-show](./docs/rules/valid-v-show.md) | enforce valid `v-show` directives |
157+
| | [@vue/valid-v-text](./docs/rules/valid-v-text.md) | enforce valid `v-text` directives |
158158

159159
### Priority B: Strongly Recommended (Improving Readability)
160160

161161
Enforce all the rules in this category, as well as all higher priority rules, with:
162162

163163
```json
164164
{
165-
"extends": "plugin:vue/strongly-recommended"
165+
"extends": "plugin:@vue/strongly-recommended"
166166
}
167167
```
168168

169169
| | Rule ID | Description |
170170
|:---|:--------|:------------|
171-
| :wrench: | [vue/attribute-hyphenation](./docs/rules/attribute-hyphenation.md) | enforce attribute naming style in template |
172-
| :wrench: | [vue/html-end-tags](./docs/rules/html-end-tags.md) | enforce end tag style |
173-
| :wrench: | [vue/html-indent](./docs/rules/html-indent.md) | enforce consistent indentation in `<template>` |
174-
| :wrench: | [vue/html-self-closing](./docs/rules/html-self-closing.md) | enforce self-closing style |
175-
| | [vue/max-attributes-per-line](./docs/rules/max-attributes-per-line.md) | enforce the maximum number of attributes per line |
176-
| :wrench: | [vue/mustache-interpolation-spacing](./docs/rules/mustache-interpolation-spacing.md) | enforce unified spacing in mustache interpolations |
177-
| :wrench: | [vue/name-property-casing](./docs/rules/name-property-casing.md) | enforce specific casing for the name property in Vue components |
178-
| :wrench: | [vue/no-multi-spaces](./docs/rules/no-multi-spaces.md) | disallow multiple spaces |
179-
| | [vue/require-default-prop](./docs/rules/require-default-prop.md) | require default value for props |
180-
| | [vue/require-prop-types](./docs/rules/require-prop-types.md) | require type definitions in props |
181-
| :wrench: | [vue/v-bind-style](./docs/rules/v-bind-style.md) | enforce `v-bind` directive style |
182-
| :wrench: | [vue/v-on-style](./docs/rules/v-on-style.md) | enforce `v-on` directive style |
171+
| :wrench: | [@vue/attribute-hyphenation](./docs/rules/attribute-hyphenation.md) | enforce attribute naming style in template |
172+
| :wrench: | [@vue/html-end-tags](./docs/rules/html-end-tags.md) | enforce end tag style |
173+
| :wrench: | [@vue/html-indent](./docs/rules/html-indent.md) | enforce consistent indentation in `<template>` |
174+
| :wrench: | [@vue/html-self-closing](./docs/rules/html-self-closing.md) | enforce self-closing style |
175+
| | [@vue/max-attributes-per-line](./docs/rules/max-attributes-per-line.md) | enforce the maximum number of attributes per line |
176+
| :wrench: | [@vue/mustache-interpolation-spacing](./docs/rules/mustache-interpolation-spacing.md) | enforce unified spacing in mustache interpolations |
177+
| :wrench: | [@vue/name-property-casing](./docs/rules/name-property-casing.md) | enforce specific casing for the name property in Vue components |
178+
| :wrench: | [@vue/no-multi-spaces](./docs/rules/no-multi-spaces.md) | disallow multiple spaces |
179+
| | [@vue/require-default-prop](./docs/rules/require-default-prop.md) | require default value for props |
180+
| | [@vue/require-prop-types](./docs/rules/require-prop-types.md) | require type definitions in props |
181+
| :wrench: | [@vue/v-bind-style](./docs/rules/v-bind-style.md) | enforce `v-bind` directive style |
182+
| :wrench: | [@vue/v-on-style](./docs/rules/v-on-style.md) | enforce `v-on` directive style |
183183

184184
### Priority C: Recommended (Minimizing Arbitrary Choices and Cognitive Overhead)
185185

186186
Enforce all the rules in this category, as well as all higher priority rules, with:
187187

188188
```json
189189
{
190-
"extends": "plugin:vue/recommended"
190+
"extends": "plugin:@vue/recommended"
191191
}
192192
```
193193

194194
| | Rule ID | Description |
195195
|:---|:--------|:------------|
196-
| :wrench: | [vue/html-quotes](./docs/rules/html-quotes.md) | enforce quotes style of HTML attributes |
197-
| | [vue/no-confusing-v-for-v-if](./docs/rules/no-confusing-v-for-v-if.md) | disallow confusing `v-for` and `v-if` on the same element |
198-
| | [vue/order-in-components](./docs/rules/order-in-components.md) | enforce order of properties in components |
199-
| | [vue/this-in-template](./docs/rules/this-in-template.md) | enforce usage of `this` in template |
196+
| :wrench: | [@vue/html-quotes](./docs/rules/html-quotes.md) | enforce quotes style of HTML attributes |
197+
| | [@vue/no-confusing-v-for-v-if](./docs/rules/no-confusing-v-for-v-if.md) | disallow confusing `v-for` and `v-if` on the same element |
198+
| | [@vue/order-in-components](./docs/rules/order-in-components.md) | enforce order of properties in components |
199+
| | [@vue/this-in-template](./docs/rules/this-in-template.md) | enforce usage of `this` in template |
200200

201201
### Uncategorized
202202

203203
| | Rule ID | Description |
204204
|:---|:--------|:------------|
205-
| :wrench: | [vue/html-closing-bracket-newline](./docs/rules/html-closing-bracket-newline.md) | require or disallow a line break before tag's closing brackets |
206-
| :wrench: | [vue/html-closing-bracket-spacing](./docs/rules/html-closing-bracket-spacing.md) | require or disallow a space before tag's closing brackets |
207-
| :wrench: | [vue/script-indent](./docs/rules/script-indent.md) | enforce consistent indentation in `<script>` |
205+
| :wrench: | [@vue/html-closing-bracket-newline](./docs/rules/html-closing-bracket-newline.md) | require or disallow a line break before tag's closing brackets |
206+
| :wrench: | [@vue/html-closing-bracket-spacing](./docs/rules/html-closing-bracket-spacing.md) | require or disallow a space before tag's closing brackets |
207+
| :wrench: | [@vue/script-indent](./docs/rules/script-indent.md) | enforce consistent indentation in `<script>` |
208208

209209
<!--RULES_TABLE_END-->
210210

@@ -216,8 +216,8 @@ The most rules of `eslint-plugin-vue` require `vue-eslint-parser` to check `<tem
216216

217217
Make sure you have one of the following settings in your **.eslintrc**:
218218

219-
- `"extends": ["plugin:vue/recommended"]`
220-
- `"extends": ["plugin:vue/base"]`
219+
- `"extends": ["plugin:@vue/recommended"]`
220+
- `"extends": ["plugin:@vue/base"]`
221221

222222
If you already use other parser (e.g. `"parser": "babel-eslint"`), please move it into `parserOptions`, so it doesn't collide with the `vue-eslint-parser` used by this plugin's configuration:
223223

docs/rules/attribute-hyphenation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# enforce attribute naming style in template (vue/attribute-hyphenation)
1+
# enforce attribute naming style in template (@vue/attribute-hyphenation)
22

3-
- :gear: This rule is included in `"plugin:vue/strongly-recommended"` and `"plugin:vue/recommended"`.
3+
- :gear: This rule is included in `"plugin:@vue/strongly-recommended"` and `"plugin:@vue/recommended"`.
44
- :wrench: The `--fix` option on the [command line](http://eslint.org/docs/user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.
55

66
## :wrench: Options

docs/rules/comment-directive.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# support comment-directives in `<template>` (vue/comment-directive)
1+
# support comment-directives in `<template>` (@vue/comment-directive)
22

3-
- :gear: This rule is included in all of `"plugin:vue/base"`, `"plugin:vue/essential"`, `"plugin:vue/strongly-recommended"` and `"plugin:vue/recommended"`.
3+
- :gear: This rule is included in all of `"plugin:@vue/base"`, `"plugin:@vue/essential"`, `"plugin:@vue/strongly-recommended"` and `"plugin:@vue/recommended"`.
44

55
Sole purpose of this rule is to provide `eslint-disable` functionality in `<template>`.
66
It supports usage of the following comments:

docs/rules/html-closing-bracket-newline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# require or disallow a line break before tag's closing brackets (vue/html-closing-bracket-newline)
1+
# require or disallow a line break before tag's closing brackets (@vue/html-closing-bracket-newline)
22

33
- :wrench: The `--fix` option on the [command line](http://eslint.org/docs/user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.
44

docs/rules/html-closing-bracket-spacing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# require or disallow a space before tag's closing brackets (vue/html-closing-bracket-spacing)
1+
# require or disallow a space before tag's closing brackets (@vue/html-closing-bracket-spacing)
22

33
- :wrench: The `--fix` option on the [command line](http://eslint.org/docs/user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.
44

docs/rules/html-end-tags.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# enforce end tag style (vue/html-end-tags)
1+
# enforce end tag style (@vue/html-end-tags)
22

3-
- :gear: This rule is included in `"plugin:vue/strongly-recommended"` and `"plugin:vue/recommended"`.
3+
- :gear: This rule is included in `"plugin:@vue/strongly-recommended"` and `"plugin:@vue/recommended"`.
44
- :wrench: The `--fix` option on the [command line](http://eslint.org/docs/user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.
55

66
## :book: Rule Details

docs/rules/html-indent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# enforce consistent indentation in `<template>` (vue/html-indent)
1+
# enforce consistent indentation in `<template>` (@vue/html-indent)
22

3-
- :gear: This rule is included in `"plugin:vue/strongly-recommended"` and `"plugin:vue/recommended"`.
3+
- :gear: This rule is included in `"plugin:@vue/strongly-recommended"` and `"plugin:@vue/recommended"`.
44
- :wrench: The `--fix` option on the [command line](http://eslint.org/docs/user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.
55

66
## :book: Rule Details

docs/rules/html-quotes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# enforce quotes style of HTML attributes (vue/html-quotes)
1+
# enforce quotes style of HTML attributes (@vue/html-quotes)
22

3-
- :gear: This rule is included in `"plugin:vue/recommended"`.
3+
- :gear: This rule is included in `"plugin:@vue/recommended"`.
44
- :wrench: The `--fix` option on the [command line](http://eslint.org/docs/user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.
55

66
You can choose quotes of HTML attributes from:

docs/rules/html-self-closing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# enforce self-closing style (vue/html-self-closing)
1+
# enforce self-closing style (@vue/html-self-closing)
22

3-
- :gear: This rule is included in `"plugin:vue/strongly-recommended"` and `"plugin:vue/recommended"`.
3+
- :gear: This rule is included in `"plugin:@vue/strongly-recommended"` and `"plugin:@vue/recommended"`.
44
- :wrench: The `--fix` option on the [command line](http://eslint.org/docs/user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.
55

66
In Vue.js template, we can use either two styles for elements which don't have their content.

docs/rules/jsx-uses-vars.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# prevent variables used in JSX to be marked as unused (vue/jsx-uses-vars)
1+
# prevent variables used in JSX to be marked as unused (@vue/jsx-uses-vars)
22

3-
- :gear: This rule is included in all of `"plugin:vue/base"`, `"plugin:vue/essential"`, `"plugin:vue/strongly-recommended"` and `"plugin:vue/recommended"`.
3+
- :gear: This rule is included in all of `"plugin:@vue/base"`, `"plugin:@vue/essential"`, `"plugin:@vue/strongly-recommended"` and `"plugin:@vue/recommended"`.
44

55
Since 0.17.0 the ESLint `no-unused-vars` rule does not detect variables used in JSX ([see details](http://eslint.org/blog/2015/03/eslint-0.17.0-released#changes-to-jsxreact-handling)).
66
This rule will find variables used in JSX and mark them as used.

0 commit comments

Comments
 (0)