You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/modules/ROOT/pages/platforms/basilisp.adoc
+33-23Lines changed: 33 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ since CIDER 1.14
5
5
6
6
== Overview
7
7
8
-
Basilisp aims to enable writing Clojure programs on Python with full Python interoperability. It is highly compatible with Clojure.
8
+
Basilisp aims to enable writing Clojure programs on Python with full interoperability. It is highly compatible with Clojure.
9
9
10
10
To install Basilisp, run:
11
11
@@ -15,16 +15,18 @@ To install Basilisp, run:
15
15
16
16
There are several ways to connect to Basilisp.
17
17
18
-
* kbd:[M-x cider-jack-in] and kbd:[M-5 M-x cider-jack-in-universal]
18
+
=== jack-in
19
19
20
-
If you have created a `basilisp.edn` project file at your root of your project tree, you can jack in to the project `M-x cider-jack-in`. The `basilisp.edn` is similar to `deps.edn` for clojure-cli projects. It can be left empty just to mark the root of your project.
20
+
kbd:[M-x cider-jack-in] and kbd:[M-5 M-x cider-jack-in-universal]
21
+
22
+
If you have created a `basilisp.edn` project file at your root of your project tree, you can jack in to the project with `M-x cider-jack-in`. The `basilisp.edn` is similar to `deps.edn` for clojure-cli projects. It can be left empty just to mark the root of your project.
21
23
22
24
If you don't have or want a basilisp project file, you can use universal jack in with a numerical argument of 5:
23
25
24
26
- kbd:[M-5 M-x cider-jack-in-universal], or
25
-
- kbd:[M-5 C-c C-x j u], from within file in clojure-mode
27
+
- kbd:[M-5 C-c C-x j u], from within a file in clojure-mode
26
28
27
-
(Note: an alternative to kbd:[M-5] is kbd:[C-u 5])
29
+
NOTE: an alternative to kbd:[M-5] is kbd:[C-u 5]
28
30
29
31
You can also bind the universal jack-in to Basilisp to a function to use as a shortcut, for example
30
32
@@ -35,7 +37,9 @@ You can also bind the universal jack-in to Basilisp to a function to use as a sh
35
37
(cider-jack-in-universal 5)))
36
38
----
37
39
38
-
* kbd:[M-x cider-connect]
40
+
=== connect
41
+
42
+
kbd:[M-x cider-connect]
39
43
40
44
You can start its bundled nREPL server:
41
45
@@ -47,31 +51,37 @@ To see available options, type `basilisp nrepl-server -h` in a shell prompt.
47
51
48
52
== Configuration
49
53
50
-
The jack-in command can be configured via several defcustoms:
54
+
The jack-in command can be configured with the following defcustoms
55
+
56
+
=== `cider-basilisp-command`
51
57
52
-
* `cider-basilisp-command` (default is `basilisp`).
58
+
(default is `basilisp`)
53
59
54
60
If Basilisp is installed in a virtual environment, update this to the full path of the `basilisp` executable within that virtual environment.
55
61
56
-
* `cider-basilisp-parameters` (default is `nrepl-server`).
62
+
=== `cider-basilisp-parameters`
63
+
64
+
(default is `nrepl-server`)
65
+
66
+
=== Customization
57
67
58
68
There at few ways to setup (custom) variables in Emacs
59
69
60
-
- https://www.gnu.org/software/emacs/manual/html_node/emacs/Easy-Customization.html[Examining and Setting Variables]
70
+
==== 1. https://www.gnu.org/software/emacs/manual/html_node/emacs/Easy-Customization.html[Examining and Setting Variables]
61
71
62
-
kbd:[C-h v cider-basilisp-command], and
63
-
kbd:[C-h v cider-basilisp-parameters]
72
+
- kbd:[C-h v cider-basilisp-command], and
73
+
- kbd:[C-h v cider-basilisp-parameters]
64
74
65
-
- https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html[Per-Diretory Local Variables]
75
+
==== 2. https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html[Per-Diretory Local Variables]
66
76
67
77
Uses `.dir-locals.el` to setup per mode variables. This file is typically stored at the root of the project.
68
78
69
79
For example, to set the path to the basilisp executable within a virtual environment
0 commit comments