Skip to content

Commit f1bbc08

Browse files
borsbors
authored
Auto merge of #2921 - jonathandturner:bin_by_default, r=alexcrichton
Add --lib and status message for completion This PR adds a --lib flag for creating a library with new/init. It also adds a status message for a successful completion.
2 parents 5157040 + a0a7752 commit f1bbc08

File tree

7 files changed

+116
-35
lines changed

7 files changed

+116
-35
lines changed

‎src/bin/init.rs

+16-8
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ pub struct Options {
99
flag_quiet: Option<bool>,
1010
flag_color: Option<String>,
1111
flag_bin: bool,
12+
flag_lib: bool,
1213
arg_path: Option<String>,
1314
flag_name: Option<String>,
1415
flag_vcs: Option<ops::VersionControl>,
@@ -28,7 +29,8 @@ Options:
2829
--vcs VCS Initialize a new repository for the given version
2930
control system (git or hg) or do not initialize any version
3031
control at all (none) overriding a global configuration.
31-
--bin Use a binary instead of a library template
32+
--bin Use a binary (application) template
33+
--lib Use a library template
3234
--name NAME Set the resulting package name
3335
-v, --verbose ... Use verbose output
3436
-q, --quiet No output printed to stdout
@@ -45,16 +47,22 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
4547
options.flag_frozen,
4648
options.flag_locked));
4749

48-
let Options { flag_bin, arg_path, flag_name, flag_vcs, .. } = options;
50+
let Options { flag_bin, flag_lib, arg_path, flag_name, flag_vcs, .. } = options;
4951

50-
let opts = ops::NewOptions {
51-
version_control: flag_vcs,
52-
bin: flag_bin,
53-
path: &arg_path.unwrap_or(format!(".")),
54-
name: flag_name.as_ref().map(|s| s.as_ref()),
55-
};
52+
let tmp = &arg_path.unwrap_or(format!("."));
53+
let opts = ops::NewOptions::new(flag_vcs,
54+
flag_bin,
55+
flag_lib,
56+
tmp,
57+
flag_name.as_ref().map(|s| s.as_ref()));
5658

59+
let opts_lib = opts.lib;
5760
try!(ops::init(opts, config));
61+
62+
try!(config.shell().status("Created", format!("{} project",
63+
if opts_lib { "library" }
64+
else {"binary (application)"})));
65+
5866
Ok(None)
5967
}
6068

‎src/bin/new.rs

+16-8
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ pub struct Options {
99
flag_quiet: Option<bool>,
1010
flag_color: Option<String>,
1111
flag_bin: bool,
12+
flag_lib: bool,
1213
arg_path: String,
1314
flag_name: Option<String>,
1415
flag_vcs: Option<ops::VersionControl>,
@@ -28,7 +29,8 @@ Options:
2829
--vcs VCS Initialize a new repository for the given version
2930
control system (git or hg) or do not initialize any version
3031
control at all (none) overriding a global configuration.
31-
--bin Use a binary instead of a library template
32+
--bin Use a binary (application) template
33+
--lib Use a library template
3234
--name NAME Set the resulting package name
3335
-v, --verbose ... Use verbose output
3436
-q, --quiet No output printed to stdout
@@ -45,16 +47,22 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
4547
options.flag_frozen,
4648
options.flag_locked));
4749

48-
let Options { flag_bin, arg_path, flag_name, flag_vcs, .. } = options;
50+
let Options { flag_bin, flag_lib, arg_path, flag_name, flag_vcs, .. } = options;
4951

50-
let opts = ops::NewOptions {
51-
version_control: flag_vcs,
52-
bin: flag_bin,
53-
path: &arg_path,
54-
name: flag_name.as_ref().map(|s| s.as_ref()),
55-
};
52+
let opts = ops::NewOptions::new(flag_vcs,
53+
flag_bin,
54+
flag_lib,
55+
&arg_path,
56+
flag_name.as_ref().map(|s| s.as_ref()));
5657

58+
let opts_lib = opts.lib;
5759
try!(ops::new(opts, config));
60+
61+
try!(config.shell().status("Created", format!("{} `{}` project",
62+
if opts_lib { "library" }
63+
else {"binary (application)"},
64+
arg_path)));
65+
5866
Ok(None)
5967
}
6068

‎src/cargo/ops/cargo_new.rs

+34
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ pub enum VersionControl { Git, Hg, NoVcs }
2121
pub struct NewOptions<'a> {
2222
pub version_control: Option<VersionControl>,
2323
pub bin: bool,
24+
pub lib: bool,
2425
pub path: &'a str,
2526
pub name: Option<&'a str>,
2627
}
@@ -53,6 +54,31 @@ impl Decodable for VersionControl {
5354
}
5455
}
5556

