diff --git a/README.md b/README.md index a4d5dba..d3ae583 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,40 @@ Rstack Editor provides unified editor support for [Rstack](https://rstack.rs), t Or search for `rstack.rstack` in the editor's Extensions view. +## Supported versions + +The extension resolves the tools from your project's `node_modules` and checks them against a support matrix at runtime: + +| Package | Required | +| -------------- | --------- | +| `@rslint/core` | `>=0.8.0` | +| `@rstest/core` | `>=0.6.0` | +| `rstack` | `>=0.6.1` | + ## 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 +## Roadmap + +Rstack Editor is where Rstack's editor support converges: it replaces the standalone [`rstack.rslint`](https://marketplace.visualstudio.com/items?itemName=rstack.rslint) and [`rstack.rstest`](https://marketplace.visualstudio.com/items?itemName=rstack.rstest) extensions with a single install. Where that migration stands: + +| Milestone | Status | +| --- | --- | +| Unified [Rstack](#install) extension on VS Code Marketplace and Open VSX | ✅ Shipped | +| Core features: linting (Rslint), testing (Rstest), formatting (`rs fmt`) | ✅ Shipped | +| Deprecation notices on the standalone extensions' marketplace listings | 🚧 Planned | +| Sunset of the standalone extensions (final releases, listings pointing here) | 🚧 Planned | +| 1.0: stable settings and command ids | 🚧 Planned | +| Support for other editors (e.g. Zed) | 💡 Exploring | + +### About the standalone extensions + +The standalone extensions are retired: all new editor features land in Rstack Editor. They remain published and keep working while the transition is underway, but we recommend switching now — install the [Rstack](#install) extension and disable or uninstall the standalone extensions so only one copy of each tool runs. + +Settings and keybindings are **not** migrated automatically: re-enter them under the `rstack.*` keys following the [migration notes](./packages/vscode/README.md#coming-from-the-standalone-extensions). + ## Packages | Name | Description | diff --git a/packages/vscode/README.md b/packages/vscode/README.md index aa63951..1b23fc1 100644 --- a/packages/vscode/README.md +++ b/packages/vscode/README.md @@ -42,8 +42,6 @@ The project-resolved packages are checked against a support matrix at runtime; a | `@rstest/core` | `>=0.6.0` | | `rstack` | `>=0.6.1` | -`rstack` 0.6.1 and `@rslint/core` 0.8.0 provide the explicit lint config protocol used by the Rstack bridge. Older releases report `version mismatch`. - ## Auto-fix on save (Rslint) To automatically fix lint issues when saving, add this to your VS Code settings (`.vscode/settings.json`): @@ -106,7 +104,7 @@ Formatting runs one `rs fmt` language server per workspace folder, which loads ` ## Coming from the standalone extensions -Settings and keybindings are not carried over from the retired `rstack.rslint` / `rstack.rstest` extensions: re-enter your settings under the `rstack.*` keys listed above and re-bind any keybinding to the new `rstack.*` command ids. Legacy `rslint.binPath` / `rslint.customBinPath` have no equivalent — use `rstack.rslint.corePath` to point at an `@rslint/core` package directory if you still need an override. +Disable or uninstall the retired `rstack.rslint` / `rstack.rstest` extensions so only one copy of each tool runs. Settings and keybindings are not carried over from them: re-enter your settings under the `rstack.*` keys listed above and re-bind any keybinding to the new `rstack.*` command ids. Legacy `rslint.binPath` / `rslint.customBinPath` have no equivalent — use `rstack.rslint.corePath` to point at an `@rslint/core` package directory if you still need an override. ## Community