zukucode
主にWEB関連の情報を技術メモとして発信しています。

Atomに日本語の文章をチェックするtextlintを導入する

Atomエディタでtextlintを導入する際の手順です。

nodejsは導入済みとします。

パッケージのインストール

textlintのパッケージをインストールします。

$ npm install --save-dev textlint

Atomパッケージのインストール

linter-textlintというAtomのパッケージをインストールします。

ルールのインストール

「ですます」調と「である」調の統一チェックや、冗長な表現のチェックなど、チェックする項目はたくさんあります。

独自に設定するのは大変なので基本的なルールが用意されたプリセットをインストールします。

いろいろなプリセットがありますが、今回は技術文書向けのルールを定義したtextlint-rule-preset-ja-technical-writingをインストールします。

$ npm install --save-dev textlint-rule-preset-ja-technical-writing

ルールの適用

Atomエディタで開いているプロジェクトのルートディレクトリに.textlintrcというファイルを作成します。

.textlintrcにルールを記載していきます。

以下の設定で、先ほどインストールしたtextlint-rule-preset-ja-technical-writingを有効にします。

.textlintrc
{
  "rules": {
    "preset-ja-technical-writing": true
  }
}

カスタマイズ

一部の設定を独自に変更したい場合はpreset-ja-technical-writingの内容を、trueではなく各ルールのパッケージを参考にしながら設定します。

以下の例は感嘆符!!、感嘆符??を使用しないというルールをfalseにして無効にしています。

.textlintrc
{
  "rules": {
    "preset-ja-technical-writing": true
    "preset-ja-technical-writing": {
      "no-exclamation-question-mark": false
    }
  }
}

動作確認

以上でtextlintの導入は完了です。

デフォルトでマークダウンのファイル.mdにも対応しています。

チェックがされない場合は、開いているファイルを閉じてからもう一度開き直してみてください。



関連記事