-
-
Notifications
You must be signed in to change notification settings - Fork 722
feat(language_server): introduce ServerFormatter
#13700
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.
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
feat(language_server): introduce ServerFormatter
#13700
Conversation
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
CodSpeed Instrumentation Performance ReportMerging #13700 will not alter performanceComparing Summary
|
80c4f06 to
42a1b9b
Compare
ce97ea7 to
fc596f4
Compare
f4c7ef3 to
8ca332f
Compare
fc596f4 to
3798dad
Compare
3798dad to
3b08bf6
Compare
df1a8d1 to
a2bf52e
Compare
ServerFormatterServerFormatter
a2bf52e to
76c2729
Compare
3b08bf6 to
179e34f
Compare
76c2729 to
940f6f4
Compare
f391c08 to
b988882
Compare
940f6f4 to
f05a0f8
Compare
64fafe3 to
bdbd19b
Compare
f05a0f8 to
a6f11d8
Compare
bdbd19b to
5bf9ca8
Compare
ddf7c62 to
5ad6d97
Compare
cb54a80 to
c1e00fd
Compare
dabd34c to
4649c44
Compare
4649c44 to
dc700f5
Compare
c1e00fd to
694413b
Compare
694413b to
325422e
Compare
7854fef to
e9ea470
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces experimental formatter support to the OXC language server, adding the ServerFormatter struct and configuring it to be enabled via the fmt.experimental configuration option. The formatter integration uses dynamic LSP capability registration to conditionally advertise formatting support to clients.
- Adds
ServerFormatterwithrun_singlemethod for formatting files - Introduces
fmt.experimentalconfiguration option for enabling the formatter - Implements dynamic capability registration for
textDocument/formattingwhen formatter is enabled
Reviewed Changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| worker.rs | Adds formatter state management and configuration handling to WorkspaceWorker |
| main.rs | Implements LSP formatting endpoint and dynamic capability registration |
| formatter/server_formatter.rs | Core formatter implementation with file processing logic |
| formatter/options.rs | Configuration parsing for formatter experimental flag |
| capabilities.rs | Enables dynamic formatting capability support |
| options.rs | Adds test for new fmt.experimental configuration option |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
e9ea470 to
58926e6
Compare
Merge activity
|
First try on formatter integration. The server will only tell the client, that is supports `formatting` when `fmt.experimental` is `true`. It will respect the flag in `initialize`, `did_change_configuration` (changing configuration), or `did_change_workspace_folders`. It will not tell the client, it does not support formatting when the configuration is changed to `false`. This can be optimized but has no high priority, because the client needs to send the request and the `ServerFormatter` needs to be set. The last requirement is then false. Make `WorkspaceWorker.option` optional, so we the servers knows when the configuration in `initialize` or `initialized` (with `request_workspace_configuration`). Before the server knew it, by looking at the `WorkspaceWorker.server_linter` instance.
58926e6 to
a21ff54
Compare
## [1.17.0] - 2025-09-23 ### 🚀 Features - f47f978 linter/plugins: Add `definePlugin` API (#14008) (overlookmotel) - 3e117c6 linter/plugins: Add `defineRule` API (#13945) (overlookmotel) - 2dc8adb linter/plugins: Add `createOnce` API (#13944) (overlookmotel) - bef8753 linter/plugins: ESTree-compatible AST for JS plugins (#13942) (overlookmotel) - 55c2e11 editor: Add `oxc.fmt.experimental` flag (#13923) (Sysix) - a21ff54 language_server: Introduce `ServerFormatter` (#13700) (Sysix) - a14aa79 npm/oxlint: Convert to ES modules (#13876) (Boshen) - 15eb326 linter: Add `vue/no-required-prop-with-default` rule (#13613) (yefan) - 5d3ba00 linter: Add `vue/require-typed-ref` rule (#13857) (yefan) - b52389a node: Bump `engines` field to require Node.js 20.19.0+ for ESM support (#13879) (Copilot) - 8221a01 linter: Add `eslint/no-misleading-character-class` (#13365) (Sysix) - c75ae8c linter/plugins: Add options to `Context` (#13810) (overlookmotel) - 53d04dd linter: Convert `oxlint` to NAPI app (#13723) (overlookmotel) ### 🐛 Bug Fixes - 1f4be38 napi/parser: Generate `.d.mts` extension for types (#14038) (Daniel Roe) - a018756 linter/plugins: Pin `tsdown` dependency to 0.15.1 (#14005) (overlookmotel) - b8790c2 language_server: Output correct position for parser & semantic errors (#14010) (Sysix) - 4d3c6e1 linter: Support let-chains in codegen node type detection (#14006) (camc314) - a34918a linter/plugins: Avoid lint warnings compiling WASM or big-endian (#13968) (overlookmotel) - 27022ab linter/switch-case-braces: Add support for string including colon on case expression (#13687) (Lukinoh) - dd3843f linter: Set package version in `package.json` (#13890) (overlookmotel) - fa866b3 linter: Sort optimized/unoptimized diagnostics before comparison (#13850) (camc314) - fac7624 linter/plugins: Improve error for no JS plugins (#13858) (overlookmotel) ### 🚜 Refactor - bb040bc parser, linter: Replace `.mjs` files with `.js` (#14045) (overlookmotel) - b353750 linter/plugins: Remove unnecessary `Serialize` derives (#14031) (overlookmotel) - 0d48511 linter/plugins: Improve handling `Context` method calls in `createOnce` (#14032) (overlookmotel) - 36ac0fb language_server: Don't create `mpsc` channel (#14011) (Sysix) - 2e9ae3f linter: Make disable directives own the rule name (#13987) (camc314) - 6bc7664 oxlint: Run oxlint before tsgolint (#13519) (camc314) - 0c93f33 language_server: Use minimal text edit for `ServerFormatter` (#13960) (Sysix) - 823cb57 langauge_server: Move `Backend` into own file (#13955) (Sysix) - dc700f5 language_server: Introduce `LSPFileSystem` (#13731) (Sysix) - 42e2c1d linter: Remove `Rc` from `DisableDirectives` (#13924) (camc314) - ac3e9e9 napi/parser: Move JS code into `src-js` directory (#13899) (overlookmotel) - e90bfe3 linter: Remove double reference in unicorn/error-message (#13916) (camc314) - 83791a0 linter: Remove double reference in vue/jsx-no-undef (#13915) (camc314) - ebd22de linter: Remove double reference in vue/require-typed-ref (#13914) (camc314) - 873e231 language_server: Move `needs_linter_restart` to `ServerLinter` (#13834) (Sysix) - 7e0d736 linter/plugins: Rename `--experimental-js-plugins` to `--js-plugins` (#13860) (overlookmotel) - 6245c8c linter/plugins: Make `Context` properties getters (#13809) (overlookmotel) - a2342a6 linter/plugins: Import named in tests (#13807) (overlookmotel) ### 📚 Documentation - 601c876 linter: Add comment explaining why Mimalloc is feature-gated (#14037) (overlookmotel) ### ⚡ Performance - 4d04c6e linter/plugins: Flatten `LintFileResult` fields (#14033) (overlookmotel) - 06363e0 linter: Add node type codegen support for `match node.kind()` (#13736) (camchenry) - a79af0a linter: Replace `for (... of ...)` loops (#13913) (overlookmotel) - b53292d linter: Use unstable sort where possible (#13818) (sapphi-red) ### 🎨 Styling - 8083740 linter: Import `Serialize` at top level (#14030) (overlookmotel) ### 🧪 Testing - b807b6f language_server: Skip formatter test on windows (#13986) (Sysix) - 2600858 language_server: Add Tester for ServerFormatter (#13969) (Sysix) - 37aadf0 language_server: Add `test_and_snapshot_multiple_file` (#13966) (Sysix) - ad14a41 editor: Fix test setup (#13929) (Sysix) - f51240e linter/plugins: Tests for different import styles (#13859) (overlookmotel) - 407c95e linter/plugins: Check `this` is undefined in visit functions (#13811) (overlookmotel) - f023a22 linter/plugins: Include stack trace in plugin loading errors (#13808) (overlookmotel) ### 💼 Other - 0630d68 linter: Build `oxlint` locally with Mimalloc in release mode (#14034) (overlookmotel) Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>

First try on formatter integration.
The server will only tell the client, that is supports
formattingwhenfmt.experimentalistrue.It will respect the flag in
initialize,did_change_configuration(changing configuration), ordid_change_workspace_folders.It will not tell the client, it does not support formatting when the configuration is changed to
false.This can be optimized but has no high priority, because the client needs to send the request and the
ServerFormatterneeds to be set. The last requirement is then false.Make
WorkspaceWorker.optionoptional, so we the servers knows when the configuration ininitializeorinitialized(withrequest_workspace_configuration). Before the server knew it, by looking at theWorkspaceWorker.server_linterinstance.