docs: clarify optional formatter settings - #384
Conversation
Deploying rstack-cli with
|
| Latest commit: |
cfcc77b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://965fa6cc.rstack-cli.pages.dev |
| Branch Preview URL: | https://chenjiahan-docs-optional-for.rstack-cli.pages.dev |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: cfcc77baab
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "[jsonc]": { "editor.defaultFormatter": "rstack.rstack" }, | ||
| "[markdown]": { "editor.defaultFormatter": "rstack.rstack" }, | ||
| "[mdx]": { "editor.defaultFormatter": "rstack.rstack" }, | ||
| "[toml]": { "editor.defaultFormatter": "rstack.rstack" }, |
There was a problem hiding this comment.
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 👍 / 👎.
Summary
Language-specific formatter settings are optional, but the IDE integration guide did not clearly explain that projects can configure only the languages they use.
This PR separates the workspace-wide settings from the optional language-specific examples and keeps the English and Chinese guides aligned.