Editor Setup
Editor setup matters because Riot is workspace-shaped.
If the CLI thinks in packages and the editor thinks in isolated files, the user experience will drift fast. Diagnostics, formatting, and command execution will all start disagreeing about what the project even is.
The goal of editor setup is simple:
- open the correct root
- use Riot-aware diagnostics and formatting
- make build/test/run loops easy to trigger repeatedly
The basic rule
Section titled “The basic rule”Open the workspace root, not a random nested directory.
That one choice controls a lot:
- whether the editor sees the right manifests
- whether tasks and commands execute in the right place
- whether generated paths and diagnostics make sense
The healthy setup
Section titled “The healthy setup”A healthy editor setup usually has these properties:
- diagnostics line up with
riot check - formatting lines up with
riot fmt - quick fixes line up with
riot fix - terminal tasks run
riot build,riot run, andriot testfrom the workspace root
If the editor is telling you something different from the CLI, the editor is probably wrong.
Choose your editor guide
Section titled “Choose your editor guide”Both should ultimately support the same workflow. The difference is only how the commands are surfaced.