read package/workspace config from Cargo manifest #799
Conversation
src/manifest.rs
Outdated
| pub(crate) fn deserialize_lint_table( | ||
| metadata: serde_json::Value, | ||
| ) -> anyhow::Result<Option<OverrideMap>> { | ||
| let table: Option<LintTable> = serde_json::from_value(metadata)?; |
There was a problem hiding this comment.
We should be able to avoid the .clone() when calling this function by making it accept &Value and then using the trick described in this post: https://users.rust-lang.org/t/serde-from-value-moves-my-value-but-i-want-i-returned-to-me-on-err/69621
src/lib.rs
Outdated
| @@ -484,6 +485,11 @@ note: skipped the following crates since they have no library target: {skipped}" | |||
| ); | |||
| } | |||
|
|
|||
| let workspace_overrides = | |||
| manifest::deserialize_lint_table(metadata.workspace_metadata.clone()) | |||
| .context("[workspace.metadata.cargo-semver-checks] table is incorrect")? | |||
There was a problem hiding this comment.
nit: word choice, here and below as well
| .context("[workspace.metadata.cargo-semver-checks] table is incorrect")? | |
| .context("[workspace.metadata.cargo-semver-checks] table is invalid")? |
src/lib.rs
Outdated
| manifest::deserialize_lint_table(selected.metadata.clone()) | ||
| .with_context(|| { | ||
| format!( | ||
| "{} [package.metadata.cargo-semver-checks] table is incorrect", |
There was a problem hiding this comment.
Idea: do we by any chance know the path to the Cargo.toml file here? If it isn't too difficult, it might be useful to not just say which crate had the invalid table but also give a path to it.
This is because in some cases, projects may contain more than one crate by the same name — for example, see #462. In such cases, knowing the Cargo.toml path would be very helpful to the user.
If it's too hard to do now, we can just open a C-enhancement issue for the idea and tackle it another time.
- make `manifest::deserialize_lint_table` take a `&serde_json::Value` - show manifest path on invalid `[package.metadata]` table - change "incorrect table" -> "invalid table"
|
Awesome! 🚀 |
Deserializes lint table from the relevant
[workspace.metadata]and[package.metadata]tables, if they exist.Notes:
Cargo.tomlmanifest and run thecargo metadatacommand - that is, we won't be able to configure lint levels when the rustdoc source isRustdoc | Revision | VersionFromRegistryas of current without something like CLI flags:run_check_releasefunction. takeaway is that when we don't have the manifest to read the metadata, we just pass an emptyOverrideStackas overrideshere's the beginnings of a test crate, although I just printed the passed overrides for now:
test output
run with `cargo r -- semver-checks --baseline-root test_crates/workspace-overrides/baseline --manifest-path test_crates/workspace-overrides/current/pkg/Cargo.toml -vvv`overrides: OverrideStack([{"function_missing": QueryOverride { required_update: Some(Minor), lint_level: Some(Warn) }, "module_missing": QueryOverride { required_update: None, lint_level: Some(Allow) }}, {"function_missing": QueryOverride { required_update: None, lint_level: Some(Deny) }, "module_missing": QueryOverride { required_update: None, lint_level: Some(Warn) }}])