Skip to content

VSCode で textlint を使い、Markdown 上の文章チェックを行う

VSCode へ textlint 拡張を追加インストールすることで、テキストや Markdown をエディタ上でチェック出来ます。 macOS 上に VSCode + textlint 環境を構築する手順をメモしておきます。 VSCode はインストール済みの前提とします。

検証環境

対象 バージョン
macOS Sequoia 15.4.1
VSCode 1.99.3

textlint のインストール

textlint は JavaScript で実装されている為、まずは Node.js をインストールします。

mise install node

textlint とチェック用のルールをインストールしていきます。 今回はシステム全体で利用出来るよう、グローバルにインストールしました。

npm install --global \
  textlint \
  textlint-rule-preset-ja-spacing \
  textlint-rule-preset-ja-technical-writing \
  textlint-rule-spellcheck-tech-word

textlint の設定ファイルは .textlintrc または .textlintrc.json のようです。 今回は ~/.textlintrc.json を以下の内容で新規作成しました。 以下のルールは無視し、チェック対象にならないよう設定しています。

~/.textlintrc.json
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "plugins": {},
  "filters": {},
  "rules": {
    "preset-ja-spacing": {
      "ja-space-between-half-and-full-width": false
    },
    "preset-ja-technical-writing": {
      "sentence-length": false
    },
    "spellcheck-tech-word": true
  }
}

VSCode 用 textlint プラグインのインストール

VSCode 用の textlint プラグインである textlint をインストールします。 VSCode から textlint というキーワードで検索し、表示されたプラグインをインストールします。 誤って 古いプラグイン をインストールしないように注意します。 Install をクリックします。

image

Do you trust the publisher … ? と表示されたら Trust Puglisher & Install をクリックします。

image

インストールが完了したら VSCode の設定ファイルである settings.json へ下記を追記します。

settings.json
{
  "textlint.languages": ["markdown"],
  "textlint.run": "onType"
}

これでプロジェクトから Markdown ファイルを選択すると textlint によるチェックが実行されます。 ネット上では "textlint.autoFixOnSave": true を設定し、保存時に自動的に「修正」を実施している例を見かけます。 好み次第だと思いますが、私の場合は「textlint にチェックは実施させるが、修正自体はあくまで人間が行う」方針にし、"意図せず、好みでは無いルールが適用されて修正されてしまった" という事態を避ける為、textlint.autoFixOnSave は無効にしておきます。