convert Result<(), OsString> -> Result<(), String>

.gitignore

@@ -25,3 +25,4 @@ Cargo.lock
 # Project files
 .vscode/*
 .idea/*
+clap-rs.iml

CHANGELOG.md

@@ -632,7 +632,7 @@ Minimum version of Rust is now v1.13.0 (Stable)
 
 #### Bug Fixes
 
-* **Low Index Multiples:**  fixes a bug where using low index multiples was propgated to subcommands ([33924e88](https://github.com/kbknapp/clap-rs/commit/33924e884461983c4e6b5ea1330fecc769a4ade7), closes [#725](https://github.com/kbknapp/clap-rs/issues/725))
+* **Low Index Multiples:**  fixes a bug where using low index multiples was propagated to subcommands ([33924e88](https://github.com/kbknapp/clap-rs/commit/33924e884461983c4e6b5ea1330fecc769a4ade7), closes [#725](https://github.com/kbknapp/clap-rs/issues/725))
 
 
 

Cargo.toml

@@ -1,35 +1,66 @@
 [package]
 
 name = "clap"
-version = "2.29.2"
+version = "3.0.0-alpha1"
 authors = ["Kevin K. <[email protected]>"]
-exclude = ["examples/*", "clap-test/*", "tests/*", "benches/*", "*.png", "clap-perf/*", "*.dot"]
+exclude = [
+	".github/*",
+	"examples/*", 
+	"tests/*", 
+	"benches/*", 
+	"clap-perf/*", 
+	"etc/*",
+	"*.png", 
+	"*.dot",
+	"*.yml",
+	"*.toml",
+	"*.md",
+	"clap-test.rs"
+]
+include = [
+	"src/**/*", 
+	"Cargo.toml", 
+	"README.md"
+]
 repository = "https://github.com/kbknapp/clap-rs"
 documentation = "https://docs.rs/clap/"
 homepage = "https://clap.rs/"
 readme = "README.md"
 license = "MIT"
-keywords = ["argument", "cli", "arg", "parser", "parse"]
+keywords = [
+	"argument", 
+	"cli", 
+	"arg", 
+	"parser", 
+	"parse"
+]
 categories = ["command-line-interface"]
 description = """
-A simple to use, efficient, and full featured  Command Line Argument Parser
+A simple to use, efficient, and full featured Command Line Argument Parser
 """
 
 [badges]
 travis-ci = { repository = "kbknapp/clap-rs" }
 appveyor = { repository = "kbknapp/clap-rs" }
+coveralls = { repostiory = "kbknapp/clap-rs", branch = "master" }
+is-it-maintained-issue-resolution = { repository = "kbknapp/clap-rs" }
+is-it-maintained-open-issues = { repository = "kbknapp/clap-rs" }
+maintenance = {status = "actively-developed"}
 
 [dependencies]
 bitflags              = "1.0"
 unicode-width         = "0.1.4"
 textwrap              = "0.9.0"
+ordermap			  = "0.3.5"
 strsim    = { version = "0.7.0",  optional = true }
-ansi_term = { version = "0.10.0",  optional = true }
 yaml-rust = { version = "0.3.5",  optional = true }
 clippy    = { version = "~0.0.166", optional = true }
 atty      = { version = "0.2.2",  optional = true }
 vec_map   = { version = "0.8", optional = true }
-term_size = { version = "0.3.0", optional = true }
+term_size = { version = "1.0.0-beta1", optional = true }
+
+[target.'cfg(not(windows))'.dependencies]
+ansi_term = { version = "0.10.0",  optional = true }
 
 [dev-dependencies]
 regex = "0.2"
@@ -55,7 +86,7 @@ debug = false
 rpath = false
 lto = true
 debug-assertions = false
-# codegen-units ignored with lto=true
+codegen-units = 1
 
 [profile.dev]
 opt-level = 0
@@ -79,6 +110,7 @@ debug = false
 rpath = false
 lto = true
 debug-assertions = false
+codegen-units = 1
 
 [profile.doc]
 opt-level = 0

README.md

@@ -46,21 +46,21 @@ Here's whats new in 2.29.2:
 
 * **Many ZSH Completions Improvements** (Thanks to @segevfiner)
   *  Positional arguments will default to file completion when not using specific values!
