Skip to content

Commit 4b1ee98

Browse files
committed
doc: readme: describe cognitect test-runner opts
Also add a note on why we have to 2 REPL launchers.
1 parent b1f81f3 commit 4b1ee98

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,11 @@ To run default tests only:
121121
```
122122
bb test
123123
```
124+
You can also use [cognitect test-runner](https://github.com/cognitect-labs/test-runner?tab=readme-ov-file#invoke-with-clojure--m-clojuremain) options, for example, to run a single test:
125+
```
126+
bb test --var babashka.fs-test/walk-test
127+
```
128+
124129
To fire up a REPL when working on these tests, run `bb dev`.
125130

126131
### Scratch CWD Tests
@@ -129,10 +134,18 @@ To run these tests only:
129134
```
130135
bb test-cwd
131136
```
137+
As above, cognitect test-runner options work:
138+
```
139+
bb test-cwd --var babashka.fs-cwd-test/es-copy-test
140+
```
141+
132142
The scratch current working directory is `target/test-cwd`.
133143
To fire up a REPL for these tests, run `bb dev-cwd`.
134144
Note that the `.nrepl-port` file will be generated under `target/test-cwd/`, so you'll have to type the REPL port in manually when connecting.
135145

146+
> [!NOTE]
147+
> We currently have 2 REPL launcher tasks, `dev` and `dev-cwd`, because they each rely on a different current working directory.
148+
136149
### API Docs
137150
This project generates API docs with quickdoc, to regenerate `API.md`:
138151
```

0 commit comments

Comments
 (0)