From a681ddf1d43af7d0e81a0e998ffc11683b301721 Mon Sep 17 00:00:00 2001 From: Julien Vincent Date: Wed, 28 Aug 2024 15:14:20 +0200 Subject: [PATCH] Add README section about backend config --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index f335619..e3232d1 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,7 @@ See the [feature demo](#feature-demo) for a quick overview. + [nui.nvim](https://github.com/MunifTanjim/nui.nvim) + [nvim-nio](https://github.com/nvim-neotest/nvim-nio) ++ [conjure](https://github.com/olical/conjure) [semi-optional] #### Clojure Dependencies @@ -171,3 +172,31 @@ require("clojure-test").setup({ } }) ``` + +## Architecture + +This is still TBD + +## Custom Backends + +This plugin uses a configurable backend protocol to communicate with the Clojure nREPL server. This backend is +responsible for performing discovery of test namespaces and tests, as well as executing these tests and providing back +the test reports. + +By default, clojure-test is configured to use a built-in [Conjure](https://github.com/olical/conjure) REPL backend. You +can find the relevant implementations +[here](https://github.com/julienvincent/clojure-test.nvim/blob/master/lua/clojure-test/backends/repl.lua) and +[here](https://github.com/julienvincent/clojure-test.nvim/blob/master/lua/clojure-test/clients/conjure.lua). + +As an example, here is how the default backend is configured: + +```lua +local backends = require("clojure-test.backends") +local clients = require("clojure-test.clients") + +require("clojure-test").setup({ + backend = backends.repl.create(clients.conjure), +}) +``` + +Or you can implement your own backend.