textlint で日本語の文章を校正する方法

はじめに

バージョン情報

• textlint：2.1.1
• node
  • npm を使用する場合:15.11.0
  • yarn を使用する場合:12.20.2

textlint を使用する基本的な流れ

1. textlint を作業ディレクトリ内にインストール
2. 校正ルールの関連パッケージをインストール
3. 校正ルールの編集
4. 自動修正
5. 表記揺れのルール追加

1. textlint を作業ディレクトリ内にインストール

# npm の場合
npm init -y

# yarn の場合
yarn init -y

# npm の場合
npm install -D textlint

# yarn の場合
yarn add -D textlint

私のPCが壊れているわけが ない

# npm の場合
npx textlint index.md

# yarn の場合
yarn textlint index.md

# 実行結果
== No rules found, textlint hasn’t done anything ==

Possible reasons:
* Your textlint config file has no rules.
* You have no config file and you aren’t passing rules via command line.
* Your textlint config has a syntax error.

=> How to set up rules?
https://github.com/textlint/textlint/blob/master/docs/configuring.md

2. 校正ルールの関連パッケージをインストール

# npm の場合
npm install -D \
    textlint-rule-preset-ja-spacing \
    textlint-rule-preset-ja-technical-writing \

# yarn の場合
yarn add -D \
    textlint-rule-preset-ja-spacing \
    textlint-rule-preset-ja-technical-writing \

パッケージ	内容	ルール一覧
textlint-rule-preset-ja-spacing	スペース関連のルール	textlint-rule-preset-ja-spacing：ルール集
textlint-rule-preset-ja-technical-writing	技術文書向けのルール	技術文書向けの textlint ルール集

./node_modules/.bin/textlint --init

# npx コマンド
npx textlint --init

// .textlintrc
{
  "filters": {},
  "rules": {
    "preset-ja-spacing": true,
    "preset-ja-technical-writing": true
  }
}

# npm の場合
npx textlint index.md

# yarn の場合
yarn textlint index.md

1:14  ✓ error  原則として、全角文字どうしの間にスペースを入れません。  ja-spacing/ja-no-space-between-full-width
1:16  error    文末が"。"で終わっていません。                          ja-technical-writing/ja-no-mixed-period

3. 校正ルールの編集

// .textlintrc
{
  "filters": {},
  "rules": {
    // コメントアウト
    // "preset-ja-spacing": true,
    // 追記
    "preset-ja-spacing": {
      "ja-space-between-half-and-full-width": {
        "space": "always"
      }
    },
    "preset-ja-technical-writing": true
  }
}

1:2   ✓ error  原則として、全角文字と半角文字の間にスペースを入れます。  ja-spacing/ja-space-between-half-and-full-width
1:4   ✓ error  原則として、全角文字と半角文字の間にスペースを入れます。  ja-spacing/ja-space-between-half-and-full-width
1:14  ✓ error  原則として、全角文字どうしの間にスペースを入れません。    ja-spacing/ja-no-space-between-full-width
1:16  error    文末が"。"で終わっていません。

4. 自動修正

# npm の場合
npx textlint --fix index.md

# yarn の場合
yarn textlint --fix index.md

# 実行結果
  1:14  ✔   原則として、全角文字どうしの間にスペースを入れません。    ja-spacing/ja-no-space-between-full-width
  1:2   ✔   原則として、全角文字と半角文字の間にスペースを入れます。  ja-spacing/ja-space-between-half-and-full-width
  1:4   ✔   原則として、全角文字と半角文字の間にスペースを入れます。  ja-spacing/ja-space-between-half-and-full-width

✔ Fixed 3 problems
✖ Remaining 1 problem

私の PC が壊れているわけがない

私の PC が壊れているわけがない。

5. 表記揺れのルール追加

# npm の場合
npm install -D @proofdict/textlint-rule-proofdict

# yarn の場合
yarn add -D @proofdict/textlint-rule-proofdict

// .textlintrc
{
  "filters": {},
  "rules": {
    "preset-ja-spacing": {
      "ja-space-between-half-and-full-width": {
        "space": "always"
      }
    },
    "preset-ja-technical-writing": true,
    // 追記
    "@proofdict/proofdict": {
      "dictURL": "https://azu.github.io/proof-dictionary/"
    }
  }
}

javascript

# npm の場合
npx textlint --fix index.md

# yarn の場合
yarn textlint --fix index.md

  1:1  ✓ error  javascript => JavaScript
JavaScript is not Java Script
See https://azu.github.io/proof-dictionary/#01BQ92YYBHB83ZNFWK5WBA58B7  @proofdict/proofdict

✖ 1 problem (1 error, 0 warnings)
✓ 1 fixable problem.

最後に

---

参考文献

• Getting Started with textlint · textlint
• @proofdict/textlint-rule-proofdict