Skip to content

docs: clarify optional formatter settings #384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chenjiahan merged 1 commit into from
Aug 20, 2026
+34 −26
Merged

docs: clarify optional formatter settings #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions website/docs/en/guide/ide-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,27 @@ To use Rstack as the default formatter and format files on save, add the followi
```json title=".vscode/settings.json"
{
"editor.defaultFormatter": "rstack.rstack",
"[javascript]": {
"editor.defaultFormatter": "rstack.rstack"
},
"[javascriptreact]": {
"editor.defaultFormatter": "rstack.rstack"
},
"[typescript]": {
"editor.defaultFormatter": "rstack.rstack"
},
"[typescriptreact]": {
"editor.defaultFormatter": "rstack.rstack"
},
"editor.formatOnSave": true
}
```

The language-specific JavaScript and TypeScript settings prevent existing formatter preferences from overriding the workspace default.
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:

```json title=".vscode/settings.json"
{
"[javascript]": { "editor.defaultFormatter": "rstack.rstack" },
"[javascriptreact]": { "editor.defaultFormatter": "rstack.rstack" },
"[json]": { "editor.defaultFormatter": "rstack.rstack" },
"[json5]": { "editor.defaultFormatter": "rstack.rstack" },
"[jsonc]": { "editor.defaultFormatter": "rstack.rstack" },
"[markdown]": { "editor.defaultFormatter": "rstack.rstack" },
"[mdx]": { "editor.defaultFormatter": "rstack.rstack" },
"[toml]": { "editor.defaultFormatter": "rstack.rstack" },

@chatgpt-codex-connector chatgpt-codex-connector Bot Aug 20, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Qualify TOML formatting as requiring a plugin

For projects with TOML files but no explicitly configured TOML Prettier plugin, this setting selects Rstack even though the default formatter plugins in packages/rstack/src/fmt/prettierPlugins.ts do not provide a TOML parser; the LSP consequently returns no edits for these files, so format-on-save silently stops working. Remove TOML from the general list or document the required plugin setup in both language copies.

AGENTS.md reference: AGENTS.md:L43-L43

Useful? React with 👍 / 👎.

"[typescript]": { "editor.defaultFormatter": "rstack.rstack" },
"[typescriptreact]": { "editor.defaultFormatter": "rstack.rstack" },
"[yaml]": { "editor.defaultFormatter": "rstack.rstack" }
}
```

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

Expand Down
30 changes: 17 additions & 13 deletions website/docs/zh/guide/ide-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,27 @@ Rstack 目前通过 [Rstack 扩展](https://github.com/rstackjs/rstack-editor)
```json title=".vscode/settings.json"
{
"editor.defaultFormatter": "rstack.rstack",
"[javascript]": {
"editor.defaultFormatter": "rstack.rstack"
},
"[javascriptreact]": {
"editor.defaultFormatter": "rstack.rstack"
},
"[typescript]": {
"editor.defaultFormatter": "rstack.rstack"
},
"[typescriptreact]": {
"editor.defaultFormatter": "rstack.rstack"
},
"editor.formatOnSave": true
}
```

其中，针对 JavaScript 和 TypeScript 的语言级配置可以避免开发者已有的格式化设置覆盖工作区默认值。
以下语言级配置是可选的，可避免开发者已有的语言级格式化设置覆盖工作区默认值。你可以根据项目需要，只为所需的语言添加配置：

```json title=".vscode/settings.json"
{
"[javascript]": { "editor.defaultFormatter": "rstack.rstack" },
"[javascriptreact]": { "editor.defaultFormatter": "rstack.rstack" },
"[json]": { "editor.defaultFormatter": "rstack.rstack" },
"[json5]": { "editor.defaultFormatter": "rstack.rstack" },
"[jsonc]": { "editor.defaultFormatter": "rstack.rstack" },
"[markdown]": { "editor.defaultFormatter": "rstack.rstack" },
"[mdx]": { "editor.defaultFormatter": "rstack.rstack" },
"[toml]": { "editor.defaultFormatter": "rstack.rstack" },
"[typescript]": { "editor.defaultFormatter": "rstack.rstack" },
"[typescriptreact]": { "editor.defaultFormatter": "rstack.rstack" },
"[yaml]": { "editor.defaultFormatter": "rstack.rstack" }
}
```

如需在手动保存文件时同时修复代码检查问题，可以添加：

Expand Down