From cfcc77baaba2baac417fb1e71ed6cb3c07b6f6ad Mon Sep 17 00:00:00 2001 From: neverland Date: Thu, 20 Aug 2026 10:59:15 +0800 Subject: [PATCH] docs: clarify optional formatter settings --- website/docs/en/guide/ide-integration.mdx | 30 +++++++++++++---------- website/docs/zh/guide/ide-integration.mdx | 30 +++++++++++++---------- 2 files changed, 34 insertions(+), 26 deletions(-) diff --git a/website/docs/en/guide/ide-integration.mdx b/website/docs/en/guide/ide-integration.mdx index f85630b2..b01c3757 100644 --- a/website/docs/en/guide/ide-integration.mdx +++ b/website/docs/en/guide/ide-integration.mdx @@ -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" }, + "[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: diff --git a/website/docs/zh/guide/ide-integration.mdx b/website/docs/zh/guide/ide-integration.mdx index 1067f8bc..450cfd74 100644 --- a/website/docs/zh/guide/ide-integration.mdx +++ b/website/docs/zh/guide/ide-integration.mdx @@ -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" } +} +``` 如需在手动保存文件时同时修复代码检查问题,可以添加: