Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

doc(editors): Clarify Rome discovery #3639

Merged
merged 1 commit into from
Nov 10, 2022
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
8 changes: 5 additions & 3 deletions editors/vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,11 @@ The extension automatically loads the `rome.json` file from the workspace’s ro

## Rome Resolution

The extension tries to use Rome from your project's local dependencies (`node_modules/rome`). We recommend adding Rome as a project dependency to ensure that NPM scripts and the extension use the same Rome version.
The extension uses the Rome version shipped with the extension. We plan to automatically detect the Rome version from the project in an upcoming release.

The extension uses the Rome version bundled with the extension if the project has no dependency on Rome.
<!-- The extension tries to use Rome from your project's local dependencies (`node_modules/rome`). We recommend adding Rome as a project dependency to ensure that NPM scripts and the extension use the same Rome version.

The extension uses the Rome version bundled with the extension if the project has no dependency on Rome. -->

## Usage

Expand Down Expand Up @@ -84,7 +86,7 @@ Rome isn't yet able to pick up the `rome.json` configuration in [multi-root work

### The extension uses an outdated version of Rome

Make sure to restart VS Code or restart Rome’s LSP server after updating Rome in your `package.json`. To stop Rome’s LSP, send the `stop` command (VS will start a new LSP instance for you):
Make sure to restart Rome’s LSP server after updating the extension. To stop Rome’s LSP, send the `stop` command (VS will start a new LSP instance for you):

```bash
npx rome stop
Expand Down