File tree Expand file tree Collapse file tree 2 files changed +36
-31
lines changed Expand file tree Collapse file tree 2 files changed +36
-31
lines changed Original file line number Diff line number Diff line change 1
- # eslint-plugin-vue-i18n
1
+ # : globe_with_meridians : eslint-plugin-vue-i18n
2
2
3
- ESLint plugin for vue-i18n
3
+ ESLint plugin for Vue I18n
4
4
5
- ## Installation
5
+ <a href =" https://www.patreon.com/kazupon " target =" _blank " >
6
+ <img src =" https://c5.patreon.com/external/logo/become_a_patron_button.png " alt =" Become a Patreon " >
7
+ </a >
6
8
7
- You'll first need to install [ ESLint ] ( http://eslint.org ) :
9
+ ## : cd : Installation
8
10
9
- ```
10
- $ npm i eslint --save-dev
11
- ```
12
-
13
- Next, install ` eslint-plugin-vue-i18n ` :
11
+ Use [ npm] ( https://www.npmjs.com/ ) or a compatible tool.
14
12
15
- ```
16
- $ npm install eslint-plugin-vue-i18n --save-dev
13
+ ``` sh
14
+ npm install --save-dev eslint eslint-plugin-vue-i18n
17
15
```
18
16
19
- ** Note: ** If you installed ESLint globally (using the ` -g ` flag) then you must also install ` eslint-plugin-vue-i18n ` globally.
17
+ ## : rocket : Usage
20
18
21
- ## Usage
19
+ Configure your ` .eslintrc.* ` file.
22
20
23
- Add ` vue-i18n ` to the plugins section of your ` .eslintrc ` configuration file. You can omit the ` eslint-plugin- ` prefix :
21
+ For example :
24
22
25
23
``` json
26
24
{
27
- "plugins" : [
28
- " vue-i18n"
29
- ]
25
+ "extends" : [
26
+ " eslint:recommended" ,
27
+ " plugin:vue-i18n/recommended"
28
+ ],
29
+ "rules" : {
30
+ // Optional.
31
+ "vue-i18n/no-dynamic-key" : " error"
32
+ }
30
33
}
31
34
```
32
35
36
+ ## :white_check_mark : TODO
37
+ - [x] no-missing-key
38
+ - [ ] no-dynamic-key
39
+ - [ ] no-unused-key
40
+ - [ ] no-raw-text
41
+ - [ ] valid-message-syntax
42
+ - [ ] keys-order
43
+ - [ ] replace documentation example with ` eslint-playground ` component
33
44
34
- Then configure the rules you want to use under the rules section.
35
-
36
- ``` json
37
- {
38
- "rules" : {
39
- "vue-i18n/rule-name" : 2
40
- }
41
- }
42
- ```
43
-
44
- ## Supported Rules
45
+ ## :copyright : License
45
46
46
- * Fill in provided rules here
47
+ [ MIT ] ( http://opensource.org/licenses/MIT )
Original file line number Diff line number Diff line change 1
1
# Getting Started
2
2
3
+ <a href =" https://www.patreon.com/kazupon " target =" _blank " >
4
+ <img src =" https://c5.patreon.com/external/logo/become_a_patron_button.png " alt =" Become a Patreon " >
5
+ </a >
6
+
3
7
## :cd : Installation
4
8
5
9
Use [ npm] ( https://www.npmjs.com/ ) or a compatible tool.
@@ -22,7 +26,7 @@ For example:
22
26
],
23
27
"rules" : {
24
28
// Optional.
25
- "vue-i18n/no-missing -key" : " error"
29
+ "vue-i18n/no-dynamic -key" : " error"
26
30
}
27
31
}
28
- ```
32
+ ```
You can’t perform that action at this time.
0 commit comments