[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/cider c5e575ed1b 1/2: [Docs] Add more documentation about
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/cider c5e575ed1b 1/2: [Docs] Add more documentation about the clojure-ts-mode support |
Date: |
Mon, 19 Feb 2024 03:59:32 -0500 (EST) |
branch: elpa/cider
commit c5e575ed1bb8d86274f03bfbfb7eb670b353e12e
Author: Bozhidar Batsov <bozhidar@batsov.dev>
Commit: Bozhidar Batsov <bozhidar@batsov.dev>
[Docs] Add more documentation about the clojure-ts-mode support
---
README.md | 15 ++++++++-------
doc/modules/ROOT/pages/caveats.adoc | 12 +++++++-----
2 files changed, 15 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 1e11c3c26c..cac8504364 100644
--- a/README.md
+++ b/README.md
@@ -13,13 +13,13 @@ CIDER is the **C**lojure(Script) **I**nteractive
**D**evelopment **E**nvironment
that **R**ocks!
CIDER extends Emacs with support for [interactive
-programming](https://docs.cider.mx/cider/usage/interactive_programming.html)
-in Clojure. The features are centered around `cider-mode`, an Emacs
-minor-mode that complements [clojure-mode][]. While `clojure-mode`
-supports editing Clojure source files, `cider-mode` adds support for
-interacting with a running Clojure process for compilation, code
-completion, debugging, definition and documentation lookup, running
-tests and so on.
+programming](https://docs.cider.mx/cider/usage/interactive_programming.html) in
+Clojure. The features are centered around `cider-mode`, an Emacs minor-mode
that
+complements [clojure-mode][] and [clojure-ts-mode][]. While `clojure-mode` and
+`clojure-ts-mode` support editing Clojure source files, `cider-mode` adds
+support for interacting with a running Clojure process for compilation, code
+completion, debugging, definition and documentation lookup, running tests and
so
+on.
----------
[![OpenCollective](https://opencollective.com/cider/backers/badge.svg)](#open-collective-backers)
@@ -270,4 +270,5 @@ Copyright © 2012-2024 Bozhidar Batsov, Artur Malabarba, Tim
King, Phil Hagelber
[Sly]: https://github.com/joaotavora/sly
[Geiser]: https://github.com/jaor/geiser
[clojure-mode]: https://github.com/clojure-emacs/clojure-mode
+[clojure-ts-mode]: https://github.com/clojure-emacs/clojure-ts-mode
[inf-clojure]: https://github.com/clojure-emacs/inf-clojure
diff --git a/doc/modules/ROOT/pages/caveats.adoc
b/doc/modules/ROOT/pages/caveats.adoc
index 93ec792004..53c6c0c829 100644
--- a/doc/modules/ROOT/pages/caveats.adoc
+++ b/doc/modules/ROOT/pages/caveats.adoc
@@ -84,16 +84,18 @@ the
xref:basics/middleware_setup.adoc#setting-up-a-standalone-repl[standalone RE
* Adjust the value of `cider-injected-nrepl-version` to the same nREPL version
as the
one that's bundled with Leiningen.
-== Clojure-ts-mode integration
+== clojure-ts-mode integration
-Cider has basic support for working with
+NOTE: `clojure-ts-mode` support was introduced in CIDER 1.14.
+
+CIDER has basic support for working with
https://github.com/clojure-emacs/clojure-ts-mode[clojure-ts-mode] buffers, but
it still depends on
https://github.com/clojure-emacs/clojure-mode[clojure-mode] for certain
functionality, like
-extracting information about clojure code out of the buffer. We hope to make
clojure-ts-mode capable
-of providing cider with all the functionality it needs to interact with
clojure buffers, but that
+extracting information about Clojure code out of the buffer. We hope to make
`clojure-ts-mode` capable
+of providing CIDER with all the functionality it needs to interact with
Clojure buffers, but that
will take some time.
Additionally, some features like
xref:config/indentation.adoc#dynamic-indentation[`cider-dynamic-indentation`]
and
xref:config/syntax_highlighting.adoc#dynamic-syntax-highlighting[`cider-font-lock-dynamically`]
-are not supported by clojure-ts-mode.
+are not supported by `clojure-ts-mode`.