57+
impl<'a> NewOptions<'a> {
58+
pub fn new(version_control: Option<VersionControl>,
59+
bin: bool,
60+
lib: bool,
61+
path: &'a str,
62+
name: Option<&'a str>) -> NewOptions<'a> {
63+
64+
// default to lib
65+
let is_lib = if !bin {
66+
true
67+
}
68+
else {
69+
lib
70+
};
71+
72+
NewOptions {
73+
version_control: version_control,
74+
bin: bin,
75+
lib: is_lib,
76+
path: path,
77+
name: name,
78+
}
79+
}
80+
}
81+
5682
struct CargoNewConfig {
5783
name: Option<String>,
5884
email: Option<String>,
@@ -235,6 +261,10 @@ pub fn new(opts: NewOptions, config: &Config) -> CargoResult<()> {
235261
path.display())
236262
}
237263

264+
if opts.lib && opts.bin {
265+
bail!("can't specify both lib and binary outputs");
266+
}
267+
238268
let name = try!(get_name(&path, &opts, config));
239269
try!(check_name(name));
240270

@@ -260,6 +290,10 @@ pub fn init(opts: NewOptions, config: &Config) -> CargoResult<()> {
260290
bail!("`cargo init` cannot be run on existing Cargo projects")
261291
}
262292

293+
if opts.lib && opts.bin {
294+
bail!("can't specify both lib and binary outputs");
295+
}
296+
263297
let name = try!(get_name(&path, &opts, config));
264298
try!(check_name(name));
265299

‎tests/cargotest/support/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -636,6 +636,7 @@ fn substitute_macros(input: &str) -> String {
636636
let macros = [
637637
("[RUNNING]", " Running"),
638638
("[COMPILING]", " Compiling"),
639+
("[CREATED]", " Created"),
639640
("[FINISHED]", " Finished"),
640641
("[ERROR]", "error:"),
641642
("[WARNING]", "warning:"),

‎tests/init.rs

+28-12
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ fn cargo_process(s: &str) -> ProcessBuilder {
2020

2121
#[test]
2222
fn simple_lib() {
23-
assert_that(cargo_process("init").arg("--vcs").arg("none")
23+
assert_that(cargo_process("init").arg("--lib").arg("--vcs").arg("none")
2424
.env("USER", "foo"),
25-
execs().with_status(0));
25+
execs().with_status(0).with_stderr("\
26+
[CREATED] library project
27+
"));
2628

2729
assert_that(&paths::root().join("Cargo.toml"), existing_file());
2830
assert_that(&paths::root().join("src/lib.rs"), existing_file());
@@ -38,7 +40,9 @@ fn simple_bin() {
3840
fs::create_dir(&path).unwrap();
3941
assert_that(cargo_process("init").arg("--bin").arg("--vcs").arg("none")
4042
.env("USER", "foo").cwd(&path),
41-
execs().with_status(0));
43+
execs().with_status(0).with_stderr("\
44+
[CREATED] binary (application) project
45+
"));
4246

4347
assert_that(&paths::root().join("foo/Cargo.toml"), existing_file());
4448
assert_that(&paths::root().join("foo/src/main.rs"), existing_file());
@@ -50,6 +54,15 @@ fn simple_bin() {
5054
existing_file());
5155
}
5256

57+
#[test]
58+
fn both_lib_and_bin() {
59+
let td = TempDir::new("cargo").unwrap();
60+
assert_that(cargo_process("init").arg("--lib").arg("--bin").cwd(td.path().clone())
61+
.env("USER", "foo"),
62+
execs().with_status(101).with_stderr(
63+
"[ERROR] can't specify both lib and binary outputs"));
64+
}
65+
5366
fn bin_already_exists(explicit: bool, rellocation: &str) {
5467
let path = paths::root().join("foo");
5568
fs::create_dir_all(&path.join("src")).unwrap();
@@ -165,7 +178,7 @@ fn multibin_project_name_clash() {
165178
}
166179
"#).unwrap();
167180

168-
assert_that(cargo_process("init").arg("--vcs").arg("none")
181+
assert_that(cargo_process("init").arg("--lib").arg("--vcs").arg("none")
169182
.env("USER", "foo").cwd(&path),
170183
execs().with_status(101).with_stderr("\
171184
[ERROR] multiple possible binary sources found:
@@ -214,8 +227,10 @@ fn lib_already_exists_nosrc() {
214227

215228
#[test]
216229
fn simple_git() {
217-
assert_that(cargo_process("init").arg("--vcs").arg("git")
218-
.env("USER", "foo"),
230+
assert_that(cargo_process("init").arg("--lib")
231+
.arg("--vcs")
232+
.arg("git")
233+
.env("USER", "foo"),
219234
execs().with_status(0));
220235

221236
assert_that(&paths::root().join("Cargo.toml"), existing_file());
@@ -229,7 +244,8 @@ fn auto_git() {
229244
let td = TempDir::new("cargo").unwrap();
230245
let foo = &td.path().join("foo");
231246
fs::create_dir_all(&foo).unwrap();
232-
assert_that(cargo_process("init").cwd(foo.clone())
247+
assert_that(cargo_process("init").arg("--lib")
248+
.cwd(foo.clone())
233249
.env("USER", "foo"),
234250
execs().with_status(0));
235251

@@ -271,7 +287,7 @@ use --name to override crate name
271287
fn git_autodetect() {
272288
fs::create_dir(&paths::root().join(".git")).unwrap();
273289

274-
assert_that(cargo_process("init")
290+
assert_that(cargo_process("init").arg("--lib")
275291
.env("USER", "foo"),
276292
execs().with_status(0));
277293

@@ -287,7 +303,7 @@ fn git_autodetect() {
287303
fn mercurial_autodetect() {
288304
fs::create_dir(&paths::root().join(".hg")).unwrap();
289305

290-
assert_that(cargo_process("init")
306+
assert_that(cargo_process("init").arg("--lib")
291307
.env("USER", "foo"),
292308
execs().with_status(0));
293309

@@ -304,8 +320,8 @@ fn gitignore_appended_not_replaced() {
304320

305321
File::create(&paths::root().join(".gitignore")).unwrap().write_all(b"qqqqqq\n").unwrap();
306322

307-
assert_that(cargo_process("init")
308-
.env("USER", "foo"),
323+
assert_that(cargo_process("init").arg("--lib")
324+
.env("USER", "foo"),
309325
execs().with_status(0));
310326

311327

@@ -323,7 +339,7 @@ fn gitignore_appended_not_replaced() {
323339
fn cargo_lock_gitignored_if_lib1() {
324340
fs::create_dir(&paths::root().join(".git")).unwrap();
325341

326-
assert_that(cargo_process("init").arg("--vcs").arg("git")
342+
assert_that(cargo_process("init").arg("--lib").arg("--vcs").arg("git")
327343
.env("USER", "foo"),
328344
execs().with_status(0));
329345

‎tests/new.rs

+19-6
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@ fn cargo_process(s: &str) -> ProcessBuilder {
2121

2222
#[test]
2323
fn simple_lib() {
24-
assert_that(cargo_process("new").arg("foo").arg("--vcs").arg("none")
24+
assert_that(cargo_process("new").arg("--lib").arg("foo").arg("--vcs").arg("none")
2525
.env("USER", "foo"),
26-
execs().with_status(0));
26+
execs().with_status(0).with_stderr("\
27+
[CREATED] library `foo` project
28+
"));
2729

2830
assert_that(&paths::root().join("foo"), existing_dir());
2931
assert_that(&paths::root().join("foo/Cargo.toml"), existing_file());
@@ -36,9 +38,11 @@ fn simple_lib() {
3638

3739
#[test]
3840
fn simple_bin() {
39-
assert_that(cargo_process("new").arg("foo").arg("--bin")
41+
assert_that(cargo_process("new").arg("--bin").arg("foo")
4042
.env("USER", "foo"),
41-
execs().with_status(0));
43+
execs().with_status(0).with_stderr("\
44+
[CREATED] binary (application) `foo` project
45+
"));
4246

4347
assert_that(&paths::root().join("foo"), existing_dir());
4448
assert_that(&paths::root().join("foo/Cargo.toml"), existing_file());
@@ -51,10 +55,19 @@ fn simple_bin() {
5155
existing_file());
5256
}
5357

58+
#[test]
59+
fn both_lib_and_bin() {
60+
let td = TempDir::new("cargo").unwrap();
61+
assert_that(cargo_process("new").arg("--lib").arg("--bin").arg("foo").cwd(td.path().clone())
62+
.env("USER", "foo"),
63+
execs().with_status(101).with_stderr(
64+
"[ERROR] can't specify both lib and binary outputs"));
65+
}
66+
5467
#[test]
5568
fn simple_git() {
5669
let td = TempDir::new("cargo").unwrap();
57-
assert_that(cargo_process("new").arg("foo").cwd(td.path().clone())
70+
assert_that(cargo_process("new").arg("--lib").arg("foo").cwd(td.path().clone())
5871
.env("USER", "foo"),
5972
execs().with_status(0));
6073

@@ -120,7 +133,7 @@ use --name to override crate name"));
120133

121134
#[test]
122135
fn rust_prefix_stripped() {
123-
assert_that(cargo_process("new").arg("rust-foo").env("USER", "foo"),
136+
assert_that(cargo_process("new").arg("--lib").arg("rust-foo").env("USER", "foo"),
124137
execs().with_status(0)
125138
.with_stdout("note: package will be named `foo`; use --name to override"));
126139
let toml = paths::root().join("rust-foo/Cargo.toml");

‎tests/workspaces.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -768,7 +768,7 @@ fn new_warns_you_this_will_not_work() {
768768
.file("src/lib.rs", "");
769769
p.build();
770770

771-
assert_that(p.cargo("new").arg("bar").env("USER", "foo"),
771+
assert_that(p.cargo("new").arg("--lib").arg("bar").env("USER", "foo"),
772772
execs().with_status(0)
773773
.with_stderr("\
774774
warning: compiling this new crate may not work due to invalid workspace \
@@ -780,6 +780,7 @@ workspace: [..]
780780
781781
this may be fixable by ensuring that this crate is depended on by the workspace \
782782
root: [..]
783+
[CREATED] library `bar` project
783784
"));
784785
}
785786

0 commit comments

Comments
 (0)