CLI redesign (#58, #134, #140)

CHANGELOG.md

@@ -21,7 +21,7 @@ All user visible changes to `cucumber` crate will be documented in this file. Th
 - Replaced `#[given(step)]`, `#[when(step)]` and `#[then(step)]` function argument attributes with a single `#[step]`. ([#128])
 - Made test callbacks first argument `&mut World` instead of `World`. ([#128])
 - Made `#[step]` argument of step functions `Step` instead of `StepContext` again, while test callbacks still receive `StepContext` as a second parameter. ([#128])
-- Deprecated `--nocapture` and `--debug` CLI options to be completely redesigned in `0.11` release. ([#137])
+- Completely redesign and reworked CLI, making it composable and extendable. ([#144])
 - [Hooks](https://cucumber.io/docs/cucumber/api/#hooks) now accept optional `&mut World` as their last parameter. ([#142])
 
 ### Added
@@ -35,6 +35,7 @@ All user visible changes to `cucumber` crate will be documented in this file. Th
 [#137]: /../../pull/137
 [#142]: /../../pull/142
 [#143]: /../../pull/143
+[#144]: /../../pull/144
 
 
 

Cargo.toml

@@ -32,7 +32,6 @@ macros = ["cucumber-codegen", "inventory"]
 [dependencies]
 async-trait = "0.1.40"
 atty = "0.2.14"
-clap = { version = "=3.0.0-beta.5", features = ["derive"] }
 console = "0.15"
 derive_more = { version = "0.99.16", features = ["deref", "deref_mut", "display", "error", "from"], default_features = false }
 either = "1.6"
@@ -44,12 +43,14 @@ linked-hash-map = "0.5.3"
 once_cell = { version = "1.8", features = ["parking_lot"] }
 regex = "1.5"
 sealed = "0.3"
+structopt = "0.3.25"
 
 # "macros" feature dependencies
 cucumber-codegen = { version = "0.10", path = "./codegen", optional = true }
 inventory = { version = "0.1.10", optional = true }
 
 [dev-dependencies]
+humantime = "2.1"
 tokio = { version = "1.12", features = ["macros", "rt-multi-thread", "time"] }
 
 [[test]]

README.md

@@ -44,7 +44,7 @@ struct World {
     capacity: usize,
 }
 
-#[async_trait(? Send)]
+#[async_trait(?Send)]
 impl cucumber::World for World {
     type Error = Infallible;
 

book/src/Features.md

@@ -382,5 +382,54 @@ World::cucumber()
 
 
 
+## CLI options
+
+Library provides several options that can be passed to the command-line.
+
+Use `--help` flag to print out all the available options:
+```shell
+cargo test --test <test-name> -- --help
+```
+
+Default output is:
+```
+cucumber 0.10.0
+Run the tests, pet a dog!
+
+USAGE:
+    cucumber [FLAGS] [OPTIONS]
+
+FLAGS:
+    -h, --help       Prints help information
+    -V, --version    Prints version information
+    -v, --verbose    Increased verbosity of an output: additionally outputs step's doc string (if present)
+
+OPTIONS:
+        --color <auto|always|never>    Coloring policy for a console output [default: auto]
+    -i, --input <glob>                 Glob pattern to look for feature files with. By default, looks for `*.feature`s
+                                       in the path configured tests runner
+    -c, --concurrency <int>            Number of scenarios to run concurrently. If not specified, uses the value
+                                       configured in tests runner, or 64 by default
+    -n, --name <regex>                 Regex to filter scenarios by their name [aliases: scenario-name]
+    -t, --tags <tagexpr>               Tag expression to filter scenarios by [aliases: scenario-tags]
+```
+
+Example with [tag expressions](https://cucumber.io/docs/cucumber/api#tag-expressions) for filtering `Scenario`s:
+```shell
+cargo test --test <test-name> -- --tags='@cat or @dog or @ferris'
+```
+
+> Note: CLI overrides any configurations set in the code. 
+
+
+### Customizing CLI options
+
+CLI options are designed to be composable from the one provided by [`Parser::Cli`](https://docs.rs/cucumber/*/cucumber/trait.Parser.html#associatedtype.Cli), [`Runner::Cli`](https://docs.rs/cucumber/*/cucumber/trait.Runner.html#associatedtype.Cli) and [`Writer::Cli`](https://docs.rs/cucumber/*/cucumber/trait.Writer.html#associatedtype.Cli).
+
+You may also extend CLI options with custom ones, if you have such a need for running your tests. See a [`cli::Opts` example](https://docs.rs/cucumber/*/cucumber/cli/struct.Opts.html#example) for more details.
+
+
+
+
 [Cucumber]: https://cucumber.io
 [Gherkin]: https://cucumber.io/docs/gherkin

codegen/Cargo.toml

@@ -31,7 +31,6 @@ syn = { version = "1.0.74", features = ["derive", "extra-traits", "full"] }
 [dev-dependencies]
 async-trait = "0.1"
 cucumber = { path = "..", features = ["macros"] }
-futures = "0.3"
 tokio = { version = "1.12", features = ["macros", "rt-multi-thread", "time"] }
 
 [[test]]

codegen/src/lib.rs

@@ -93,11 +93,11 @@
     variant_size_differences
 )]
 
-use proc_macro::TokenStream;
-
 mod attribute;
 mod derive;
 
+use proc_macro::TokenStream;
+
 /// Helper macro for generating public shims for [`macro@given`], [`macro@when`]
 /// and [`macro@then`] attributes.
 macro_rules! step_attribute {
@@ -150,7 +150,7 @@ macro_rules! step_attribute {
         /// - To use [`gherkin::Step`], name the argument as `step`,
         ///   **or** mark the argument with a `#[step]` attribute.
         ///
-        /// ```
+        /// ```rust
         /// # use std::convert::Infallible;
         /// #
         /// # use async_trait::async_trait;
@@ -167,7 +167,7 @@ macro_rules! step_attribute {
         /// #         Ok(Self {})
         /// #     }
         /// # }
-        ///
+        /// #
         /// #[given(regex = r"(\S+) is not (\S+)")]
         /// fn test_step(
         ///     w: &mut MyWorld,