Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
onur-ozkan committed Nov 17, 2023
1 parent 0fc8611 commit f249293
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,26 @@
# cargo-qtest: interactive test runner for rust projects
# cargo-qtest: an interactive test runner for rust projects

`cargo-qtest` is a command-line tool that enhances the testing experience for Rust projects by providing an interactive and flexible way to find & select and run tests using pattern matching.

![capture](https://github.com/onur-ozkan/cargo-qtest/assets/39852038/9274506e-58f1-4676-a387-04240b18048f)

### Install

To install `cargo-qtest`, run the following command:

```sh
cargo install --locked cargo-qtest
```

Once installed, you can start using it with either `cargo qtest` or `cargo-qtest` in any of your projects.

### Usage

Same as `cargo test`. All args/flags can still be used.
The usage of `cargo qtest` mirrors that of cargo test. All arguments and flags applicable to cargo test can still be used with `cargo qtest`.

### Q: Why?

- In big projects, executing particular tests from their path becomes challenging.
- Running particular tests from different modules at the same time (e.g., `apple::test_fn` and `lemon::test_fn`).
- I just want to run all the tests matches with "x pattern" in their names.
- Sometimes executing specific tests based on their paths can be challenging (specially when there are too many modules).
- Running particular tests from different modules simultaneously (e.g., `apple::test_fn` and `lemon::test_fn`).
- Selectively running tests matching a specific pattern in their names.
- It's cool.

0 comments on commit f249293

Please sign in to comment.