Skip to content

Commit 564ba6f

Browse files
committed
Update documentation to reflect clojure-ts-mode support
Particularly the caveats page, where we describe some of the things clojure-ts-mode is currently lacking.
1 parent cfba8f1 commit 564ba6f

File tree

5 files changed

+29
-6
lines changed

5 files changed

+29
-6
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@
5656
- Add new customization variable [`cider-clojurec-eval-destination`](https://docs.cider.mx/cider/cljs/up_and_running.html#working-with-cljc-files) to allow specifying which REPL .cljc evals are sent to.
5757
- [#3354](https://github.com/clojure-emacs/cider/issues/3354): Add new customization variable [`cider-reuse-dead-repls`](https://docs.cider.mx/cider/usage/managing_connections.html#reusing-dead-repls) to control how dead REPL buffers are reused on new connections.
5858
- Basic support for using CIDER from [clojure-ts-mode](https://github.com/clojure-emacs/clojure-ts-mode)
59+
- [#3461](https://github.com/clojure-emacs/cider/pull/3461) Basic support for using CIDER from [clojure-ts-mode](https://github.com/clojure-emacs/clojure-ts-mode)
60+
- The clojure-mode dependency is still required for CIDER to function
61+
- some features like `cider-dynamic-indentation` and `cider-font-lock-dynamically` do not work with clojure-ts-mode (yet).
5962

6063
### Bugs fixed
6164

doc/modules/ROOT/pages/additional_packages.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
There are many additional Emacs packages that can enhance your Clojure programming
44
experience. The majority of the minor modes listed here should be enabled for both
5-
`cider-repl-mode` and `clojure-mode` for optimal effects.
5+
`cider-repl-mode`, `clojure-mode`, and `clojure-ts-mode` for optimal effects.
66

77
The packages listed here belong to three categories:
88

doc/modules/ROOT/pages/caveats.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,17 @@ provide the dependencies by editing your `~/.lein/profiles.clj` as described in
8383
the xref:basics/middleware_setup.adoc#setting-up-a-standalone-repl[standalone REPL] section.
8484
* Adjust the value of `cider-injected-nrepl-version` to the same nREPL version as the
8585
one that's bundled with Leiningen.
86+
87+
== Clojure-ts-mode integration
88+
89+
Cider has basic support for working with
90+
https://github.com/clojure-emacs/clojure-ts-mode[clojure-ts-mode] buffers, but it still depends on
91+
https://github.com/clojure-emacs/clojure-mode[clojure-mode] for certain functionality, like
92+
extracting information about clojure code out of the buffer. We hope to make clojure-ts-mode capable
93+
of providing cider with all the functionality it needs to interact with clojure buffers, but that
94+
will take some time.
95+
96+
Additionally, some features like
97+
xref:config/indentation.adoc#dynamic-indentation[`cider-dynamic-indentation`]
98+
and xref:config/syntax_highlighting.adoc#dynamic-syntax-highlighting[`cider-font-lock-dynamically`]
99+
are not supported by clojure-ts-mode.

doc/modules/ROOT/pages/index.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ that **R**ocks!
55

66
CIDER extends Emacs with support for xref:usage/interactive_programming.adoc[interactive programming] in Clojure. The
77
features are centered around xref:usage/cider_mode.adoc[cider-mode], an Emacs minor-mode that complements
8-
https://github.com/clojure-emacs/clojure-mode[clojure-mode]. While `clojure-mode` supports editing Clojure source files,
9-
`cider-mode` adds support for interacting with a running Clojure process for
10-
compilation, debugging, definition and documentation lookup, running tests and
11-
so on.
8+
https://github.com/clojure-emacs/clojure-mode[clojure-mode] and https://github.com/clojure-emacs/clojure-ts-mode[clojure-ts-mode].
9+
While `clojure-mode` supports editing Clojure source files, `cider-mode` adds support for interacting with a running Clojure process for
10+
compilation, debugging, definition and documentation lookup, running tests and so on.
1211

1312
.Inspired by SLIME
1413
****

doc/modules/ROOT/pages/usage/cider_mode.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,14 @@ it, so you can be productive.
1818
(add-hook 'clojure-mode-hook #'cider-mode)
1919
----
2020

21-
NOTE: There's no need to enable it explicitly for modes derived from `clojure-mode` like `clojurescript-mode`.
21+
or if you are using `clojure-ts-mode`
22+
23+
[source,lisp]
24+
----
25+
(add-hook 'clojure-ts-mode-hook #'cider-mode)
26+
----
27+
28+
NOTE: There's no need to enable it explicitly for modes derived from `clojure-mode` or `clojure-ts-mode` like `clojurescript-mode` and `clojurescript-ts-mode`.
2229

2330
== Disabling cider-mode
2431

0 commit comments

Comments
 (0)