feat(package): JSON message format for --list

Author: weihanglo

src/cargo/ops/cargo_package/mod.rs

@@ -1,4 +1,6 @@
-use std::collections::{BTreeSet, HashMap};
+use std::collections::BTreeMap;
+use std::collections::BTreeSet;
+use std::collections::HashMap;
 use std::fs::{self, File};
 use std::io::prelude::*;
 use std::io::SeekFrom;
@@ -32,6 +34,7 @@ use crate::util::HumanBytes;
 use crate::{drop_println, ops};
 use anyhow::{bail, Context as _};
 use cargo_util::paths;
+use cargo_util_schemas::messages;
 use flate2::{Compression, GzBuilder};
 use tar::{Builder, EntryType, Header, HeaderMode};
 use tracing::debug;
@@ -277,7 +280,23 @@ fn do_package<'a>(
                     }
                 }
                 PackageMessageFormat::Json => {
-                    let _ = ws.gctx().shell().print_json(&HashMap::<(), ()>::new());
+                    let message = messages::PackageList {
+                        id: pkg.package_id().to_spec(),
+                        files: BTreeMap::from_iter(ar_files.into_iter().map(|f| {
+                            let file = match f.contents {
+                                FileContents::OnDisk(path) => messages::PackageFile::Copy { path },
+                                FileContents::Generated(
+                                    GeneratedFile::Manifest(path)
+                                    | GeneratedFile::Lockfile(Some(path)),
+                                ) => messages::PackageFile::Generate { path: Some(path) },
+                                FileContents::Generated(
+                                    GeneratedFile::VcsInfo(_) | GeneratedFile::Lockfile(None),
+                                ) => messages::PackageFile::Generate { path: None },
+                            };
+                            (f.rel_path, file)
+                        })),
+                    };
+                    let _ = ws.gctx().shell().print_json(&message);
                 }
             }
         } else {

tests/testsuite/package_message_format.rs

@@ -117,7 +117,26 @@ fn single_package() {
         .with_stdout_data(
             str![[r#"
 [
-  {}
+  {
+    "files": {
+      "Cargo.lock": {
+        "kind": "generate"
+      },
+      "Cargo.toml": {
+        "kind": "generate",
+        "path": "[ROOT]/foo/Cargo.toml"
+      },
+      "Cargo.toml.orig": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/Cargo.toml"
+      },
+      "src/lib.rs": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/src/lib.rs"
+      }
+    },
+    "id": "path+[ROOTURL]/foo#0.0.0"
+  }
 ]
 "#]]
             .is_json()
@@ -133,7 +152,27 @@ fn single_package() {
         .with_stdout_data(
             str![[r#"
 [
-  {}
+  {
+    "files": {
+      "Cargo.lock": {
+        "kind": "generate",
+        "path": "[ROOT]/foo/Cargo.lock"
+      },
+      "Cargo.toml": {
+        "kind": "generate",
+        "path": "[ROOT]/foo/Cargo.toml"
+      },
+      "Cargo.toml.orig": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/Cargo.toml"
+      },
+      "src/lib.rs": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/src/lib.rs"
+      }
+    },
+    "id": "path+[ROOTURL]/foo#0.0.0"
+  }
 ]
 "#]]
             .is_json()
@@ -184,8 +223,46 @@ fn workspace() {
         .with_stdout_data(
             str![[r#"
 [
-  {},
-  {}
+  {
+    "files": {
+      "Cargo.lock": {
+        "kind": "generate"
+      },
+      "Cargo.toml": {
+        "kind": "generate",
+        "path": "[ROOT]/foo/gondor/Cargo.toml"
+      },
+      "Cargo.toml.orig": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/gondor/Cargo.toml"
+      },
+      "src/lib.rs": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/gondor/src/lib.rs"
+      }
+    },
+    "id": "path+[ROOTURL]/foo/gondor#0.0.0"
+  },
+  {
+    "files": {
+      "Cargo.lock": {
+        "kind": "generate"
+      },
+      "Cargo.toml": {
+        "kind": "generate",
+        "path": "[ROOT]/foo/rohan/Cargo.toml"
+      },
+      "Cargo.toml.orig": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/rohan/Cargo.toml"
+      },
+      "src/lib.rs": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/rohan/src/lib.rs"
+      }
+    },
+    "id": "path+[ROOTURL]/foo/rohan#0.0.0"
+  }
 ]
 "#]]
             .is_json()
@@ -201,8 +278,48 @@ fn workspace() {
         .with_stdout_data(
             str![[r#"
 [
-  {},
-  {}
+  {
+    "files": {
+      "Cargo.lock": {
+        "kind": "generate",
+        "path": "[ROOT]/foo/Cargo.lock"
+      },
+      "Cargo.toml": {
+        "kind": "generate",
+        "path": "[ROOT]/foo/gondor/Cargo.toml"
+      },
+      "Cargo.toml.orig": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/gondor/Cargo.toml"
+      },
+      "src/lib.rs": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/gondor/src/lib.rs"
+      }
+    },
+    "id": "path+[ROOTURL]/foo/gondor#0.0.0"
+  },
+  {
+    "files": {
+      "Cargo.lock": {
+        "kind": "generate",
+        "path": "[ROOT]/foo/Cargo.lock"
+      },
+      "Cargo.toml": {
+        "kind": "generate",
+        "path": "[ROOT]/foo/rohan/Cargo.toml"
+      },
+      "Cargo.toml.orig": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/rohan/Cargo.toml"
+      },
+      "src/lib.rs": {
+        "kind": "copy",
+        "path": "[ROOT]/foo/rohan/src/lib.rs"
+      }
+    },
+    "id": "path+[ROOTURL]/foo/rohan#0.0.0"
+  }
 ]
 "#]]
             .is_json()