29 lines
1.4 KiB
Markdown
29 lines
1.4 KiB
Markdown
# Debug-information mode
|
|
|
|
Start the bridge with `--debug-mode` to include debug information in every LSP
|
|
hover response. In Helix, `space+k` displays the snapshot in the same popup as
|
|
normal rule help; on a line without findings it displays a debug-only popup.
|
|
The `Show VSG bridge debug information` source action remains as a fallback.
|
|
This mode is independent of both experimental correction flags.
|
|
|
|
Invoking the action displays a pretty-printed JSON snapshot containing:
|
|
|
|
- the bridge version and embedded commit, executable path, process ID, and
|
|
working directory;
|
|
- enabled debug and experimental modes;
|
|
- whether browser actions are allowed and the client advertised
|
|
`window/showDocument`;
|
|
- the VSG runner and exact configuration arguments;
|
|
- the URI that requested the action; and
|
|
- every open document's URI, version, UTF-8 byte and line counts, and current
|
|
diagnostic codes, messages, severities, sources, and ranges.
|
|
|
|
The report deliberately excludes document source text and environment
|
|
variables. In particular, it does not dump `PATH`, credentials, tokens, or the
|
|
contents of unsaved buffers. Configuration paths, document URIs, and diagnostic
|
|
messages are present; VSG messages can contain source identifiers, so inspect a
|
|
report before sharing it publicly.
|
|
|
|
Debug mode is disabled by default and does not alter diagnostics, formatting,
|
|
or correction behavior. Restart the language server after changing the flag.
|