Skip to content

Commit 140bcb1

Browse files
committed
[Fix #1454] Drop stale tide references from docs
prelude-ts moved from tide to typescript-ts-mode + LSP, but the TS module docs and the prelude-format-on-save docstring still described tide. Rewrite docs/modules/ts.md for the current setup (point to the prelude-apheleia module for format-on-save) and update the docstring.
1 parent b88eac8 commit 140bcb1

3 files changed

Lines changed: 25 additions & 24 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
- Use `ocaml-eglot-mode` instead of the obsolete `ocaml-eglot` alias (renamed in `ocaml-eglot` 1.4.0).
2929
- Add a temporary `eglot-server-programs` entry for `neocaml` so older `neocaml` versions still get `ocamllsp` started. Can be removed once `neocaml >= 20260331` is widely available on MELPA.
3030
- Drop `M-g e` and `M-g f` from `prelude-vertico`'s consult bindings so they no longer shadow the avy bindings (`avy-goto-word-0`, `avy-goto-line`) set in core. Bind `consult-compile-error` / `consult-flymake` in your personal config if you want them.
31+
- [#1454](https://github.com/bbatsov/prelude/issues/1454): Drop stale `tide` references from the docs now that `prelude-ts` uses `typescript-ts-mode` + LSP.
3132

3233
## 2.1.0 (2026-03-29)
3334

core/prelude-custom.el

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ in the desired elisp file."
102102

103103
(defcustom prelude-format-on-save t
104104
"Run mode specific format on file before it's saved.
105-
Currently only applies to tide-mode."
105+
Currently only applies to TypeScript files."
106106
:type 'boolean
107107
:group 'prelude)
108108

docs/modules/ts.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,41 @@
66

77
## Packages
88

9-
- [typescript-mode](https://github.com/emacs-typescript/typescript.el) -
10-
major mode for TypeScript
11-
- [tide](https://github.com/ananthakumaran/tide) - TypeScript
12-
Interactive Development Environment
9+
This module relies on Emacs' built-in tree-sitter support and LSP, so it
10+
doesn't pull in any third-party packages:
11+
12+
- `typescript-ts-mode` / `tsx-ts-mode` - tree-sitter powered major modes
13+
for TypeScript and TSX (built into Emacs 29+)
1314

1415
## Features
1516

16-
Tide provides a rich development experience for TypeScript:
17+
Code intelligence is provided by an LSP server (Eglot by default):
1718

1819
- Code completion (via company-mode)
19-
- Syntax checking (via Flycheck)
20+
- Syntax checking (via Flymake or Flycheck)
2021
- Eldoc integration for inline type information
21-
- Identifier highlighting (`tide-hl-identifier-mode`)
22-
- Format on save (when `prelude-format-on-save` is enabled)
22+
- Navigation, refactoring, and documentation lookup
2323

2424
## Prerequisites
2525

26-
You need [Node.js](https://nodejs.org/) and `tsserver` (bundled with TypeScript)
27-
installed. Install TypeScript globally:
26+
The tree-sitter modes need the TypeScript grammars installed. You can grab
27+
them with:
2828

29-
```sh
30-
npm install -g typescript
29+
```emacs-lisp
30+
(treesit-install-language-grammar 'typescript)
31+
(treesit-install-language-grammar 'tsx)
3132
```
3233

33-
## Configuration
34-
35-
### Format on Save
34+
For code intelligence you need [Node.js](https://nodejs.org/) and a language
35+
server. The default is
36+
[typescript-language-server](https://github.com/typescript-language-server/typescript-language-server):
3637

37-
By default, Tide formats the buffer before saving when `prelude-format-on-save`
38-
is enabled. You can customize the format action:
38+
```sh
39+
npm install -g typescript typescript-language-server
40+
```
3941

40-
```emacs-lisp
41-
;; Disable format on save for TypeScript
42-
(setq prelude-format-on-save nil)
42+
## Format on Save
4343

44-
;; Or use a different formatter
45-
(setq prelude-ts-format-action #'my-custom-format-function)
46-
```
44+
For automatic formatting on save, enable the
45+
[Apheleia](apheleia.md) module. It runs `prettier` (or another configured
46+
formatter) asynchronously whenever you save a TypeScript buffer.

0 commit comments

Comments
 (0)