Skip to content

Commit

Permalink
ruff server: Add tracing setup guide to Helix documentation (#11883)
Browse files Browse the repository at this point in the history
A follow-up to [this
suggestion](#11747 (comment))
on the tracing PR.
  • Loading branch information
snowsignal authored Jun 18, 2024
1 parent ffc9852 commit c53d55a
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion crates/ruff_server/docs/setup/HELIX.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,48 @@ You can pass settings into `ruff server` using `[language-server.ruff.config.set

```toml
[language-server.ruff.config.settings]
line-length = 80
lineLength = 80
[language-server.ruff.config.settings.lint]
select = ["E4", "E7"]
preview = false
[language-server.ruff.config.settings.format]
preview = true
```

By default, Ruff does not log anything to Helix. To enable logging, set the `RUFF_TRACE` environment variable
to either `messages` or `verbose`.

```toml
[language-server.ruff]
command = "ruff"
args = ["server", "--preview"]
environment = { "RUFF_TRACE" = "messages" }
```

> \[!NOTE\]
> `RUFF_TRACE=verbose` does not enable Helix's verbose mode by itself. You'll need to run Helix with `-v` for verbose logging.
To change the log level for Ruff (which is `info` by default), use the `logLevel` setting:

```toml
[language-server.ruff]
command = "ruff"
args = ["server", "--preview"]
environment = { "RUFF_TRACE" = "messages" }

[language-server.ruff.config.settings]
logLevel = "debug"
```

You can also divert Ruff's logs to a separate file with the `logFile` setting:

```toml
[language-server.ruff]
command = "ruff"
args = ["server", "--preview"]
environment = { "RUFF_TRACE" = "messages" }

[language-server.ruff.config.settings]
logLevel = "debug"
logFile = "/Users/developer/.cache/helix/ruff.log"
```

0 comments on commit c53d55a

Please sign in to comment.