mirror of
https://github.com/danbulant/oxc
synced 2026-05-25 12:51:57 +00:00
38b1c2ec65
Ref #7456 - Creates a custom action in the language server that applies all auto-fixes for a given file. - Updates VS Code to use the custom action with a command to apply fixes for the currently active text editor.
63 lines
3.7 KiB
Markdown
63 lines
3.7 KiB
Markdown
# oxc_language_server
|
|
|
|
This crate provides an [LSP](https://microsoft.github.io/language-server-protocol/) Server which is used inside an editor or IDE.
|
|
|
|
## Server Capabilities
|
|
|
|
- [Text Document Synchronization](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_synchronization): `FULL`,
|
|
- Workspace
|
|
- [Workspace Folders](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspaceFoldersServerCapabilities): `true`
|
|
- File Operations: `false`
|
|
- [Code Actions Provider](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#codeActionKind):
|
|
- `quickfix`
|
|
- `source.fixAll.oxc`, behaves the same as `quickfix` only used when the `CodeActionContext#only` contains
|
|
`source.fixAll.oxc`.
|
|
|
|
## Supported LSP Specifications from Server
|
|
|
|
- [initialize](https://microsoft.github.io/language-server-protocol/specification#initialize)
|
|
- Returns the [Server Capabilities](#server-capabilities)
|
|
- [initialized](https://microsoft.github.io/language-server-protocol/specification#initialized)
|
|
- [shutdown](https://microsoft.github.io/language-server-protocol/specification#shutdown)
|
|
|
|
### Workspace
|
|
|
|
#### [workspace/didChangeConfiguration](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeConfiguration)
|
|
|
|
The server expects this request when settings like `run`, `enable` or `configPath` are changed.
|
|
The server will revalidate or reset the diagnostics for all open files and send one or more [textDocument/publishDiagnostics](#textdocumentpublishdiagnostics) requests to the client.
|
|
|
|
#### [workspace/didChangeWatchedFiles](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeWatchedFiles)
|
|
|
|
The server expects this request when the oxlint configuration is changed.
|
|
The server will revalidate the diagnostics for all open files and send one or more [textDocument/publishDiagnostics](#textdocumentpublishdiagnostics) requests to the client.
|
|
|
|
### TextDocument
|
|
|
|
#### [textDocument/didOpen](https://microsoft.github.io/language-server-protocol/specification#textDocument_didOpen)
|
|
|
|
The server will validate the file content and send a [textDocument/publishDiagnostics](#textdocumentpublishdiagnostics) request to the client.
|
|
|
|
#### [textDocument/didSave](https://microsoft.github.io/language-server-protocol/specification#textDocument_didSave)
|
|
|
|
When the configuration `run` is set to `onSave`, the server will validate the file content and send a [textDocument/publishDiagnostics](#textdocumentpublishdiagnostics) request to the client.
|
|
|
|
#### [textDocument/didChange](https://microsoft.github.io/language-server-protocol/specification#textDocument_didChange)
|
|
|
|
When the configuration `run` is set to `onType`, the server will validate the file content and send a [textDocument/publishDiagnostics](#textdocumentpublishdiagnostics) request to the client.
|
|
|
|
#### [textDocument/didClose](https://microsoft.github.io/language-server-protocol/specification#textDocument_didClose)
|
|
|
|
It will remove the reference internal.
|
|
|
|
#### [textDocument/codeAction](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeAction)
|
|
|
|
Returns a list of [CodeAction](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_codeAction)
|
|
|
|
## Expected LSP Specification from Client
|
|
|
|
### TextDocument
|
|
|
|
#### [textDocument/publishDiagnostics](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_publishDiagnostics)
|
|
|
|
Returns a [PublishDiagnostic object](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#publishDiagnosticsParams)
|