[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/clojure-ts-mode 9bb2eba3a1 32/71: Add a "Rationale" sectio
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/clojure-ts-mode 9bb2eba3a1 32/71: Add a "Rationale" section to the README |
Date: |
Fri, 25 Aug 2023 03:59:34 -0400 (EDT) |
branch: elpa/clojure-ts-mode
commit 9bb2eba3a10b3350195e8a11bbade48b1d8113ec
Author: Bozhidar Batsov <bozhidar@batsov.dev>
Commit: Bozhidar Batsov <bozhidar@batsov.dev>
Add a "Rationale" section to the README
---
README.md | 23 +++++++++++++++++++++--
1 file changed, 21 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 3e27ada1a1..4f69d5f08f 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,28 @@ highlighting), indentation, and navigation support for the
[tree-sitter-clojure](https://github.com/sogaiu/tree-sitter-clojure)
[tree-sitter](https://tree-sitter.github.io/tree-sitter/) grammar.
-## Warning
+## Rationale
-This library is still under development. Breaking changes should be expected.
+[clojure-mode](https://github.com/clojure-emacs/clojure-mode) has served us
well
+for a very long time, but it suffers from a few [long-standing
+problems](https://github.com/clojure-emacs/clojure-mode#caveats), related to
+Emacs limitations baked into its design. The introduction of built-in support
+for Tree-sitter in Emacs 29 provides a natural opportunity to address many of
+them. Enter `clojure-ts-mode`.
+
+Keep in mind that the transition to `clojure-ts-mode` won't happen overnight
for several reasons:
+
+- getting to feature parity with `clojure-mode` will take some time
+- tools that depend on `clojure-mode` will need to be updated to work with
`clojure-ts-mode`
+- we still need to support users of older Emacsen that don't support
Tree-sitter
+
+That's why `clojure-ts-mode` is being developed independently of
`clojure-mode` and will one day replace it when the time is right. (e.g. 3
major Emacs version down the road, so circa Emacs 32)
+
+You can read more about the vision for `clojure-ts-mode`
[here](https://metaredux.com/posts/2023/03/12/clojure-mode-meets-tree-sitter.html).
+
+## Current Status
+
+**This library is still under development. Breaking changes should be
expected.**
You can track the current progress towards an initial release
[here](https://github.com/clojure-emacs/clojure-ts-mode/issues/1).
- [nongnu] elpa/clojure-ts-mode b73f2326e8 48/71: Fix typo and incorrect use of "abstract" syntax tree., (continued)
- [nongnu] elpa/clojure-ts-mode b73f2326e8 48/71: Fix typo and incorrect use of "abstract" syntax tree., ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode f3697d0cb2 09/71: Tweak the README's formatting a bit, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 9b29677722 36/71: Require library used for lm-version function, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 27c5cc13d7 20/71: Remove debugging message from defun-type-regexp, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 4eb602cc8b 01/71: Initial commit, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode c3631f6c17 15/71: Add breaking change warning, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 859b0b13a7 46/71: Fix what I think is a typo, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 5a4696116f 49/71: Add LICENSE file (GPL3), ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 7dcf82b81d 17/71: Support `comment-region` command, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 329a39ba3b 68/71: Release 0.1.4, update changelog, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 9bb2eba3a1 32/71: Add a "Rationale" section to the README,
ELPA Syncer <=
- [nongnu] elpa/clojure-ts-mode 27c5cf08d6 69/71: Fix bad sha in change log, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 92a50b7635 66/71: Update changelog for 0.1.3, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode ad5af674ec 37/71: Start documenting the design, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 4dc853df16 57/71: Create derived major modes for clojure(c|script|dart), ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 9a96a78a93 19/71: Add fixed indent rules, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode e101674bac 06/71: Typos!!, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode f187b72aa9 62/71: Move test files to new directory, ELPA Syncer, 2023/08/25
- [nongnu] elpa/clojure-ts-mode 0e2eb1f775 14/71: Auto-install tree-sitter-clojure grammar when it's not available, ELPA Syncer, 2023/08/25