Skip to content

Commit c9fa7db

Browse files
borsbors
committed
Auto merge of #6453 - spacekookie:publish-featured, r=alexcrichton
Adding feature-flags to `cargo publish` and `cargo package` This change adds the `--features` and `--all-features` flags to the above mentioned commands. This is to allow publishing of crates that have certain feature requirements for compilation, without having to rely on `--no-verify` which isn't good practise. This PR adds two new fields `features` and `all_features` to both the `PackageOpts` and `PublishOpts` and also adds the argument options to the CLI commands. Merging this feature will allow people to publish crates on crates.io that require some feature flag to compile (or all?) without needing to rely on not checking the package before uploading, potentially resulting in less packaging errors and broken packages.
2 parents bb8bb0d + b29e379 commit c9fa7db

File tree

6 files changed

+214
-3
lines changed

6 files changed

+214
-3
lines changed

‎src/bin/cargo/commands/package.rs

+4
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ pub fn cli() -> App {
2626
))
2727
.arg_target_triple("Build for the target triple")
2828
.arg_target_dir()
29+
.arg_features()
2930
.arg_manifest_path()
3031
.arg_jobs()
3132
}
@@ -42,6 +43,9 @@ pub fn exec(config: &mut Config, args: &ArgMatches<'_>) -> CliResult {
4243
allow_dirty: args.is_present("allow-dirty"),
4344
target: args.target(),
4445
jobs: args.jobs()?,
46+
features: args._values_of("features"),
47+
all_features: args.is_present("all-features"),
48+
no_default_features: args.is_present("no-default-features"),
4549
},
4650
)?;
4751
Ok(())

‎src/bin/cargo/commands/publish.rs

+4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ pub fn cli() -> App {
1818
.arg_target_triple("Build for the target triple")
1919
.arg_target_dir()
2020
.arg_manifest_path()
21+
.arg_features()
2122
.arg_jobs()
2223
.arg_dry_run("Perform all checks without uploading")
2324
.arg(opt("registry", "Registry to publish to").value_name("REGISTRY"))
@@ -40,6 +41,9 @@ pub fn exec(config: &mut Config, args: &ArgMatches<'_>) -> CliResult {
4041
jobs: args.jobs()?,
4142
dry_run: args.is_present("dry-run"),
4243
registry,
44+
features: args._values_of("features"),
45+
all_features: args.is_present("all-features"),
46+
no_default_features: args.is_present("no-default-features"),
4347
},
4448
)?;
4549
Ok(())

‎src/cargo/ops/cargo_package.rs

+6-3
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ pub struct PackageOpts<'cfg> {
2626
pub verify: bool,
2727
pub jobs: Option<u32>,
2828
pub target: Option<String>,
29+
pub features: Vec<String>,
30+
pub all_features: bool,
31+
pub no_default_features: bool,
2932
}
3033

