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: README.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -19,13 +19,13 @@ for a very long time, but it suffers from a few [long-standing
19
19
problems](https://github.com/clojure-emacs/clojure-mode#caveats), related to
20
20
Emacs limitations baked into its design. The introduction of built-in support
21
21
for Tree-sitter in Emacs 29 presents a natural opportunity to address many of
22
-
them. Enter `clojure-ts-mode`, which makes use of TreeSitter to provide:
22
+
them. Enter `clojure-ts-mode`, which makes use of Tree-sitter to provide:
23
23
24
24
- fast, accurate and more granular font-locking
25
25
- fast indentation
26
26
- common Emacs functionality like structured navigation, `imenu` (an outline of a source buffer), current form inference (used internally by various Emacs modes and utilities), etc
27
27
28
-
Working with TreeSitter is significantly easier than the legacy Emacs APIs for font-locking and
28
+
Working with Tree-sitter is significantly easier than the legacy Emacs APIs for font-locking and
29
29
indentation, which makes it easier to contribute to `clojure-ts-mode`, and to improve it in general.
30
30
31
31
Keep in mind that the transition to `clojure-ts-mode` won't happen overnight for several reasons:
@@ -55,20 +55,20 @@ Those will be addressed over the time, as more and more people use `clojure-ts-m
55
55
56
56
### Requirements
57
57
58
-
For `clojure-ts-mode` to work, you need Emacs 30+ built with TreeSitter support.
59
-
To check if your Emacs supports TreeSitter run the following (e.g. by using `M-:`):
58
+
For `clojure-ts-mode` to work, you need Emacs 30+ built with Tree-sitter support.
59
+
To check if your Emacs supports Tree-sitter run the following (e.g. by using `M-:`):
60
60
61
61
```emacs-lisp
62
62
(treesit-available-p)
63
63
```
64
64
65
65
Additionally, you'll need to have Git and some C compiler (`cc`) installed and available
66
66
in your `$PATH` (or Emacs's `exec-path`), for `clojure-ts-mode` to be able to install the required
67
-
TreeSitter grammars automatically.
67
+
Tree-sitter grammars automatically.
68
68
69
69
> [!TIP]
70
70
>
71
-
> As the TreeSitter support in Emacs is still fairly new and under active development itself, for optimal
71
+
> As the Tree-sitter support in Emacs is still fairly new and under active development itself, for optimal
72
72
> results you should use the latest stable Emacs release or even the development version of Emacs.
73
73
> See the "Caveats" section for more on the subject.
74
74
@@ -121,7 +121,7 @@ Once installed, evaluate `clojure-ts-mode.el` and you should be ready to go.
121
121
> `clojure-ts-mode` install the required grammars automatically, so for most
122
122
> people no manual actions will be required.
123
123
124
-
`clojure-ts-mode` makes use of two TreeSitter grammars to work properly:
124
+
`clojure-ts-mode` makes use of two Tree-sitter grammars to work properly:
125
125
126
126
- The Clojure grammar, mentioned earlier
127
127
-[markdown-inline](https://github.com/MDeiml/tree-sitter-markdown), which
@@ -139,7 +139,7 @@ each required grammar and make sure you're install the versions expected. (see
139
139
140
140
### Upgrading tree-sitter grammars
141
141
142
-
To reinstall or upgrade TreeSitter grammars, you can execute:
142
+
To reinstall or upgrade Tree-sitter grammars, you can execute:
143
143
144
144
```emacs-lisp
145
145
M-x clojure-ts-reinstall-grammars
@@ -374,14 +374,14 @@ After installing the package do the following.
374
374
375
375
## Caveats
376
376
377
-
As the TreeSitter Emacs APIs are new and keep evolving there are some
377
+
As the Tree-sitter Emacs APIs are new and keep evolving there are some
378
378
differences in the behavior of `clojure-ts-mode` on different Emacs versions.
379
379
Here are some notable examples:
380
380
381
381
- On Emacs 29 the parent mode is `prog-mode`, but on Emacs 30+ it's both `prog-mode`
382
382
and `clojure-mode` (this is very helpful when dealing with `derived-mode-p` checks)
383
383
- Navigation by sexp/lists might work differently on Emacs versions lower
384
-
than 31. Starting with version 31, Emacs uses TreeSitter 'things' settings, if
384
+
than 31. Starting with version 31, Emacs uses Tree-sitter 'things' settings, if
385
385
available, to rebind some commands.
386
386
- The indentation of list elements with metadata is inconsistent with other
387
387
collections. This inconsistency stems from the grammar's interpretation of
0 commit comments