@@ -68,7 +68,7 @@ docker-compose, ensure environment variables are set up? You do that here.
68
68
``` clj
69
69
#! /usr/bin/env bb
70
70
71
- (' require '[lambdaisland.launchpad :as launchpad])
71
+ (require '[lambdaisland.launchpad :as launchpad])
72
72
73
73
(launchpad/main {})
74
74
@@ -133,6 +133,35 @@ You don't have to stop there, you could add a `dev/user.clj` (add "dev" to your
133
133
even want to put cross-project integration tests in this repo, but the above is
134
134
the main stuff you need.
135
135
136
+ ## Using Launchpad
137
+
138
+ When invoking ` bin/launchpad ` you pass it any aliases you want to start, plus a
139
+ number of optional flags. These currently allow injecting the CIDER and/or
140
+ refactor-nrepl middleware, which will suffice to use launchpad with Emacs/CIDER,
141
+ VS Code/Calva, and probably others.
142
+
143
+ Please do file issues on Github for your favorite editor environment, we want to
144
+ eventually support every Clojure editor out there with a non-negligible user
145
+ base.
146
+
147
+ Emacs is currently best supported, since we are able to query Emacs to find
148
+ which versions of cider-nrepl and refactor-nrepl we should inject, and are also
149
+ able to instruct Emacs to connect to the REPL, so the whole process is smooth
150
+ and automated. This level of integration will not be possible with every editor,
151
+ but we can look into what options we have.
152
+
153
+ ``` clj
154
+ ➜ bin/launchpad --help
155
+ bin/launchpad <options> [proj1|proj2]+
156
+
157
+ -h, --help
158
+ -v, --verbose Print debug information
159
+ --cider-nrepl Include the CIDER nREPL middleware
160
+ --refactor-nrepl Include the refactor-nrepl middleware
161
+ --cider-connect Automatically connect CIDER
162
+ --emacs Shorthand for --cider-nrepl --refactor-nrepl --cider-connect
163
+ ```
164
+
136
165
<!-- opencollective -->
137
166
## Lambda Island Open Source
138
167
0 commit comments