Add cargo workspace feature

[metaclips]

Navigating through different crates from the root directory with rust analyser fails as rust analyzer can't discover workspace, a workaround is to open individual crate directly on my code editor which is not ergonomic. Can we use Rust cargo workspace?

[metaclips]

Would love to take this up if agreed!😁

[metaclips]

Want to know if this something that can be taken on @mrinalwadhwa @jared-s

[jdspdx]

Heya @metaclips !

The reason that we currently don't use a workspace, is that workspaces use a shared Cargo.lock file. Since we distribute each crate individually, it's important that we track dependencies per crate.

We have gone back and forth on this, and most of us have settled on creating a local workspace that we add to .gitignore. This makes it convenient for development but still allows us to have individual lock files.

[metaclips]

Haaa, makes a lot of sense. Having a local cargo.toml should do. Thanks.

[jdspdx]

Thanks for checking out the library! Please let me know if you've got any questions!

[thomcc]

This seems worth documenting somewhere — I was about to file an issue about it when I encountered this.

There are also a few other options for per-crate dependency tracking — even just cargo tree -p $pkg will tell you a good amount, or something like getting cargo deny/cargo license to emit the info for each crate (you can even check that this is accurate as part of CI)

Alternatively, supporting rust-analyzer directly might be possible — it doesn't require use of cargo, and so cargo workspaces are optional as well... https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc discusses some more advance configuration options.

[metaclips]

Thanks for this @thomcc. I'm currently checking this out implementing rust-analyzer support.

Since we are indicating it as a non-cargo project, we can't automatically use the configurations specified in cargo.toml and need to indicate all dependencies in a file rust-project.json at the root path, for all crates. There's also inter-dependency where one crate depends on the other locally.

Current work here https://github.com/metaclips/ockam/tree/add-rust-project will keep on investigating.

[metaclips]

@thomcc @mrinalwadhwa @jared-s so I found an alternative using rust-analyzer.linkedProjects and created a PR #1579. Do review and give feedbacks.