A comment to help ProjectJsonData stay backwards-compatible

cormacrelf · cormacrelf · commit fa181ab80f57 · 2026-01-09T14:19:23.000+11:00
Makes clear to future editors of this code that they should add #[serde(default)]
to new fields.
diff --git a/crates/project-model/src/project_json.rs b/crates/project-model/src/project_json.rs
@@ -383,6 +383,8 @@ pub struct ProjectJsonData {
     crates: Vec<CrateData>,
     #[serde(default)]
     runnables: Vec<RunnableData>,
+    //
+    // New fields should be Option or #[serde(default)]. This applies to most of this datastructure.
 }
 
 #[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq, Default)]

Original file line number	Diff line number	Diff line change
`@@ -383,6 +383,8 @@ pub struct ProjectJsonData {`
`383`	`383`	`crates: Vec<CrateData>,`
`384`	`384`	`#[serde(default)]`
`385`	`385`	`runnables: Vec<RunnableData>,`
	`386`	`+ //`
	`387`	`+ // New fields should be Option or #[serde(default)]. This applies to most of this datastructure.`
`386`	`388`	`}`
`387`	`389`
`388`	`390`	`#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq, Default)]`