Handle multi-root Workspaces

[IgorKarpiuk]

What should we improve?

Users can have several projects in vs code workspace . Each project can have its own configuration file. The goal is to find the correct configuration depending on the file selected by the user and highlight errors and warnings in OpenAPI definition files according to the configuration

How should we improve it?

The extension should select the root folder and look for the configuration file there depending on the file opened by the user

Why should we improve it?

Currently, the extension does not work correctly with Multi-root Workspaces

Describe alternatives you've considered

To do nothing

Additional context

Multi-root Workspaces

[unional]

Just sharing that I also have the same need.

[jeremyfiel]

Would be great to have this functionality! @lornajane

[adamaltman]

Does the apis feature of the config file, where you can specify different paths to the root files serve as an alternative?

apis:
  example1: 
     root: ./path/to/file.yaml
     rules:
       # some rules
  example2: 
     root: ./path/to/file.yaml
     rules:
       # some rules

[IgorKarpiuk]

@adamaltman I think it does not. Because we always select the configuration file from the root of the first workspace. if the order of the workspaces is changed or the user closes the workspace with the configuration file, it will stop working.

[piotr-cz]

I failed to use latest version 0.6.5 with multi-root workspaces.

I've tried to place redocly.yaml at same directory level as Project.code-workspace file, with references to folders in apis: section but that didn't work.

[tatomyr]

@piotr-cz was that working with a previous version?

[piotr-cz]

@tatomyr
As far as I know, this was never working - but I started to use this extension since this april

I think the correct place for redocly.yaml file should be in a folder (project) of a code-workspace file,
just as .nvmrc, vite.config.ts and so on

[tatomyr]

@piotr-cz we look for redocly.yaml in the project root 🙂. This works in most cases, except for monorepos. Could you share your project structure and where you would expect to place redocly.yaml? Maybe we can find some workaround.

[piotr-cz]

My Project structure:

📦 root
├── Project.code-workspace  {"folders": [{ "path": "api", "name": "API" }, {"path": "client", "name": "Client"}] }
│
├── 📂 api
│   ├── openapi.yaml
│   ├── package.json
│   └── redocly.yaml  isn't picked by VSCode Extension
│
└── 📂 client
    └── package.json

[tatomyr]

@piotr-cz I see. Yeah, this feature hasn't been implemented yet. As a temporary workaround, you can try adding a redocly.yaml to the project root that references the nested one:

extends:
- api/redocly.yaml

That should make it work.