-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# bugs | ||
|
||
A CLI written in bun that helps write higher quality tests. A | ||
bun-ny tool to catch bugs, hence the name (Bugs Bunny, anyone?). | ||
|
||
## Getting Started | ||
|
||
### Installation | ||
|
||
You should be able to install `bugs` using `npm`, or related | ||
package managers. | ||
|
||
```sh | ||
npm install -g bugs | ||
``` | ||
|
||
### Usage | ||
|
||
We can use bugs in 2 ways: | ||
|
||
#### To collect suggestions for tests based on code | ||
|
||
```sh | ||
bugs suggest -c code | ||
``` | ||
|
||
#### To review existing tests for a piece of code | ||
|
||
```sh | ||
bugs review -c code - tests | ||
``` | ||
|
||
### Building | ||
|
||
To build `bugs`, we use `bun` with `typescript` on `node 22`. |