You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Options for rendering diagnostics inside the text like shown below
```
fn main() {
let foo = bar;
└─ no such value in this scope
}
````
| Key | Description | Default |
|------------|-------------|---------|
|`cursor-line`| The minimum severity that a diagnostic must have to be shown inline on the line that contains the primary cursor. Set to `disable` to not show any diagnostics inline. This option does not have any effect when in insert-mode and will only take effect 350ms after moving the cursor to a different line. |`"disable"`|
|`other-lines`| The minimum severity that a diagnostic must have to be shown inline on a line that does not contain the cursor-line. Set to `disable` to not show any diagnostics inline. |`"disable"`|
|`prefix-len`| How many horizontal bars `─` are rendered before the diagnostic text. |`1`|
|`max-wrap`| Equivalent of the `editor.soft-wrap.max-wrap` option for diagnostics. |`20`|
|`max-diagnostics`| Maximum number of diagnostics to render inline for a given line |`10`|
The (first) diagnostic with the highest severity that is not shown inline is rendered at the end of the line (as long as its severity is higher than the `end-of-line-diagnostics` config option):
```
fn main() {
let baz = 1;
let foo = bar; a local variable with a similar name exists: baz
└─ no such value in this scope
}
```
The new diagnostic rendering is not yet enabled by default. As soon as end of line or inline diagnostics are enabled the old diagnostics rendering is automatically disabled. The recommended default setting are:
```
end-of-line-diagnostics = "hint"
[editor.inline-diagnostics]
cursor-line = "warning" # show warnings and errors on the cursorline inline
```
it is not clear to me, reading just this section, what values are ok to use for e.g. cursor-line .
The text was updated successfully, but these errors were encountered:
|`diagnostic-severity`| Minimal severity of diagnostic for it to be displayed. (Allowed values: `Error`, `Warning`, `Info`, `Hint`) |
not sure how this could be made easier to find? It was a bit of digging to find it. Should we add "see diagnostic-severity for admissible values", or "(Allowed values: Error, Warning, Info, Hint)", or something like this? Not sure how to document this effectively without putting the same boilerplate text again and again.
I think we can add a paragraph below the table in this section that says that the allowed values are "hint", "info", "warning" and "error". I think it would be ok to reference some other config option for config.toml but linking to the languages.toml config could be confusing. Also that section in languages.md is incorrect about the levels: it should be lowercase "hint"/"info"/etc. instead of "Hint"/"Info"/etc.
In https://github.com/helix-editor/helix/blob/master/book/src/editor.md , I could not find a documentation for the valid diagnostic levels; for example, in section
helix/book/src/editor.md
Lines 399 to 435 in af7a1fd
it is not clear to me, reading just this section, what values are ok to use for e.g.
cursor-line
.The text was updated successfully, but these errors were encountered: