Sync Cargo.toml dependencies when generating code

[lorisleiva]

This PR adds 2 new options to the renderer which enable the Cargo.toml of the generated client to be created and/or updated such that its dependencies match what the generated code expect.

These options are:

• syncCargoToml: Whether or not we should update the existing Cargo.toml if some of its dependencies are falling behind or create a new Cargo.toml if missing (default: false). Note that this requires the existing crateFolder option to be provided for this to work as, otherwise, we won't know where to look for the Cargo.toml. A warning message is logged if this is not the case.
• dependencyVersions: A Record<string, CargoDependency> such that keys are the name of external dependencies — e.g. solana-pubkey — and the values are the version ranges we want to support — e.g. ^3.0 — or the equivalent dependency object — e.g. { version: "^3.0" }. The renderer offer default values for all external dependencies it relies on but this option may be used to override some of these values or add new ones.

Additionally, even when the syncCargoToml option is false, if the crateFolder is provided and there is an existing Cargo.toml, the renderer will go through its dependencies and check if any are missing or out of date for the generated code. A warning message will be logged if that's the case.

Note, when bumping the Rust renderer to the next major version (v2), we can make sure the required path is not the path to the generated folder but the crate folder instead. That way, we can make the syncCargoToml option default to true. This would mean crateFolder would be replaced by generatedFolder and would default to src/generated.

[changeset-bot]

🦋 Changeset detected

Latest commit: 5fdbdfd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@codama/renderers-rust	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[lorisleiva]

• Sync Cargo.toml dependencies when generating code #70 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[lorisleiva]

This section requires extra attention when reviewing. It defines the default version requirements for the generated code. Note that if the user uses stricter or newer versions for some of these, they will not be updated.