Allow declaring cfg groups in rust-project.json, to help sharing common cfgs

Author: ChayimFriedman2

crates/project-model/src/project_json.rs

@@ -98,7 +98,7 @@ impl ProjectJson {
             crates: data
                 .crates
                 .into_iter()
-                .map(|crate_data| {
+                .map(|mut crate_data| {
                     let root_module = absolutize_on_base(crate_data.root_module);
                     let is_workspace_member = crate_data
                         .is_workspace_member
@@ -122,6 +122,27 @@ impl ProjectJson {
                         None => None,
                     };
 
+                    crate_data.cfg_groups.sort_unstable();
+                    crate_data.cfg_groups.dedup();
+                    let cfg = crate_data
+                        .cfg_groups
+                        .iter()
+                        .flat_map(|cfg_extend| {
+                            let cfg_group = data.cfg_groups.get(cfg_extend);
+                            match cfg_group {
+                                Some(cfg_group) => cfg_group.0.iter().cloned(),
+                                None => {
+                                    tracing::error!(
+                                        "Unknown cfg group `{cfg_extend}` in crate `{}`",
+                                        crate_data.display_name.as_deref().unwrap_or("<unknown>"),
+                                    );
+                                    [].iter().cloned()
+                                }
+                            }
+                        })
+                        .chain(crate_data.cfg.0)
+                        .collect();
+
                     Crate {
                         display_name: crate_data
                             .display_name
@@ -131,7 +152,7 @@ impl ProjectJson {
                         edition: crate_data.edition.into(),
                         version: crate_data.version.as_ref().map(ToString::to_string),
                         deps: crate_data.deps,
-                        cfg: crate_data.cfg,
+                        cfg,
                         target: crate_data.target,
                         env: crate_data.env,
                         proc_macro_dylib_path: crate_data
@@ -306,11 +327,17 @@ pub enum RunnableKind {
 pub struct ProjectJsonData {
     sysroot: Option<Utf8PathBuf>,
     sysroot_src: Option<Utf8PathBuf>,
+    #[serde(default)]
+    cfg_groups: FxHashMap<String, CfgList>,
     crates: Vec<CrateData>,
     #[serde(default)]
     runnables: Vec<RunnableData>,
 }
 
+#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq, Default)]
+#[serde(transparent)]
+struct CfgList(#[serde(with = "cfg_")] Vec<CfgAtom>);
+
 #[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
 struct CrateData {
     display_name: Option<String>,
@@ -319,9 +346,11 @@ struct CrateData {
     #[serde(default)]
     version: Option<semver::Version>,
     deps: Vec<Dep>,
+    // Cannot be a hashset because that would mean an inconsistent order.
+    #[serde(default)]
+    cfg_groups: Vec<String>,
     #[serde(default)]
-    #[serde(with = "cfg_")]
-    cfg: Vec<CfgAtom>,
+    cfg: CfgList,
     target: Option<String>,
     #[serde(default)]
     env: FxHashMap<String, String>,

crates/project-model/src/tests.rs

@@ -233,6 +233,12 @@ fn rust_project_hello_world_project_model() {
     );
 }
 
+#[test]
+fn rust_project_cfg_groups() {
+    let (crate_graph, _proc_macros) = load_rust_project("cfg-groups.json");
+    check_crate_graph(crate_graph, expect_file!["../test_data/output/rust_project_cfg_groups.txt"]);
+}
+
 #[test]
 fn rust_project_is_proc_macro_has_proc_macro_dep() {
     let (crate_graph, _proc_macros) = load_rust_project("is-proc-macro-project.json");

crates/project-model/test_data/cfg-groups.json

@@ -0,0 +1,26 @@
+{
+    "sysroot_src": null,
+    "cfg_groups": {
+        "group1": ["group1_cfg=\"some_config\"", "group1_other_cfg=\"other_config\""],
+        "group2": ["group2_cfg=\"yet_another_config\""]
+    },
+    "crates": [
+        {
+            "display_name": "hello_world",
+            "root_module": "$ROOT$src/lib.rs",
+            "edition": "2018",
+            "cfg_groups": ["group1", "group2"],
+            "deps": [],
+            "is_workspace_member": true
+        },
+        {
+            "display_name": "other_crate",
+            "root_module": "$ROOT$src/lib.rs",
+            "edition": "2018",
+            "cfg_groups": ["group2"],
+            "cfg": ["group2_cfg=\"fourth_config\"", "unrelated_cfg"],
+            "deps": [],
+            "is_workspace_member": true
+        }
+    ]
+}