Skip to content

Commit 8aed008

Browse files
committed
Use the spelling Tree-sitter consistently
Turns out that's how the project is named officially.
1 parent 7d76cce commit 8aed008

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ for a very long time, but it suffers from a few [long-standing
1919
problems](https://github.com/clojure-emacs/clojure-mode#caveats), related to
2020
Emacs limitations baked into its design. The introduction of built-in support
2121
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:
2323

2424
- fast, accurate and more granular font-locking
2525
- fast indentation
2626
- 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
2727

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
2929
indentation, which makes it easier to contribute to `clojure-ts-mode`, and to improve it in general.
3030

3131
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
5555

5656
### Requirements
5757

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-:`):
6060

6161
``` emacs-lisp
6262
(treesit-available-p)
6363
```
6464

6565
Additionally, you'll need to have Git and some C compiler (`cc`) installed and available
6666
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.
6868

6969
> [!TIP]
7070
>
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
7272
> results you should use the latest stable Emacs release or even the development version of Emacs.
7373
> See the "Caveats" section for more on the subject.
7474
@@ -121,7 +121,7 @@ Once installed, evaluate `clojure-ts-mode.el` and you should be ready to go.
121121
> `clojure-ts-mode` install the required grammars automatically, so for most
122122
> people no manual actions will be required.
123123
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:
125125

126126
- The Clojure grammar, mentioned earlier
127127
- [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
139139

140140
### Upgrading tree-sitter grammars
141141

142-
To reinstall or upgrade TreeSitter grammars, you can execute:
142+
To reinstall or upgrade Tree-sitter grammars, you can execute:
143143

144144
```emacs-lisp
145145
M-x clojure-ts-reinstall-grammars
@@ -374,14 +374,14 @@ After installing the package do the following.
374374

375375
## Caveats
376376

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
378378
differences in the behavior of `clojure-ts-mode` on different Emacs versions.
379379
Here are some notable examples:
380380

381381
- On Emacs 29 the parent mode is `prog-mode`, but on Emacs 30+ it's both `prog-mode`
382382
and `clojure-mode` (this is very helpful when dealing with `derived-mode-p` checks)
383383
- 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
385385
available, to rebind some commands.
386386
- The indentation of list elements with metadata is inconsistent with other
387387
collections. This inconsistency stems from the grammar's interpretation of

0 commit comments

Comments
 (0)