Skip to content

Commit c341e27

Browse files
committed
docs: document known vscode-eslint issues
1 parent 980b6cb commit c341e27

File tree

3 files changed

+5024
-3023
lines changed

3 files changed

+5024
-3023
lines changed

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,33 @@ If you want VS Code to automatically close tags while you type, you can install
5353
]
5454
```
5555

56+
## Known `vscode-eslint` issues
57+
58+
1. `Fatal javascript OOM in GC during deserialization`
59+
60+
ESlint is using VS Code's old, built-in version of NodeJS (v12) as provided by Electron.
61+
Please add the following setting to use system default Node runtime instead:
62+
63+
```json
64+
{
65+
"eslint.runtime": "node"
66+
}
67+
```
68+
69+
Please visit https://github.com/microsoft/vscode-eslint/issues/1498#issuecomment-1175813839 as reference for details.
70+
71+
2. `JavaScript heap out of memory`
72+
73+
The default memory limit of Node.js is `1G`, please add the following setting to increase the limit:
74+
75+
```json
76+
{
77+
"eslint.execArgv": ["--max_old_space_size=8192"]
78+
}
79+
```
80+
81+
Please visit https://github.com/microsoft/vscode-eslint/issues/733 as reference for details.
82+
5683
[mdx]: https://github.com/mdx-js/mdx
5784
[eslint-plugin-mdx]: https://github.com/mdx-js/eslint-mdx
5885
[remark]: https://github.com/remarkjs/remark

package.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@
2525
"release": "sh release.sh"
2626
},
2727
"devDependencies": {
28-
"@1stg/common-config": "^2.3.1",
29-
"standard-version": "^9.3.0",
30-
"typescript": "^4.3.5",
31-
"yarn-deduplicate": "^3.1.0"
28+
"@1stg/common-config": "^5.2.6",
29+
"standard-version": "^9.5.0",
30+
"typescript": "^4.7.4",
31+
"yarn-deduplicate": "^5.0.0"
3232
},
3333
"resolutions": {
34-
"prettier": "^2.3.2"
34+
"prettier": "^2.7.1"
3535
},
3636
"icon": "assets/mdx.png",
3737
"contributes": {

0 commit comments

Comments
 (0)