# turbo-rust

A Turbo C-style editor for Rust, written in Go.

Built on **[turbo-core](https://rickub.com/turbo-editors/turbo-core)**, the library every Turbo editor shares. What is in this repository is the command, the profile that says this editor is for Rust, and the Rust scanner — about seven hundred lines. Everything else lives in the library.

A full-screen terminal IDE with the Borland furniture - a menu bar with hot keys, movable windows that cast shadows, modal dialogs, a clickable status bar — and the things a Rust editor needs today: syntax colouring that knows nested block comments and raw strings, loadable colour themes, completion from `rust-analyzer`, shell windows, per-project settings, a project tree, snippets, and the cargo toolchain a menu away.

```
 File  Edit  Search  Run  Options  Window  Snippets  Rust  Help
╔═[x]═════════════════════════════ adder.rs ════════════════════════════════1═[■]╗
║ 1 //! A demo crate.                                                           ▲║
║ 2 use std::collections::HashMap;                                              ▓║
║ 3                                                                             ░║
║ 4 /// Adds two numbers.                                                       ░║
║ 5 #[derive(Debug, Clone)]                                                     ░║
║ 6 pub struct Adder<'a> {                                                      ░║
║ 7     name: &'a str,                                                          ░║
║ 8     seen: HashMap<String, u64>,                                             ░║
║ 9 }                                                                           ▼║
║◄▓░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░►║
╚════════════════════════════════════════════════════════════════════════════════╝
 F1 Describe  F2 Save  F3 Open  F6 Window  F7 Next  F10 Menu       1:1  LSP: ready
```

## Getting started

```bash
make install
```

That builds the editor, puts it where your shell looks for commands, and reports what it found — the Go version it built with, where the binary went, whether that directory is on your `PATH`, and whether `rust-analyzer` is installed. Then, from any Rust crate:

```bash
turbo-rust src/main.rs
```

To build without installing, `make build` leaves the binary in `bin/turbo-rust`. From the module proxy instead of a checkout: `go install rickub.com/turbo-editors/turbo-rust@latest`.

For completion, install the Rust language server as well — the editor works without it, and says so on the status bar:

```bash
rustup component add rust-analyzer
```

The [tutorial](docs/en/tutorials/getting-started.md) walks through a first session in about ten minutes.

## Features

- **Every build knows what it is** — `turbo-rust -version` and **Help ▸ About** name the version, the commit and the build date, stamped in by the linker from `git describe` rather than read from a constant somebody forgot to bump
- **Turbo Vision interface** — menu bar with `Alt`-letter hot keys, overlapping movable and resizable windows, modal dialogs, mouse support throughout
- **Syntax colouring for nine languages** — Rust by a hand-written scanner that carries nested block comments, raw strings and multi-line strings exactly, and tells a lifetime from a character literal; plus TOML, Markdown, JavaScript, HTML and shell scripts from turbo-core
- **Themes** in TOML, eleven embedded — Borland navy, dark grey, paper white, espresso, Catppuccin Frappé and Latte, cobalt, Darcula and IntelliJ Light, and a hueless monochrome in both polarities — and any number of your own, with inheritance between files and between style keys. Every shipped theme is held to its contrast by tests
- **Per-project settings** in `.turbo-rust/settings.toml` — pin a theme, turn on automatic saving — created from a menu item and never by itself
- **Completion, hover and go-to-definition** from `rust-analyzer`, entirely optional
- **Terminal windows** — `F8` opens a real shell in a window, with its own VT/ANSI emulator, scrollback and job control (Linux, macOS and Windows)
- **Project tree** — `F9` shows the project's files in a window; walk it with the arrows and press Enter to open one
- **Snippets** — a `Snippets` menu built from `.turbo-rust/snippets.toml`, grouped into submenus and filtered by the file you are in; the chosen text is inserted at the cursor, re-indented to match
- **The cargo toolchain a menu away** — `Alt-T` runs `cargo fmt`, `cargo clippy`, `cargo build`, `cargo test` and `cargo run` from `.turbo-rust/tools.toml`, each showing its output where the tool asked: a popup that fills in as it goes, a terminal window, or an editing window to search. Files the command rewrote are re-read for you, and a tool naming a `menu` of its own gets that menu on the bar
- **Editing** with word movement, block indent, a shared clipboard, and undo that merges a run of typing into one step
- **Faithful files** — line endings and the trailing newline are preserved, and saving is atomic
- **Automatic saving**, off by default, writing a short while after you stop typing

## Commands

| Command | What it does |
| --- | --- |
| `make install` | Build and install onto your `PATH` |
| `make build` | Compile into `bin/turbo-rust` |
| `make test` | Run the whole test suite |
| `make check` | `fmt`, `vet`, then the tests — what a commit should pass |
| `make run FILE=x.go` | Build and start the editor on a file |
| `make help` | List every target |

```bash
turbo-rust [-theme name] [-no-lsp] [file...]
turbo-rust -list-themes
```

## Documentation

Full documentation in **[English](docs/en/)** and **[French](docs/fr/)**, organised by the [Diátaxis](https://diataxis.fr) method:

| | |
| --- | --- |
| **Tutorial** | [Your first file in Turbo Rust](docs/en/tutorials/getting-started.md) |
| **How-to** | [install](docs/en/how-to/install.md) · [run the tests](docs/en/how-to/run-the-tests.md) · [enable completion](docs/en/how-to/enable-completion.md) · [write a theme](docs/en/how-to/write-a-theme.md) · [move around a file](docs/en/how-to/navigate-code.md) · [use a terminal](docs/en/how-to/use-a-terminal.md) · [configure a project](docs/en/how-to/configure-a-project.md) · [browse a project](docs/en/how-to/browse-a-project.md) · [use snippets](docs/en/how-to/use-snippets.md) · [run cargo commands](docs/en/how-to/run-cargo-commands.md) · [make a release](docs/en/how-to/make-a-release.md) |
| **Reference** | [command line](docs/en/reference/cli.md) · [keyboard](docs/en/reference/keyboard.md) · [menus](docs/en/reference/menus.md) · [theme format](docs/en/reference/themes.md) · [terminal windows](docs/en/reference/terminal.md) · [project settings](docs/en/reference/project-settings.md) · [project tree](docs/en/reference/project-tree.md) · [languages](docs/en/reference/languages.md) · [snippets](docs/en/reference/snippets.md) · [Rust tools](docs/en/reference/rust-tools.md) · [the version number](docs/en/reference/versioning.md) |
| **Explanation** | [architecture](docs/en/explanation/architecture.md) · [design decisions](docs/en/explanation/design-decisions.md) · [colouring and completion](docs/en/explanation/colouring-and-completion.md) · [terminal windows](docs/en/explanation/terminal-windows.md) · [project settings](docs/en/explanation/project-settings.md) · [project tree](docs/en/explanation/project-tree.md) · [snippets](docs/en/explanation/snippets.md) · [Rust tools](docs/en/explanation/rust-tools.md) |

The library's packages each carry their own `README.md` beside the code, in [turbo-core](https://rickub.com/turbo-editors/turbo-core).

## Where the code is

| | |
| --- | --- |
| `main.go` | flags, the terminal, the wiring |
| `internal/rustlang` | the profile, the Rust scanner, the three starter files |
| everything else | [turbo-core](https://rickub.com/turbo-editors/turbo-core) |

The dependency graph is drawn in [`docs/diagrams/packages.drawio`](docs/diagrams/packages.drawio), checked against `go list`.

## Design in one line

Two dependencies — `tcell/v2` and `BurntSushi/toml` — and everything else from the standard library, including the tokeniser and the Language Server Protocol client. Both come through turbo-core; this repository adds none of its own. The [design decisions](docs/en/explanation/design-decisions.md) page explains why.

## Requirements

Go 1.26 or later to build it — the editor is written in Go even though it is an editor for Rust. A terminal with mouse reporting, which is all of them. `rust-analyzer` is optional.

## Licence

See [LICENSE](LICENSE).