backtrace-ls 0.0.5

See failed assertions as diagnostic messages next to your test code.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

# Backtrace-LS

LSP server that **shows failed assertion messages** as diagnostics in your code.

Additional features:

- Backtraces are parsed to mark any stack frame locations inline.
- You can use code actions to navigate between failure, stack frames and context.

Works out of the box in Helix (or any editor with an LSP client):

![(screenshot of code action in helix)](./helix-action.png)

## Installation

```sh
cargo install backtrace-ls
```

## Editor Setup

Try out without installing by opening the demo project with Helix:

```bash
cd demo/rust
hx -v src/lib.rs
```

You should see the failing assertions inline next to test code.

Helix (`~/.config/helix/languages.toml`):

```toml
[language-server.backtrace-ls]
command = "backtrace-ls"

[[language]]
name = "rust"
language-servers = ["backtrace-ls", "rust-analyzer"]
```

Neovim:

```lua
vim.lsp.start({ name = "backtrace-ls", cmd = { "backtrace-ls" }, root_dir = vim.fn.getcwd() })
```

## Configuration

The language server auto-detects the test runner from your project files (e.g., `Cargo.toml`, `package.json`, `go.mod`).

Create `.backtrace-ls.toml` in your project root to customize behavior:

```toml
# Explicitly specify the test runner (optional)
# If not set, auto-detected from project files
runner = "cargo-test"

# Pass extra arguments to the test command
extra_args = ["--workspace", "--lib"]

# Show diagnostics for the entire function instead of just the assertion line
show_surrounding_function = false
```

CLI options:

```bash
# Explicitly specify runner (overrides auto-detection)
backtrace-ls --runner cargo-test

# Set workspace root for detection
backtrace-ls --path /path/to/project

# Run in text mode with file watching
backtrace-ls --text --verbose
```

Supported runners:

- **Rust**: `cargo-test`, `cargo-nextest`
- **JavaScript/TypeScript**: `jest`, `vitest`, `node-test`, `deno`
- **Go**: `go-test`
- **PHP**: `phpunit`
- **C++**: `gtest`, `catch2`

**Note**: If multiple project types are detected, use `--runner` or the `runner` config option to specify which one to use.

## Contributing

You can debug more easily by running in `--text` and `--verbose` mode:

```bash
cargo run -- --path demo/rust --text -v
```

## License

MIT