Add --health command for troubleshooting

[sudormrfbin]

NOTE: The command has been renamed to --health.

---

Fixes #976.

Adds a --checkhealth flag to the helix binary which can be used to quickly diagnose some common problems like an LSP not being installed or not found in $PATH, non-existant runtime directory, etc.

$ hx --checkhealth
Config file: /home/gokul/.config/helix/config.toml
Language file: default
Log file: /home/gokul/.cache/helix/helix.log
Runtime directory: /home/gokul/.config/helix/runtime
Runtime directory is symlinked to /home/gokul/Projects/helix/runtime/

$ hx --checkhealth rust
Configured language server: rust-analyzer
Binary for language server: /usr/bin/rust-analyzer
Configured debug adapter: lldb-vscode
Binary for debug adapter: /usr/bin/lldb-vscode
Highlight queries: Found
Textobject queries: Found
Indent queries: Found

$ hx --checkhealth mint
Configured language server: mint
Binary for language server: Not found in $PATH
Configured debug adapter: None
Highlight queries: Not found
Textobject queries: Not found
Indent queries: Not found

$ hx --checkhealth erlang
Configured language server: None
Configured debug adapter: None
Highlight queries: Found
Textobject queries: Not found
Indent queries: Not found

$ hx --checkhealth rut
Given language not found
Did you mean one of these: rust, ruby, racket, regex, rescript ?

(Run locally to see some nice colors :)

[the-mikedavis]

This is pretty sweet!

A bit of a nit: what do you think about --check-health for the flag?

[archseer]

A bit of a nit: what do you think about --check-health for the flag?

Or even --check/--health

[archseer]

Also, what about using a table like in the original proposal? Or outputting all entries. Would make it easier to see everything that's available and correctly detected.

[sudormrfbin]

I'm trying to display tables using tui's Table widget but I can't get anything rendered to screen. Since we don't display editor and exit early all initializations have to be done manually:

let backend = CrosstermBackend::new(std::io::stdout());
let mut terminal = tui::Terminal::new(backend).unwrap();
let surface = terminal.current_buffer_mut();
let area = *surface.area();

let table = Table::new(vec![
    Row::new(vec!["item1", "items2"]),
    Row::new(vec!["item3", "items4"]),
])
.header(Row::new(vec!["header1", "header2"]));

table.render(area, surface);
terminal.draw(None, helix_view::graphics::CursorKind::Block).unwrap();

(Also renamed the command to --health)

[pickfire]

I don't get this, the error messages are not that helpful for me. I don't know what is not found, I am curious what binary should be found for dap to work since I never used dap, I did which dap but nothing shows up.

Binary for debug adapter: Not found in $PATH

[archseer]

I'm trying to display tables using tui's Table widget but I can't get anything rendered to screen.

I'd avoid that and just space every column out with a double tab for now. Or you could use the underlying types to compute column widths then render by hand. The tui types are intended to work with a fixed screen size (no scrolling)

[sudormrfbin]

Added a tabular view that's displayed with a bare --health. Since there's limited space (even though space for each column is dynamically calculated) the format is a bit dependent on color, to signify for example whether an LSP is found in $PATH (red for not found, green for found, yellow for no configuration):

I don't get this, the error messages are not that helpful for me. I don't know what is not found, I am curious what binary should be found for dap to work since I never used dap, I did which dap but nothing shows up.

@pickfire "Configured debug adapter" shows the name of the binary that's used for dap, similar to the configured language server line.

[pickfire]

Looks good to me, seemed to work nicely with 80 characters terminal as well.