Skip to content

Commit 773d8c1

Browse files
authored
update docs (#55)
* update docs * update
1 parent 60cfab9 commit 773d8c1

File tree

3 files changed

+44
-8
lines changed

3 files changed

+44
-8
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ Moreover, You can do the same linting using the extended rules of the ESLint cor
3939

4040
The parser package used by this plugin is [jsonc-eslint-parser].
4141

42-
### How is it different from other JSON plugins?
42+
## :question: How is it different from other JSON plugins?
4343

44-
#### Plugins that Do Not use AST
44+
### Plugins that do not use AST
4545

4646
e.g. [eslint-plugin-json](https://www.npmjs.com/package/eslint-plugin-json)
4747

@@ -53,13 +53,13 @@ Also, most plugins don't support JSON5.
5353

5454
**eslint-plugin-jsonc** works by providing AST and source code text to ESLint.
5555

56-
#### Plugins that use the same AST as JavaScript
56+
### Plugins that use the same AST as JavaScript
5757

5858
e.g. [eslint-plugin-json-files](https://www.npmjs.com/package/eslint-plugin-json-files), [eslint-plugin-json-es](https://www.npmjs.com/package/eslint-plugin-json-es)
5959

6060
These plugins use the same AST as JavaScript for linting.
6161

62-
Since the plugin uses the same AST as JavaScript, it may not report syntax that is not available in JSON (e.g. `1 + 1`). Also, ESLint core rules and other plugin rules can false positives (e.g. [quote-props](https://eslint.org/docs/rules/quote-props) rule reports quote on keys), which can complicate the configuration.
62+
Since the plugin uses the same AST as JavaScript, it may not report syntax that is not available in JSON (e.g. `1 + 1`). Also, ESLint core rules and other plugin rules can false positives (e.g. [quote-props](https://eslint.org/docs/rules/quote-props) rule reports quote on keys), which can complicate the your configuration.
6363

6464
The AST used by **eslint-plugin-jsonc** is similar to JavaScript AST, but with a different node name. This will prevent false positives. This means that it can be easily used in combination with other plugins.
6565

@@ -205,8 +205,22 @@ The rules with the following star :star: are included in the config.
205205
<!--RULES_TABLE_END-->
206206
<!--RULES_SECTION_END-->
207207

208+
## :rocket: To Do More Verification
209+
210+
### Verify using JSON Schema
211+
212+
You can verify using JSON Schema by checking and installing [eslint-plugin-json-schema-validator].
213+
214+
### Verify the [Vue I18n] message resource files
215+
216+
You can verify the message files by checking and installing [@intlify/eslint-plugin-vue-i18n].
217+
208218
<!--DOCS_IGNORE_START-->
209219

220+
## :traffic_light: Semantic Versioning Policy
221+
222+
**eslint-plugin-jsonc** follows [Semantic Versioning](http://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).
223+
210224
## :beers: Contributing
211225

212226
Welcome contributing!
@@ -237,3 +251,6 @@ See the [LICENSE](LICENSE) file for license rights and limitations (MIT).
237251
[JSONC]: https://github.com/microsoft/node-jsonc-parser
238252
[JSON5]: https://json5.org/
239253
[jsonc-eslint-parser]: https://github.com/ota-meshi/jsonc-eslint-parser
254+
[eslint-plugin-json-schema-validator]: https://github.com/ota-meshi/eslint-plugin-json-schema-validator
255+
[@intlify/eslint-plugin-vue-i18n]: https://github.com/intlify/eslint-plugin-vue-i18n
256+
[Vue I18n]: https://github.com/intlify/vue-i18n-next

docs/README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ Moreover, You can do the same linting using the extended rules of the ESLint cor
3939

4040
The parser package used by this plugin is [jsonc-eslint-parser].
4141

42-
### How is it different from other JSON plugins?
42+
## :question: How is it different from other JSON plugins?
4343

44-
#### Plugins that Do Not use AST
44+
### Plugins that do not use AST
4545

4646
e.g. [eslint-plugin-json](https://www.npmjs.com/package/eslint-plugin-json)
4747

@@ -53,13 +53,13 @@ Also, most plugins don't support JSON5.
5353

5454
**eslint-plugin-jsonc** works by providing AST and source code text to ESLint.
5555

56-
#### Plugins that use the same AST as JavaScript
56+
### Plugins that use the same AST as JavaScript
5757

5858
e.g. [eslint-plugin-json-files](https://www.npmjs.com/package/eslint-plugin-json-files), [eslint-plugin-json-es](https://www.npmjs.com/package/eslint-plugin-json-es)
5959

6060
These plugins use the same AST as JavaScript for linting.
6161

62-
Since the plugin uses the same AST as JavaScript, it may not report syntax that is not available in JSON (e.g. `1 + 1`). Also, ESLint core rules and other plugin rules can false positives (e.g. [quote-props](https://eslint.org/docs/rules/quote-props) rule reports quote on keys), which can complicate the configuration.
62+
Since the plugin uses the same AST as JavaScript, it may not report syntax that is not available in JSON (e.g. `1 + 1`). Also, ESLint core rules and other plugin rules can false positives (e.g. [quote-props](https://eslint.org/docs/rules/quote-props) rule reports quote on keys), which can complicate the your configuration.
6363

6464
The AST used by **eslint-plugin-jsonc** is similar to JavaScript AST, but with a different node name. This will prevent false positives. This means that it can be easily used in combination with other plugins.
6565

@@ -71,6 +71,16 @@ See [User Guide](./user-guide/README.md).
7171

7272
See [Available Rules](./rules/README.md).
7373

74+
## :rocket: To Do More Verification
75+
76+
### Verify using JSON Schema
77+
78+
You can verify using JSON Schema by checking and installing [eslint-plugin-json-schema-validator].
79+
80+
### Verify the [Vue I18n] message resource files
81+
82+
You can verify the message files by checking and installing [@intlify/eslint-plugin-vue-i18n].
83+
7484
## :couple: Related Packages
7585

7686
- [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml) ... ESLint plugin for YAML.
@@ -88,3 +98,6 @@ See the [LICENSE](LICENSE) file for license rights and limitations (MIT).
8898
[JSONC]: https://github.com/microsoft/node-jsonc-parser
8999
[JSON5]: https://json5.org/
90100
[jsonc-eslint-parser]: https://github.com/ota-meshi/jsonc-eslint-parser
101+
[eslint-plugin-json-schema-validator]: https://github.com/ota-meshi/eslint-plugin-json-schema-validator
102+
[@intlify/eslint-plugin-vue-i18n]: https://github.com/intlify/eslint-plugin-vue-i18n
103+
[Vue I18n]: https://github.com/intlify/vue-i18n-next

docs/user-guide/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,9 @@ module.exports = {
102102
],
103103
}
104104
```
105+
106+
### How to verify JSON using JSON Schema?
107+
108+
You can verify using JSON Schema by checking and installing [eslint-plugin-json-schema-validator]. I believe it will help you.
109+
110+
[eslint-plugin-json-schema-validator]: https://github.com/ota-meshi/eslint-plugin-json-schema-validator

0 commit comments

Comments
 (0)