-  *  Implement postional argument possible values completion 
-  *  Removes redundant code from output 
-  *  Don't pass `-S` to `_arguments` if Zsh is too old 
-  *  Fix completions with mixed positionals and subcommands 
-  *  String escape possible values for options 
+  *  Implement postional argument possible values completion
+  *  Removes redundant code from output
+  *  Don't pass `-S` to `_arguments` if Zsh is too old
+  *  Fix completions with mixed positionals and subcommands
+  *  String escape possible values for options
 
 
 Here's whats new in 2.29.1:
 
 * Debloats clap by deduplicating logic and refactors for a ~57% decrease in code size! This is with zero functinoality lost, and a slight perf increase!
-* Change the bash completion script code generation to support hyphens. 
+* Change the bash completion script code generation to support hyphens.
 * Fix completion of long option values in ZSH completions
 * Fixes broken links in docs
 * Updates contributors list
-* Fixes the ripgrep benchmark by adding a value to a flag that expects it 
+* Fixes the ripgrep benchmark by adding a value to a flag that expects it
 
 Here's whats new in 2.29.0:
 
@@ -321,7 +321,7 @@ subcommands:
 
 Since this feature requires additional dependencies that not everyone may want, it is *not* compiled in by default and we need to enable a feature flag in Cargo.toml:
 
-Simply change your `clap = "2.29"` to `clap = {version = "2.29", features = ["yaml"]}`.
+Simply change your `clap = "3.0.0-alpha1"` to `clap = {version = "3.0.0-alpha1", features = ["yaml"]}`.
 
 Finally we create our `main.rs` file just like we would have with the previous two examples:
 
@@ -418,7 +418,7 @@ To test out `clap`'s default auto-generated help/version follow these steps:
 *
 ```toml
 [dependencies]
-clap = "2"
+clap = "3.0.0-alpha1"
 ```
 
 * Add the following to your `src/main.rs`
@@ -441,7 +441,7 @@ For full usage, add `clap` as a dependency in your `Cargo.toml` () to use from c
 
 ```toml
 [dependencies]
-clap = "~2.29"
+clap = "~3.0.0-alpha1"
 ```
 
 (**note**: If you are concerned with supporting a minimum version of Rust that is *older* than the current stable Rust minus 2 stable releases, it's recommended to use the `~major.minor.patch` style versions in your `Cargo.toml` which will only update the patch version automatically. For more information see the [Compatibility Policy](#compatibility-policy))
@@ -464,15 +464,15 @@ To disable these, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies.clap]
-version = "2.29"
+version = "3.0.0-alpha1"
 default-features = false
 ```
 
 You can also selectively enable only the features you'd like to include, by adding:
 
 ```toml
 [dependencies.clap]
-version = "2.29"
+version = "3.0.0-alpha1"
 default-features = false
 
 # Cherry-pick the features you'd like to use
@@ -483,6 +483,7 @@ features = [ "suggestions", "color" ]
 
 * **"yaml"**: Enables building CLIs from YAML documents. (builds dependency `yaml-rust`)
 * **"unstable"**: Enables unstable `clap` features that may change from release to release
+* **"wrap_help"**: Turns on the help text wrapping feature, based on the terminal size. (builds dependency `term-size`)
 
 ### Dependencies Tree
 
@@ -520,7 +521,7 @@ In order to keep from being surprised of breaking changes, it is **highly** reco
 
 ```toml
 [dependencies]
-clap = "~2.29"
+clap = "~3.0.0-alpha1"
 ```
 
 This will cause *only* the patch version to be updated upon a `cargo update` call, and therefore cannot break due to new features, or bumped minimum versions of Rust.
@@ -537,11 +538,11 @@ Right now Cargo's version resolution is pretty naive, it's just a brute-force se
 
 # In one Cargo.toml
 [dependencies]
-clap = "~2.29.0"
+clap = "~3.0.0-alpha1"
 
 # In another Cargo.toml
 [dependencies]
