Skip to content

Commit a3bca3a

Browse files
ota-meshiota-meshi
committed
Update doc
1 parent 9f01b9a commit a3bca3a

File tree

3 files changed

+125
-108
lines changed

3 files changed

+125
-108
lines changed

‎README.md‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,13 @@ Example **.vscode/settings.json**:
115115

116116
```json
117117
{
118-
"eslint.validate": [
119-
"javascript",
120-
"javascriptreact",
121-
"json",
122-
"jsonc",
123-
"json5"
124-
]
118+
"eslint.validate": [
119+
"javascript",
120+
"javascriptreact",
121+
"json",
122+
"jsonc",
123+
"json5"
124+
]
125125
}
126126
```
127127

@@ -195,11 +195,19 @@ Please use GitHub's Issues/PRs.
195195

196196
<!--DOCS_IGNORE_END-->
197197

198+
## :couple: Related Packages
199+
200+
<!-- - [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc) ... ESLint plugin for JSON, JSON with comments (JSONC) and JSON5. -->
201+
- [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml) ... ESLint plugin for YAML.
202+
- [eslint-plugin-toml](https://github.com/ota-meshi/eslint-plugin-toml) ... ESLint plugin for TOML.
203+
- [jsonc-eslint-parser](https://github.com/ota-meshi/jsonc-eslint-parser) ... JSON, JSONC and JSON5 parser for use with ESLint plugins.
204+
- [yaml-eslint-parser](https://github.com/ota-meshi/yaml-eslint-parser) ... YAML parser for use with ESLint plugins.
205+
- [toml-eslint-parser](https://github.com/ota-meshi/toml-eslint-parser) ... TOML parser for use with ESLint plugins.
206+
198207
## :lock: License
199208

200209
See the [LICENSE](LICENSE) file for license rights and limitations (MIT).
201210

202-
203211
[JSON]: https://json.org/
204212
[JSONC]: https://github.com/microsoft/node-jsonc-parser
205213
[JSON5]: https://json5.org/

‎docs/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,15 @@ See [User Guide](./user-guide/README.md).
4747

4848
See [Available Rules](./rules/README.md).
4949

50+
## :couple: Related Packages
51+
52+
<!-- - [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc) ... ESLint plugin for JSON, JSON with comments (JSONC) and JSON5. -->
53+
- [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml) ... ESLint plugin for YAML.
54+
- [eslint-plugin-toml](https://github.com/ota-meshi/eslint-plugin-toml) ... ESLint plugin for TOML.
55+
- [jsonc-eslint-parser](https://github.com/ota-meshi/jsonc-eslint-parser) ... JSON, JSONC and JSON5 parser for use with ESLint plugins.
56+
- [yaml-eslint-parser](https://github.com/ota-meshi/yaml-eslint-parser) ... YAML parser for use with ESLint plugins.
57+
- [toml-eslint-parser](https://github.com/ota-meshi/toml-eslint-parser) ... TOML parser for use with ESLint plugins.
58+
5059
## :lock: License
5160

5261
See the [LICENSE](LICENSE) file for license rights and limitations (MIT).

‎package.json‎

Lines changed: 100 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,102 @@
11
{
2-
"name": "eslint-plugin-jsonc",
3-
"version": "0.8.2",
4-
"description": "ESLint plugin for JSON, JSONC and JSON5 files.",
5-
"main": "dist/index.js",
6-
"typescript": {
7-
"definition": "index.d.ts"
8-
},
9-
"types": "index.d.ts",
10-
"files": [
11-
"dist",
12-
"index.d.ts"
13-
],
14-
"scripts": {
15-
"prebuild": "npm run -s clean",
16-
"build": "npm run build:ts && npm run build:dts",
17-
"build:ts": "tsc --project ./tsconfig.build.json",
18-
"build:dts": "npm run build:dts-step1 && npm run build:dts-step2",
19-
"build:dts-step1": "tsc --declaration --outDir dist-ts --project ./tsconfig.build.json",
20-
"build:dts-step2": "dts-bundle --name eslint-plugin-jsonc --main ./dist-ts/index.d.ts --out ../index.d.ts",
21-
"clean": "rimraf .nyc_output dist coverage",
22-
"lint": "eslint \"tests\" \"lib\" \"docs\" --ext .js,.vue,.ts,.md,.json,.json5",
23-
"eslint-fix": "eslint \"tests\" \"lib\" \"docs\" --ext .js,.vue,.ts,.md,.json,.json5 --fix",
24-
"test:base": "mocha --require ts-node/register \"tests/lib/**/*.ts\" --reporter dot --timeout 60000",
25-
"test": "npm run test:base",
26-
"test:nyc": "nyc --reporter=lcov npm run test:base",
27-
"test:debug": "mocha --require ts-node/register --inspect \"tests/lib/**/*.ts\" --reporter dot",
28-
"pretest:integrations": "npm run build:ts",
29-
"test:integrations": "mocha --require ts-node/register \"tests-integrations/lib/**/*.ts\" --reporter dot --timeout 60000",
30-
"update": "ts-node ./tools/update.ts && npm run eslint-fix && npm run test:nyc",
31-
"new": "ts-node ./tools/new-rule.ts",
32-
"predocs:watch": "npm run build:ts",
33-
"docs:watch": "vuepress dev --debug docs",
34-
"docs:build": "npm run build:ts && vuepress build docs --no-cache",
35-
"preversion": "npm test && npm run update && git add .",
36-
"version": "npm run eslint-fix && git add ."
37-
},
38-
"repository": {
39-
"type": "git",
40-
"url": "git+https://github.com/ota-meshi/eslint-plugin-jsonc.git"
41-
},
42-
"keywords": [
43-
"eslint",
44-
"eslintplugin",
45-
"eslint-plugin",
46-
"jsonc",
47-
"json5",
48-
"json"
49-
],
50-
"author": "Yosuke Ota",
51-
"license": "MIT",
52-
"bugs": {
53-
"url": "https://github.com/ota-meshi/eslint-plugin-jsonc/issues"
54-
},
55-
"homepage": "https://ota-meshi.github.io/eslint-plugin-jsonc/",
56-
"peerDependencies": {
57-
"eslint": "^5.0.0 || >=6.0.0"
58-
},
59-
"devDependencies": {
60-
"@ota-meshi/eslint-plugin": "^0.0.9",
61-
"@types/eslint": "^7.2.0",
62-
"@types/eslint-scope": "^3.7.0",
63-
"@types/eslint-visitor-keys": "^1.0.0",
64-
"@types/mocha": "^7.0.2",
65-
"@types/natural-compare": "^1.4.0",
66-
"@types/node": "^14.0.13",
67-
"@types/semver": "^7.3.1",
68-
"@typescript-eslint/eslint-plugin": "^4.1.0",
69-
"@typescript-eslint/parser": "^4.1.0",
70-
"babel-eslint": "^10.1.0",
71-
"dts-bundle": "^0.7.3",
72-
"eslint": "^7.3.0",
73-
"eslint-config-prettier": "^6.11.0",
74-
"eslint-plugin-eslint-comments": "^3.2.0",
75-
"eslint-plugin-eslint-plugin": "^2.3.0",
76-
"eslint-plugin-jsonc": "^0.8.1",
77-
"eslint-plugin-markdown": "^2.0.0-0",
78-
"eslint-plugin-node": "^11.1.0",
79-
"eslint-plugin-prettier": "^3.1.4",
80-
"eslint-plugin-vue": "^7.0.0-0",
81-
"eslint-plugin-yml": "^0.3.0",
82-
"eslint4b": "^7.3.1",
83-
"mocha": "^7.0.0",
84-
"nyc": "^15.1.0",
85-
"prettier": "^2.0.5",
86-
"raw-loader": "^4.0.1",
87-
"semver": "^7.3.2",
88-
"stylelint": "^13.6.1",
89-
"stylelint-config-standard": "^20.0.0",
90-
"stylelint-plugin-stylus": "^0.9.0",
91-
"ts-node": "^8.10.2",
92-
"typescript": "^3.9.5",
93-
"vue-eslint-editor": "^1.1.0",
94-
"vue-eslint-parser": "^7.3.0",
95-
"vuepress": "^1.5.2"
96-
},
97-
"dependencies": {
98-
"eslint-utils": "^2.1.0",
99-
"jsonc-eslint-parser": "^0.6.0",
100-
"natural-compare": "^1.4.0"
101-
}
2+
"name": "eslint-plugin-jsonc",
3+
"version": "0.8.2",
4+
"description": "ESLint plugin for JSON, JSONC and JSON5 files.",
5+
"main": "dist/index.js",
6+
"typescript": {
7+
"definition": "index.d.ts"
8+
},
9+
"types": "index.d.ts",
10+
"files": [
11+
"dist",
12+
"index.d.ts"
13+
],
14+
"scripts": {
15+
"prebuild": "npm run -s clean",
16+
"build": "npm run build:ts && npm run build:dts",
17+
"build:ts": "tsc --project ./tsconfig.build.json",
18+
"build:dts": "npm run build:dts-step1 && npm run build:dts-step2",
19+
"build:dts-step1": "tsc --declaration --outDir dist-ts --project ./tsconfig.build.json",
20+
"build:dts-step2": "dts-bundle --name eslint-plugin-jsonc --main ./dist-ts/index.d.ts --out ../index.d.ts",
21+
"clean": "rimraf .nyc_output dist coverage",
22+
"lint": "eslint \"tests\" \"lib\" \"docs\" --ext .js,.vue,.ts,.md,.json,.json5",
23+
"eslint-fix": "eslint \"tests\" \"lib\" \"docs\" --ext .js,.vue,.ts,.md,.json,.json5 --fix",
24+
"test:base": "mocha --require ts-node/register \"tests/lib/**/*.ts\" --reporter dot --timeout 60000",
25+
"test": "npm run test:base",
26+
"test:nyc": "nyc --reporter=lcov npm run test:base",
27+
"test:debug": "mocha --require ts-node/register --inspect \"tests/lib/**/*.ts\" --reporter dot",
28+
"pretest:integrations": "npm run build:ts",
29+
"test:integrations": "mocha --require ts-node/register \"tests-integrations/lib/**/*.ts\" --reporter dot --timeout 60000",
30+
"update": "ts-node ./tools/update.ts && npm run eslint-fix && npm run test:nyc",
31+
"new": "ts-node ./tools/new-rule.ts",
32+
"predocs:watch": "npm run build:ts",
33+
"docs:watch": "vuepress dev --debug docs",
34+
"docs:build": "npm run build:ts && vuepress build docs --no-cache",
35+
"preversion": "npm test && npm run update && git add .",
36+
"version": "npm run eslint-fix && git add ."
37+
},
38+
"repository": {
39+
"type": "git",
40+
"url": "git+https://github.com/ota-meshi/eslint-plugin-jsonc.git"
41+
},
42+
"keywords": [
43+
"eslint",
44+
"eslintplugin",
45+
"eslint-plugin",
46+
"jsonc",
47+
"json5",
48+
"json"
49+
],
50+
"author": "Yosuke Ota",
51+
"license": "MIT",
52+
"bugs": {
53+
"url": "https://github.com/ota-meshi/eslint-plugin-jsonc/issues"
54+
},
55+
"homepage": "https://ota-meshi.github.io/eslint-plugin-jsonc/",
56+
"peerDependencies": {
57+
"eslint": "^5.0.0 || >=6.0.0"
58+
},
59+
"devDependencies": {
60+
"@ota-meshi/eslint-plugin": "^0.0.9",
61+
"@types/eslint": "^7.2.0",
62+
"@types/eslint-scope": "^3.7.0",
63+
"@types/eslint-visitor-keys": "^1.0.0",
64+
"@types/mocha": "^7.0.2",
65+
"@types/natural-compare": "^1.4.0",
66+
"@types/node": "^14.0.13",
67+
"@types/semver": "^7.3.1",
68+
"@typescript-eslint/eslint-plugin": "^4.1.0",
69+
"@typescript-eslint/parser": "^4.1.0",
70+
"babel-eslint": "^10.1.0",
71+
"dts-bundle": "^0.7.3",
72+
"eslint": "^7.3.0",
73+
"eslint-config-prettier": "^6.11.0",
74+
"eslint-plugin-eslint-comments": "^3.2.0",
75+
"eslint-plugin-eslint-plugin": "^2.3.0",
76+
"eslint-plugin-jsonc": "^0.8.1",
77+
"eslint-plugin-markdown": "^2.0.0-0",
78+
"eslint-plugin-node": "^11.1.0",
79+
"eslint-plugin-prettier": "^3.1.4",
80+
"eslint-plugin-vue": "^7.0.0-0",
81+
"eslint-plugin-yml": "^0.3.0",
82+
"eslint4b": "^7.3.1",
83+
"mocha": "^7.0.0",
84+
"nyc": "^15.1.0",
85+
"prettier": "^2.0.5",
86+
"raw-loader": "^4.0.1",
87+
"semver": "^7.3.2",
88+
"stylelint": "^13.6.1",
89+
"stylelint-config-standard": "^20.0.0",
90+
"stylelint-plugin-stylus": "^0.9.0",
91+
"ts-node": "^8.10.2",
92+
"typescript": "^3.9.5",
93+
"vue-eslint-editor": "^1.1.0",
94+
"vue-eslint-parser": "^7.3.0",
95+
"vuepress": "^1.5.2"
96+
},
97+
"dependencies": {
98+
"eslint-utils": "^2.1.0",
99+
"jsonc-eslint-parser": "^0.6.0",
100+
"natural-compare": "^1.4.0"
101+
}
102102
}

0 commit comments

Comments
 (0)