Skip to content

Commit a681ddf

Browse files
committed
Add README section about backend config
1 parent a73f369 commit a681ddf

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ See the [feature demo](#feature-demo) for a quick overview.
5050

5151
+ [nui.nvim](https://github.com/MunifTanjim/nui.nvim)
5252
+ [nvim-nio](https://github.com/nvim-neotest/nvim-nio)
53+
+ [conjure](https://github.com/olical/conjure) [semi-optional]
5354

5455
#### Clojure Dependencies
5556

@@ -171,3 +172,31 @@ require("clojure-test").setup({
171172
}
172173
})
173174
```
175+
176+
## Architecture
177+
178+
This is still TBD
179+
180+
## Custom Backends
181+
182+
This plugin uses a configurable backend protocol to communicate with the Clojure nREPL server. This backend is
183+
responsible for performing discovery of test namespaces and tests, as well as executing these tests and providing back
184+
the test reports.
185+
186+
By default, clojure-test is configured to use a built-in [Conjure](https://github.com/olical/conjure) REPL backend. You
187+
can find the relevant implementations
188+
[here](https://github.com/julienvincent/clojure-test.nvim/blob/master/lua/clojure-test/backends/repl.lua) and
189+
[here](https://github.com/julienvincent/clojure-test.nvim/blob/master/lua/clojure-test/clients/conjure.lua).
190+
191+
As an example, here is how the default backend is configured:
192+
193+
```lua
194+
local backends = require("clojure-test.backends")
195+
local clients = require("clojure-test.clients")
196+
197+
require("clojure-test").setup({
198+
backend = backends.repl.create(clients.conjure),
199+
})
200+
```
201+
202+
Or you can implement your own backend.

0 commit comments

Comments
 (0)