Miguel Raz Guzmán Macedo
b099024705
# Objective - Describe the objective or issue this PR addresses. -> ** Typo and grammar fixes!** ## Solution ## Testing ## Self-Review Checklist: - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content adheres to Zed's UI standards ([UX/UI](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) and [icon](https://github.com/zed-industries/zed/blob/main/crates/icons/README.md) guidelines) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable ## Showcase --- Release Notes: - N/A
76 lines
2.1 KiB
Markdown
76 lines
2.1 KiB
Markdown
---
|
|
title: Diagnostics - Errors and Warnings in Zed
|
|
description: View and navigate errors, warnings, and code diagnostics from language servers in Zed.
|
|
---
|
|
|
|
# Diagnostics
|
|
|
|
Zed gets its diagnostics from the language servers and supports both push and pull variants of the LSP which makes it compatible with all existing language servers.
|
|
|
|
# Regular diagnostics
|
|
|
|
By default, Zed displays all diagnostics as underlined text in the editor and the scrollbar.
|
|
|
|
Editor diagnostics could be filtered with the
|
|
|
|
```json [settings]
|
|
"diagnostics_max_severity": null
|
|
```
|
|
|
|
editor setting (possible values: `"off"`, `"error"`, `"warning"`, `"info"`, `"hint"`, `null` (default, all diagnostics)).
|
|
|
|
The scrollbar ones are configured with the
|
|
|
|
```json [settings]
|
|
"scrollbar": {
|
|
"diagnostics": "all",
|
|
}
|
|
```
|
|
|
|
configuration (possible values: `"none"`, `"error"`, `"warning"`, `"information"`, `"all"` (default))
|
|
|
|
The diagnostics could be hovered to display a tooltip with a full, rendered diagnostic message.
|
|
Or, `editor::GoToDiagnostic` and `editor::GoToPreviousDiagnostic` could be used to navigate between diagnostics in the editor, showing a popover for the currently active diagnostic.
|
|
|
|
# Inline diagnostics (Error lens)
|
|
|
|
Zed supports showing diagnostics as a lens to the right of the code.
|
|
This is disabled by default, but can either be temporarily turned on (or off) using the editor menu, or permanently, using the
|
|
|
|
```json [settings]
|
|
"diagnostics": {
|
|
"inline": {
|
|
"enabled": true,
|
|
"max_severity": null, // same values as the `diagnostics_max_severity` from the editor settings
|
|
}
|
|
}
|
|
```
|
|
|
|
# Other UI places
|
|
|
|
## Project Panel
|
|
|
|
Project panel can have its entries coloured based on the severity of the diagnostics in the file.
|
|
|
|
To configure, use
|
|
|
|
```json [settings]
|
|
"project_panel": {
|
|
"show_diagnostics": "all",
|
|
}
|
|
```
|
|
|
|
configuration (possible values: `"off"`, `"errors"`, `"all"` (default))
|
|
|
|
## Editor tabs
|
|
|
|
Similar to the project panel, editor tabs can be colorized with the
|
|
|
|
```json [settings]
|
|
"tabs": {
|
|
"show_diagnostics": "off",
|
|
}
|
|
```
|
|
|
|
configuration (possible values: `"off"` (default), `"errors"`, `"all"`)
|