branch: elpa/clojure-ts-mode
commit e0703fff14de7cdf923093b727b80c465d2c1343
Author: Bozhidar Batsov <bozhi...@batsov.dev>
Commit: Bozhidar Batsov <bozhi...@batsov.dev>
Add a "Caveats" section the to the README
---
README.md | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/README.md b/README.md
index d583059fa8..03e00e4fe9 100644
--- a/README.md
+++ b/README.md
@@ -223,8 +223,22 @@ After installing the package do the following.
(cider-clojure-cli-aliases . ":test:repl")))
```
+## Caveats
+
+As the TreeSitter Emacs APIs are new and keep evolving there are some
+differences in the behavior of `clojure-ts-mode` on different Emacs versions.
+Here are some notable examples:
+
+- On Emacs 29 the parent mode is `prog-mode`, but on Emacs 30+ it's both
`prog-mode`
+and `clojure-mode` (this is very helpful when dealing with `derived-mode-p`
checks)
+
## Frequently Asked Questions
+### What `clojure-mode` features are currently missing?
+
+As of version 0.2.x, the most obvious missing feature are the various
+refactoring commands in `clojure-mode`.
+
### Does `clojure-ts-mode` work with CIDER?
Yes! Preliminary support for `clojure-ts-mode` was released in [CIDER
