Skip to content

Commit 1fa59ee

Browse files
borsbors
committed
Auto merge of #5386 - ysimonson:new-metadata, r=matklad
Added new metadata fields Addresses #5373. `cargo metadata` should now include all of the non-optional suggested fields in the [API guidelines](https://rust-lang-nursery.github.io/api-guidelines/documentation.html#cargotoml-includes-all-common-metadata-c-metadata).
2 parents 11777ef + d4162ed commit 1fa59ee

File tree

3 files changed

+111
-2
lines changed

3 files changed

+111
-2
lines changed

‎src/cargo/core/package.rs

+15
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ struct SerializedPackage<'a> {
4242
features: &'a FeatureMap,
4343
manifest_path: &'a str,
4444
metadata: Option<&'a toml::Value>,
45+
authors: &'a [String],
46+
categories: &'a [String],
47+
keywords: &'a [String],
48+
readme: Option<&'a str>,
49+
repository: Option<&'a str>
4550
}
4651

4752
impl ser::Serialize for Package {
@@ -55,6 +60,11 @@ impl ser::Serialize for Package {
5560
let license = manmeta.license.as_ref().map(String::as_ref);
5661
let license_file = manmeta.license_file.as_ref().map(String::as_ref);
5762
let description = manmeta.description.as_ref().map(String::as_ref);
63+
let authors = manmeta.authors.as_ref();
64+
let categories = manmeta.categories.as_ref();
65+
let keywords = manmeta.keywords.as_ref();
66+
let readme = manmeta.readme.as_ref().map(String::as_ref);
67+
let repository = manmeta.repository.as_ref().map(String::as_ref);
5868

5969
SerializedPackage {
6070
name: &*package_id.name(),
@@ -69,6 +79,11 @@ impl ser::Serialize for Package {
6979
features: summary.features(),
7080
manifest_path: &self.manifest_path.display().to_string(),
7181
metadata: self.manifest.custom_metadata(),
82+
authors,
83+
categories,
84+
keywords,
85+
readme,
86+
repository,
7287
}.serialize(s)
7388
}
7489
}

‎tests/testsuite/metadata.rs

+89-2
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,21 @@ fn cargo_metadata_simple() {
1616
{
1717
"packages": [
1818
{
19+
"authors": [
20+
"[email protected]"
21+
],
22+
"categories": [],
1923
"name": "foo",
2024
"version": "0.5.0",
2125
"id": "foo[..]",
26+
"keywords": [],
2227
"source": null,
2328
"dependencies": [],
2429
"license": null,
2530
"license_file": null,
2631
"description": null,
32+
"readme": null,
33+
"repository": null,
2734
"targets": [
2835
{
2936
"kind": [
@@ -100,9 +107,14 @@ crate-type = ["lib", "staticlib"]
100107
{
101108
"packages": [
102109
{
110+
"authors": [],
111+
"categories": [],
103112
"name": "foo",
113+
"readme": null,
114+
"repository": null,
104115
"version": "0.5.0",
105116
"id": "foo[..]",
117+
"keywords": [],
106118
"source": null,
107119
"dependencies": [],
108120
"license": null,
@@ -172,9 +184,14 @@ optional_feat = []
172184
{
173185
"packages": [
174186
{
187+
"authors": [],
188+
"categories": [],
175189
"name": "foo",
190+
"readme": null,
191+
"repository": null,
176192
"version": "0.5.0",
177193
"id": "foo[..]",
194+
"keywords": [],
178195
"source": null,
179196
"dependencies": [],
180197
"license": null,
@@ -260,11 +277,17 @@ fn cargo_metadata_with_deps_and_version() {
260277
{
261278
"packages": [
262279
{
280+
"authors": [],
281+
"categories": [],
263282
"dependencies": [],
283+
"description": null,
264284
"features": {},
265285
"id": "baz 0.0.1 (registry+[..])",
286+
"keywords": [],
266287
"manifest_path": "[..]Cargo.toml",
267288
"name": "baz",
289+
"readme": null,
290+
"repository": null,
268291
"source": "registry+[..]",
269292
"license": null,
270293
"license_file": null,
@@ -285,6 +308,8 @@ fn cargo_metadata_with_deps_and_version() {
285308
"metadata": null
286309
},
287310
{
311+
"authors": [],
312+
"categories": [],
288313
"dependencies": [
289314
{
290315
"features": [],
@@ -300,8 +325,11 @@ fn cargo_metadata_with_deps_and_version() {
300325
],
301326
"features": {},
302327
"id": "bar 0.0.1 (registry+[..])",
328+
"keywords": [],
303329
"manifest_path": "[..]Cargo.toml",
304330
"name": "bar",
331+
"readme": null,
332+
"repository": null,
305333
"source": "registry+[..]",
306334
"license": null,
307335
"license_file": null,
@@ -322,6 +350,8 @@ fn cargo_metadata_with_deps_and_version() {
322350
"metadata": null
323351
},
324352
{
353+
"authors": [],
354+
"categories": [],
325355
"dependencies": [
326356
{
327357
"features": [],
@@ -337,8 +367,11 @@ fn cargo_metadata_with_deps_and_version() {
337367
],
338368
"features": {},
339369
"id": "foo 0.5.0 (path+file:[..]foo)",
370+
"keywords": [],
340371
"manifest_path": "[..]Cargo.toml",
341372
"name": "foo",
373+
"readme": null,
374+
"repository": null,
342375
"source": null,
343376
"license": "MIT",
344377
"license_file": null,
@@ -417,9 +450,14 @@ name = "ex"
417450
{
418451
"packages": [
419452
{
453+
"authors": [],
454+
"categories": [],
420455
"name": "foo",
456+
"readme": null,
457+
"repository": null,
421458
"version": "0.1.0",
422459
"id": "foo[..]",
460+
"keywords": [],
423461
"license": null,
424462
"license_file": null,
425463
"description": null,
@@ -491,9 +529,14 @@ crate-type = ["rlib", "dylib"]
491529
{
492530
"packages": [
493531
{
532+
"authors": [],
533+
"categories": [],
494534
"name": "foo",
535+
"readme": null,
536+
"repository": null,
495537
"version": "0.1.0",
496538
"id": "foo[..]",
539+
"keywords": [],
497540
"license": null,
498541
"license_file": null,
499542
"description": null,
@@ -562,9 +605,16 @@ fn workspace_metadata() {
562605
{
563606
"packages": [
564607
{
608+
"authors": [
609+
"[email protected]"
610+
],
611+
"categories": [],
565612
"name": "bar",
566613
"version": "0.5.0",
567614
"id": "bar[..]",
615+
"readme": null,
616+
"repository": null,
617+
"keywords": [],
568618
"source": null,
569619
"dependencies": [],
570620
"license": null,
@@ -583,9 +633,16 @@ fn workspace_metadata() {
583633
"metadata": null
584634
},
585635
{
636+
"authors": [
637+
"[email protected]"
638+
],
639+
"categories": [],
586640
"name": "baz",
641+
"readme": null,
642+
"repository": null,
587643
"version": "0.5.0",
588644
"id": "baz[..]",
645+
"keywords": [],
589646
"source": null,
590647
"dependencies": [],
591648
"license": null,
@@ -651,9 +708,16 @@ fn workspace_metadata_no_deps() {
651708
{
652709
"packages": [
653710
{
711+
"authors": [
712+
"[email protected]"
713+
],
714+
"categories": [],
654715
"name": "bar",
716+
"readme": null,
717+
"repository": null,
655718
"version": "0.5.0",
656719
"id": "bar[..]",
720+
"keywords": [],
657721
"source": null,
658722
"dependencies": [],
659723
"license": null,
@@ -672,9 +736,16 @@ fn workspace_metadata_no_deps() {
672736
"metadata": null
673737
},
674738
{
739+
"authors": [
740+
"[email protected]"
741+
],
742+
"categories": [],
675743
"name": "baz",
744+
"readme": null,
745+
"repository": null,
676746
"version": "0.5.0",
677747
"id": "baz[..]",
748+
"keywords": [],
678749
"source": null,
679750
"dependencies": [],
680751
"license": null,
@@ -722,11 +793,16 @@ Caused by:
722793
const MANIFEST_OUTPUT: &str = r#"
723794
{
724795
"packages": [{
796+
"authors": [
797+
"[email protected]"
798+
],
799+
"categories": [],
725800
"name":"foo",
726801
"version":"0.5.0",
727802
"id":"foo[..]0.5.0[..](path+file://[..]/foo)",
728803
"source":null,
729804
"dependencies":[],
805+
"keywords": [],
730806
"license": null,
731807
"license_file": null,
732808
"description": null,
@@ -738,7 +814,9 @@ const MANIFEST_OUTPUT: &str = r#"
738814
}],
739815
"features":{},
740816
"manifest_path":"[..]Cargo.toml",
741-
"metadata": null
817+
"metadata": null,
818+
"readme": null,
819+
"repository": null
742820
}],
743821
"workspace_members": [ "foo 0.5.0 (path+file:[..]foo)" ],
744822
"resolve": null,
@@ -890,7 +968,11 @@ fn package_metadata() {
890968
[package]
891969
name = "foo"
892970
version = "0.1.0"
893-
authors = []
971+
authors = ["[email protected]"]
972+
categories = ["database"]
973+
keywords = ["database"]
974+
readme = "README.md"
975+
repository = "https://github.com/rust-lang/cargo"
894976
895977
[package.metadata.bar]
896978
baz = "quux"
@@ -906,9 +988,14 @@ fn package_metadata() {
906988
{
907989
"packages": [
908990
{
991+
"authors": ["[email protected]"],
992+
"categories": ["database"],
909993
"name": "foo",
994+
"readme": "README.md",
995+
"repository": "https://github.com/rust-lang/cargo",
910996
"version": "0.1.0",
911997
"id": "foo[..]",
998+
"keywords": ["database"],
912999
"source": null,
9131000
"dependencies": [],
9141001
"license": null,

‎tests/testsuite/read_manifest.rs

+7
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,16 @@ use hamcrest::assert_that;
33

44
static MANIFEST_OUTPUT: &'static str = r#"
55
{
6+
"authors": [
7+
"[email protected]"
8+
],
9+
"categories": [],
610
"name":"foo",
11+
"readme": null,
12+
"repository": null,
713
"version":"0.5.0",
814
"id":"foo[..]0.5.0[..](path+file://[..]/foo)",
15+
"keywords": [],
916
"license": null,
1017
"license_file": null,
1118
"description": null,

0 commit comments

Comments
 (0)