Skip to content

Commit 387d8cf

Browse files
committed
update documents
1 parent b2e9cb6 commit 387d8cf

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ This ESLint plugin provides linting rules relate to better ways to help you avoi
2020
- You can apply rules similar to the rules you use for JavaScript to JSON using the [`"jsonc/auto"`](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/auto.html) rule provided by this plugin.
2121
- You can choose the appropriate config provided by this plugin depending on whether you are using [JSON], [JSONC] or [JSON5].
2222
- Supports [Vue SFC](https://vue-loader.vuejs.org/spec.html) custom blocks such as `<i18n>`.
23+
- Supports ESLint directives. e.g. `// eslint-disable-next-line`
24+
- You can check your code in real-time using the ESLint editor integrations.
2325

2426
You can check on the [Online DEMO](https://ota-meshi.github.io/eslint-plugin-jsonc/playground/).
2527

@@ -139,6 +141,7 @@ The rules with the following star :star: are included in the config.
139141
| Rule ID | Description | Fixable | JSON | JSONC | JSON5 |
140142
|:--------|:------------|:-------:|:----:|:-----:|:-----:|
141143
| [jsonc/auto](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/auto.html) | apply jsonc rules similar to your configured ESLint core rules | :wrench: | | | |
144+
| [jsonc/key-name-casing](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/key-name-casing.html) | enforce naming convention to property key names | | | | |
142145
| [jsonc/no-bigint-literals](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-bigint-literals.html) | disallow BigInt literals | | :star: | :star: | :star: |
143146
| [jsonc/no-comments](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-comments.html) | disallow comments | | :star: | | |
144147
| [jsonc/no-number-props](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-number-props.html) | disallow number property keys | :wrench: | :star: | :star: | :star: |

docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ This ESLint plugin provides linting rules relate to better ways to help you avoi
2020
- You can apply rules similar to the rules you use for JavaScript to JSON using the [`"jsonc/auto"`](./rules/auto.md) rule provided by this plugin.
2121
- You can choose the appropriate config provided by this plugin depending on whether you are using [JSON], [JSONC] or [JSON5].
2222
- Supports [Vue SFC](https://vue-loader.vuejs.org/spec.html) custom blocks such as `<i18n>`.
23+
- Supports ESLint directives. e.g. `// eslint-disable-next-line`
24+
- You can check your code in real-time using the ESLint editor integrations.
2325

2426
You can check on the [Online DEMO](./playground/).
2527

docs/rules/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ The rules with the following star :star: are included in the `plugin:jsonc/recom
1414
| Rule ID | Description | Fixable | JSON | JSONC | JSON5 |
1515
|:--------|:------------|:-------:|:----:|:-----:|:-----:|
1616
| [jsonc/auto](./auto.md) | apply jsonc rules similar to your configured ESLint core rules | :wrench: | | | |
17+
| [jsonc/key-name-casing](./key-name-casing.md) | enforce naming convention to property key names | | | | |
1718
| [jsonc/no-bigint-literals](./no-bigint-literals.md) | disallow BigInt literals | | :star: | :star: | :star: |
1819
| [jsonc/no-comments](./no-comments.md) | disallow comments | | :star: | | |
1920
| [jsonc/no-number-props](./no-number-props.md) | disallow number property keys | :wrench: | :star: | :star: | :star: |

0 commit comments

Comments
 (0)