3134
static VCS_INFO_FILE: &'static str = ".cargo_vcs_info.json";
@@ -447,9 +450,9 @@ fn run_verify(ws: &Workspace<'_>, tar: &FileLock, opts: &PackageOpts<'_>) -> Car
447450
&ops::CompileOptions {
448451
config,
449452
build_config: BuildConfig::new(config, opts.jobs, &opts.target, CompileMode::Build)?,
450-
features: Vec::new(),
451-
no_default_features: false,
452-
all_features: false,
453+
features: opts.features.clone(),
454+
no_default_features: opts.no_default_features,
455+
all_features: opts.all_features,
453456
spec: ops::Packages::Packages(Vec::new()),
454457
filter: ops::CompileFilter::Default {
455458
required_features_filterable: true,

‎src/cargo/ops/registry.rs

+6
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ pub struct PublishOpts<'cfg> {
3939
pub target: Option<String>,
4040
pub dry_run: bool,
4141
pub registry: Option<String>,
42+
pub features: Vec<String>,
43+
pub all_features: bool,
44+
pub no_default_features: bool,
4245
}
4346

4447
pub fn publish(ws: &Workspace<'_>, opts: &PublishOpts<'_>) -> CargoResult<()> {
@@ -82,6 +85,9 @@ pub fn publish(ws: &Workspace<'_>, opts: &PublishOpts<'_>) -> CargoResult<()> {
8285
allow_dirty: opts.allow_dirty,
8386
target: opts.target.clone(),
8487
jobs: opts.jobs,
88+
features: opts.features.clone(),
89+
all_features: opts.all_features,
90+
no_default_features: opts.no_default_features,
8591
},
8692
)?
8793
.unwrap();

‎tests/testsuite/package.rs

+91
Original file line numberDiff line numberDiff line change
@@ -1236,3 +1236,94 @@ To proceed despite this, pass the `--no-verify` flag.",
12361236

12371237
p.cargo("package --no-verify").run();
12381238
}
1239+
1240+
#[test]
1241+
fn package_with_select_features() {
1242+
let p = project()
1243+
.file(
1244+
"Cargo.toml",
1245+
r#"
1246+
[project]
1247+
name = "foo"
1248+
version = "0.0.1"
1249+
authors = []
1250+
license = "MIT"
1251+
description = "foo"
1252+
1253+
[features]
1254+
required = []
1255+
optional = []
1256+
"#,
1257+
).file(
1258+
"src/main.rs",
1259+
"#[cfg(not(feature = \"required\"))]
1260+
compile_error!(\"This crate requires `required` feature!\");
1261+
fn main() {}",
1262+
).build();
1263+
1264+
p.cargo("package --features required")
1265+
.masquerade_as_nightly_cargo()
1266+
.with_status(0)
1267+
.run();
1268+
}
1269+
1270+
#[test]
1271+
fn package_with_all_features() {
1272+
let p = project()
1273+
.file(
1274+
"Cargo.toml",
1275+
r#"
1276+
[project]
1277+
name = "foo"
1278+
version = "0.0.1"
1279+
authors = []
1280+
license = "MIT"
1281+
description = "foo"
1282+
1283+
[features]
1284+
required = []
1285+
optional = []
1286+
"#,
1287+
).file(
1288+
"src/main.rs",
1289+
"#[cfg(not(feature = \"required\"))]
1290+
compile_error!(\"This crate requires `required` feature!\");
1291+
fn main() {}",
1292+
).build();
1293+
1294+
p.cargo("package --all-features")
1295+
.masquerade_as_nightly_cargo()
1296+
.with_status(0)
1297+
.run();
1298+
}
1299+
1300+
#[test]
1301+
fn package_no_default_features() {
1302+
let p = project()
1303+
.file(
1304+
"Cargo.toml",
1305+
r#"
1306+
[project]
1307+
name = "foo"
1308+
version = "0.0.1"
1309+
authors = []
1310+
license = "MIT"
1311+
description = "foo"
1312+
1313+
[features]
1314+
default = ["required"]
1315+
required = []
1316+
"#,
1317+
).file(
1318+
"src/main.rs",
1319+
"#[cfg(not(feature = \"required\"))]
1320+
compile_error!(\"This crate requires `required` feature!\");
1321+
fn main() {}",
1322+
).build();
1323+
1324+
p.cargo("package --no-default-features")
1325+
.masquerade_as_nightly_cargo()
1326+
.with_stderr_contains("error: This crate requires `required` feature!")
1327+
.with_status(101)
1328+
.run();
1329+
}

‎tests/testsuite/publish.rs

+103
Original file line numberDiff line numberDiff line change
@@ -787,3 +787,106 @@ fn block_publish_no_registry() {
787787
)
788788
.run();
789789
}
790+
791+
#[test]
792+
fn publish_with_select_features() {
793+
publish::setup();
794+
795+
let p = project()
796+
.file(
797+
"Cargo.toml",
798+
r#"
799+
[project]
800+
name = "foo"
801+
version = "0.0.1"
802+
authors = []
803+
license = "MIT"
804+
description = "foo"
805+
806+
[features]
807+
required = []
808+
optional = []
809+
"#,
810+
)
811+
.file(
812+
"src/main.rs",
813+
"#[cfg(not(feature = \"required\"))]
814+
compile_error!(\"This crate requires `required` feature!\");
815+
fn main() {}",
816+
)
817+
.build();
818+
819+
p.cargo("publish --features required --index")
820+
.arg(publish::registry().to_string())
821+
.with_stderr_contains("[UPLOADING] foo v0.0.1 ([CWD])")
822+
.run();
823+
}
824+
825+
#[test]
826+
fn publish_with_all_features() {
827+
publish::setup();
828+
829+
let p = project()
830+
.file(
831+
"Cargo.toml",
832+
r#"
833+
[project]
834+
name = "foo"
835+
version = "0.0.1"
836+
authors = []
837+
license = "MIT"
838+
description = "foo"
839+
840+
[features]
841+
required = []
842+
optional = []
843+
"#,
844+
)
845+
.file(
846+
"src/main.rs",
847+
"#[cfg(not(feature = \"required\"))]
848+
compile_error!(\"This crate requires `required` feature!\");
849+
fn main() {}",
850+
)
851+
.build();
852+
853+
p.cargo("publish --all-features --index")
854+
.arg(publish::registry().to_string())
855+
.with_stderr_contains("[UPLOADING] foo v0.0.1 ([CWD])")
856+
.run();
857+
}
858+
859+
#[test]
860+
fn publish_with_no_default_features() {
861+
publish::setup();
862+
863+
let p = project()
864+
.file(
865+
"Cargo.toml",
866+
r#"
867+
[project]
868+
name = "foo"
869+
version = "0.0.1"
870+
authors = []
871+
license = "MIT"
872+
description = "foo"
873+
874+
[features]
875+
default = ["required"]
876+
required = []
877+
"#,
878+
)
879+
.file(
880+
"src/main.rs",
881+
"#[cfg(not(feature = \"required\"))]
882+
compile_error!(\"This crate requires `required` feature!\");
883+
fn main() {}",
884+
)
885+
.build();
886+
887+
p.cargo("publish --no-default-features --index")
888+
.arg(publish::registry().to_string())
889+
.with_stderr_contains("error: This crate requires `required` feature!")
890+
.with_status(101)
891+
.run();
892+
}

0 commit comments

Comments
 (0)