Skip to content

Commit cfcc77b

Browse files
committed
docs: clarify optional formatter settings
1 parent 04e369d commit cfcc77b

2 files changed

Lines changed: 34 additions & 26 deletions

File tree

website/docs/en/guide/ide-integration.mdx

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,27 @@ To use Rstack as the default formatter and format files on save, add the followi
2424
```json title=".vscode/settings.json"
2525
{
2626
"editor.defaultFormatter": "rstack.rstack",
27-
"[javascript]": {
28-
"editor.defaultFormatter": "rstack.rstack"
29-
},
30-
"[javascriptreact]": {
31-
"editor.defaultFormatter": "rstack.rstack"
32-
},
33-
"[typescript]": {
34-
"editor.defaultFormatter": "rstack.rstack"
35-
},
36-
"[typescriptreact]": {
37-
"editor.defaultFormatter": "rstack.rstack"
38-
},
3927
"editor.formatOnSave": true
4028
}
4129
```
4230

43-
The language-specific JavaScript and TypeScript settings prevent existing formatter preferences from overriding the workspace default.
31+
The following language-specific settings are optional. They prevent existing language-specific formatter preferences from overriding the workspace default. Add settings only for the languages your project needs:
32+
33+
```json title=".vscode/settings.json"
34+
{
35+
"[javascript]": { "editor.defaultFormatter": "rstack.rstack" },
36+
"[javascriptreact]": { "editor.defaultFormatter": "rstack.rstack" },
37+
"[json]": { "editor.defaultFormatter": "rstack.rstack" },
38+
"[json5]": { "editor.defaultFormatter": "rstack.rstack" },
39+
"[jsonc]": { "editor.defaultFormatter": "rstack.rstack" },
40+
"[markdown]": { "editor.defaultFormatter": "rstack.rstack" },
41+
"[mdx]": { "editor.defaultFormatter": "rstack.rstack" },
42+
"[toml]": { "editor.defaultFormatter": "rstack.rstack" },
43+
"[typescript]": { "editor.defaultFormatter": "rstack.rstack" },
44+
"[typescriptreact]": { "editor.defaultFormatter": "rstack.rstack" },
45+
"[yaml]": { "editor.defaultFormatter": "rstack.rstack" }
46+
}
47+
```
4448

4549
To apply lint fixes when you save a file manually, add:
4650

website/docs/zh/guide/ide-integration.mdx

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,27 @@ Rstack 目前通过 [Rstack 扩展](https://github.com/rstackjs/rstack-editor)
2424
```json title=".vscode/settings.json"
2525
{
2626
"editor.defaultFormatter": "rstack.rstack",
27-
"[javascript]": {
28-
"editor.defaultFormatter": "rstack.rstack"
29-
},
30-
"[javascriptreact]": {
31-
"editor.defaultFormatter": "rstack.rstack"
32-
},
33-
"[typescript]": {
34-
"editor.defaultFormatter": "rstack.rstack"
35-
},
36-
"[typescriptreact]": {
37-
"editor.defaultFormatter": "rstack.rstack"
38-
},
3927
"editor.formatOnSave": true
4028
}
4129
```
4230

43-
其中,针对 JavaScript 和 TypeScript 的语言级配置可以避免开发者已有的格式化设置覆盖工作区默认值。
31+
以下语言级配置是可选的,可避免开发者已有的语言级格式化设置覆盖工作区默认值。你可以根据项目需要,只为所需的语言添加配置:
32+
33+
```json title=".vscode/settings.json"
34+
{
35+
"[javascript]": { "editor.defaultFormatter": "rstack.rstack" },
36+
"[javascriptreact]": { "editor.defaultFormatter": "rstack.rstack" },
37+
"[json]": { "editor.defaultFormatter": "rstack.rstack" },
38+
"[json5]": { "editor.defaultFormatter": "rstack.rstack" },
39+
"[jsonc]": { "editor.defaultFormatter": "rstack.rstack" },
40+
"[markdown]": { "editor.defaultFormatter": "rstack.rstack" },
41+
"[mdx]": { "editor.defaultFormatter": "rstack.rstack" },
42+
"[toml]": { "editor.defaultFormatter": "rstack.rstack" },
43+
"[typescript]": { "editor.defaultFormatter": "rstack.rstack" },
44+
"[typescriptreact]": { "editor.defaultFormatter": "rstack.rstack" },
45+
"[yaml]": { "editor.defaultFormatter": "rstack.rstack" }
46+
}
47+
```
4448

4549
如需在手动保存文件时同时修复代码检查问题,可以添加:
4650

0 commit comments

Comments
 (0)