Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 24 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,41 @@
# Rstack Editor

<p>
<a href="https://github.com/rstackjs/rstack-editor/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/rstackjs/rstack-editor/ci.yml?branch=main&style=flat-square&colorA=564341&colorB=EDED91" alt="CI status" /></a>
<a href="https://marketplace.visualstudio.com/items?itemName=rstack.rstack"><img src="https://vsmarketplacebadges.dev/version/rstack.rstack.svg?style=flat-square&label=VS%20Marketplace&labelColor=564341&color=EDED91" alt="VS Marketplace version" /></a>
<a href="https://open-vsx.org/extension/rstack/rstack"><img src="https://img.shields.io/open-vsx/v/rstack/rstack?style=flat-square&label=Open%20VSX&colorA=564341&colorB=EDED91" alt="Open VSX version" /></a>
<a href="https://github.com/rstackjs/rstack-editor/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" /></a>
</p>

Rstack Editor provides unified editor support for [Rstack](https://rstack.rs), the fast, unified JavaScript toolchain for developers and agents. It integrates [Rslint](https://github.com/web-infra-dev/rslint), [Rstest](https://github.com/web-infra-dev/rstest) and [rstack-cli](https://github.com/rstackjs/rstack-cli) into a single extension, so one install covers the whole toolchain.

> [!IMPORTANT]
>
> **Work in progress.** Rstack Editor is pre-1.0 and under active development. Settings, command ids and behavior can change between releases, and not every config source is wired up yet — see the roadmap below for what works today. Bug reports and feedback are very welcome.
> **Work in progress.** Rstack Editor is pre-1.0 and under active development. Settings, command ids and behavior can change between releases. Bug reports and feedback are very welcome.

## Install

| Registry | Editors | Version | Installs |
| --- | --- | --- | --- |
| [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=rstack.rstack) | VS Code | [![VS Marketplace version](https://vsmarketplacebadges.dev/version-short/rstack.rstack.svg?style=flat-square&label=version&labelColor=564341&color=EDED91)](https://marketplace.visualstudio.com/items?itemName=rstack.rstack) | [![VS Marketplace installs](https://vsmarketplacebadges.dev/installs-short/rstack.rstack.svg?style=flat-square&labelColor=564341&color=EDED91)](https://marketplace.visualstudio.com/items?itemName=rstack.rstack) |
| [Open VSX Registry](https://open-vsx.org/extension/rstack/rstack) | Cursor, Trae, VSCodium, and other VS Code forks | [![Open VSX version](https://img.shields.io/open-vsx/v/rstack/rstack?style=flat-square&label=version&colorA=564341&colorB=EDED91)](https://open-vsx.org/extension/rstack/rstack) | [![Open VSX downloads](https://img.shields.io/open-vsx/dt/rstack/rstack?style=flat-square&label=downloads&colorA=564341&colorB=EDED91)](https://open-vsx.org/extension/rstack/rstack) |

Or search for `rstack.rstack` in the editor's Extensions view.

## Documentation

- [VS Code extension](./packages/vscode/README.md) — installation, features, detection and settings
- [Rstack](https://rstack.rs) · [Rslint](https://rslint.rs) · [Rstest](https://rstest.rs) — the tools the extension integrates

## Packages

| Name | Description |
| --- | --- |
| [`packages/vscode`](./packages/vscode) | The VS Code extension (`rstack.rstack`) |

## Roadmap
## Contributing

The extension takes its configuration from five sources. Tool-native configs and each supported `define.*()` bridge are available today.

| Config source | Status |
| --- | --- |
| `rslint.config.*` | **Supported.** Diagnostics, quick fixes and the language server, all resolved from the `@rslint/core` installed in your project. |
| `rstest.config.*` | **Supported.** Test discovery, run and debug, watch mode, coverage and snapshot updates in the Test Explorer. |
| `define.test()` in `rstack.config.*` | **Supported.** Tests run through the same config shim `rs test` uses, so the editor and the CLI resolve the config identically. |
| `define.fmt()` in `rstack.config.*` | **Supported.** Document formatting through the project-local `rs fmt` language server (`rs fmt --lsp`), one per workspace folder, loading the config from the folder root — the same config `rs fmt` run there would use. |
| `define.lint()` in `rstack.config.*` | **Supported.** In a folder without a native Rslint config, diagnostics come through rstack's published lint shim — the same config path `rs lint` uses. |
Contributions are welcome! Please read the [Contributing Guide](./CONTRIBUTING.md) for setup, workflow and release details.
Comment thread
fi3ework marked this conversation as resolved.

## License

Expand Down