blob: f2813e128f318359cccc2d0159121607d90e1e8b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
---
title: textlintではじめる日本語文章校正 — Zedでも動くLSPサーバーを作りました
description: 日本語の文章をリアルタイムで校正するtextlintを、Zedエディタで使えるようにするLSPサーバーを自作しました。導入方法からルール設定、自動修正、無効化までを解説します。
---
## textlintと出会うまで
議員として議会質問やブログ記事を書く中で、日本語の表記ゆれや誤字脱字に悩まされてきました。「例えば」を「たとえば」と書くべきか、「こども」か「子ども」か——校正のたびに手で直すのは限界があります。
そんなとき見つけたのが [textlint](https://textlint.github.io/) です。ESLintのように校正ルールを自由に組み合わせられる、プラグイン可能な日本語文章校正ツールです。
しかし、愛用している [Zed](https://zed.dev/) エディタにはtextlintの拡張機能がありませんでした。VSCode用はあるのに。
**なければ作ろう。** そうして生まれたのが、Zedでtextlintを動かすLSPサーバー `textlint-lsp` と、そのZed拡張機能です。
## 2つのプログラム
| 名前 | 役割 | 公開 |
|---|---|---|
| `textlint-lsp` | LSPサーバー本体。Node.jsで動作。Zed以外のエディタでも使える | npm（準備中） |
| `zed-textlint` | Zed拡張機能。Zed上で `textlint-lsp` を起動する | 開発中 |
LSPサーバーは汎用なので、VSCodeやNeovimなど他のエディタでも動きます。
## できること
- 保存時に自動校正（編集を止めて10秒後にも自動実行）
- 波線で問題箇所を表示
- 修正候補の適用（`Ctrl+.`）
- ルール単位の無効化
- `prh.yml` による独自の表記ルール定義
## セットアップ
1. Node.js 18以上をインストール
2. プロジェクトにtextlintとルールを追加
```bash
npm install --save-dev textlint @textlint/markdown
npm install --save-dev @textlint-ja/no-synonyms prh
```
3. `.textlintrc.json` を作成
```json
{
"plugins": { "@textlint/markdown": true },
"rules": {
"@textlint-ja/no-synonyms": true,
"prh": { "rulePaths": ["prh.yml"] }
}
}
```
4. `prh.yml` に独自ルールを定義
```yaml
version: 1
rules:
- expected: たとえば
pattern: 例えば
prh: 漢字で書かず、ひらがなで書くと読みやすくなります
```
## コードアクション（自動修正）
波線の上で `Ctrl+.` を押すと、以下の操作が選べます。
| アクション | 内容 |
|---|---|
| 修正を適用 | textlintの自動修正候補を適用 |
| 無効化:（ルール名） | その行だけ指定ルールを無効化 |
| 無効化: すべてのルール | その行以降の全ルールを無効化 |
## 無効化コメント
`.md` ファイルではHTMLコメント形式で記述します。
- `<!-- textlint-disable prh -->` で無効化
- `<!-- textlint-enable prh -->` で再有効化
`.mdx` ファイル（Starlight / Astro）では、MDXの構文制約のため、`{/* */}` で囲みます。
- `{/* <!-- textlint-disable prh --> */}` で無効化
- `{/* <!-- textlint-enable prh --> */}` で再有効化
:::note
##### 📝 MDXでの注意点
Zedのコードアクションから自動挿入されるので、普段は手動で書く必要はありません。
:::
## トラブルシューティング
### MDXファイルで `{ }` がエラーになる
このPCではMermaid図の `{{ }}` がMDXパーサーにJSX式と誤認されることがあります。`{{` を `(` に置き換えてください。
### lintが重い
`textlint-lsp` は保存時と、編集を止めてから10秒後に自動実行されます。編集のたびに走ることはありません。
|