-clap = "2.29"
+clap = "3.0.0-alpha1"
 ```
 
 This is inherently an unresolvable crate graph in Cargo right now. Cargo requires there's only one major version of a crate, and being in the same workspace these two crates must share a version. This is impossible in this location, though, as these version constraints cannot be met.

TODO.md

@@ -0,0 +1,19 @@
+- [ ] update-todo.sh
+- [ ] src/lib.rs
+    -[ ] 578:@TODO @release @docs
+    -[ ] 580:@TODO @release @docs
+    -[ ] 583:@TODO @release @docs
+    -[ ] 592:@TODO @release @docs
+    -[ ] 598:@TODO @release @docs
+    -[ ] 608:@TODO @release @docs
+    -[ ] 610:@TODO @release @docs
+    -[ ] 614:@TODO @release @docs
+    -[ ] 616:@TODO @release @docs
+    -[ ] 619:@TODO @release @docs
+    -[ ] 623:@TODO @release @docs
+- [ ] src/app/parser.rs
+    -[ ] 678:@TODO @perf: cloning all these Apps ins't great, but since it's just displaying the help
+- [ ] src/app/mod.rs
+    -[ ] 1760:@TODO @v3-alpha @perf: should only propagate globals to subcmd we find, or for help
+- [ ] src/args/arg.rs
+    -[ ] 3545:@TODO @p2 @docs @release: write docs

benches/01_default.rs

@@ -8,11 +8,7 @@ use clap::App;
 use test::Bencher;
 
 #[bench]
-fn build_app(b: &mut Bencher) {
-    b.iter(|| App::new("claptests"));
-}
+fn build_app(b: &mut Bencher) { b.iter(|| App::new("claptests")); }
 
 #[bench]
-fn parse_clean(b: &mut Bencher) {
-    b.iter(|| App::new("claptests").get_matches_from(vec![""]));
-}
+fn parse_clean(b: &mut Bencher) { b.iter(|| App::new("claptests").get_matches_from(vec![""])); }

benches/02_simple.rs

@@ -20,25 +20,18 @@ macro_rules! create_app {
 }
 
 #[bench]
-fn build_app(b: &mut Bencher) {
-
-    b.iter(|| create_app!());
-}
+fn build_app(b: &mut Bencher) { b.iter(|| create_app!()); }
 
 #[bench]
 fn add_flag(b: &mut Bencher) {
-    fn build_app() -> App<'static, 'static> {
-        App::new("claptests")
-    }
+    fn build_app() -> App<'static, 'static> { App::new("claptests") }
 
     b.iter(|| build_app().arg(Arg::from_usage("-s, --some 'something'")));
 }
 
 #[bench]
 fn add_flag_ref(b: &mut Bencher) {
-    fn build_app() -> App<'static, 'static> {
-        App::new("claptests")
-    }
+    fn build_app() -> App<'static, 'static> { App::new("claptests") }
 
     b.iter(|| {
         let arg = Arg::from_usage("-s, --some 'something'");
@@ -48,18 +41,14 @@ fn add_flag_ref(b: &mut Bencher) {
 
 #[bench]
 fn add_opt(b: &mut Bencher) {
-    fn build_app() -> App<'static, 'static> {
-        App::new("claptests")
-    }
+    fn build_app() -> App<'static, 'static> { App::new("claptests") }
 
     b.iter(|| build_app().arg(Arg::from_usage("-s, --some <FILE> 'something'")));
 }
 
 #[bench]
 fn add_opt_ref(b: &mut Bencher) {
-    fn build_app() -> App<'static, 'static> {
-        App::new("claptests")
-    }
+    fn build_app() -> App<'static, 'static> { App::new("claptests") }
 
     b.iter(|| {
         let arg = Arg::from_usage("-s, --some <FILE> 'something'");
@@ -69,18 +58,14 @@ fn add_opt_ref(b: &mut Bencher) {
 
 #[bench]
 fn add_pos(b: &mut Bencher) {
-    fn build_app() -> App<'static, 'static> {
-        App::new("claptests")
-    }
+    fn build_app() -> App<'static, 'static> { App::new("claptests") }
 
     b.iter(|| build_app().arg(Arg::with_name("some")));
 }
 
 #[bench]
 fn add_pos_ref(b: &mut Bencher) {
-    fn build_app() -> App<'static, 'static> {
-        App::new("claptests")
-    }
+    fn build_app() -> App<'static, 'static> { App::new("claptests") }
 
     b.iter(|| {
         let arg = Arg::with_name("some");
@@ -89,14 +74,10 @@ fn add_pos_ref(b: &mut Bencher) {
 }
 
 #[bench]
-fn parse_clean(b: &mut Bencher) {
-    b.iter(|| create_app!().get_matches_from(vec![""]));
-}
+fn parse_clean(b: &mut Bencher) { b.iter(|| create_app!().get_matches_from(vec![""])); }
 
 #[bench]
-fn parse_flag(b: &mut Bencher) {
-    b.iter(|| create_app!().get_matches_from(vec!["myprog", "-f"]));
-}
+fn parse_flag(b: &mut Bencher) { b.iter(|| create_app!().get_matches_from(vec!["myprog", "-f"])); }
 
 #[bench]
 fn parse_option(b: &mut Bencher) {