textlint

textlintとは

文章作成などに使える自然言語のためのlintツールです。 textlint.github.io

環境構築

Node.jsはインストール済みの前提で進めていきます

npm install --save-dev textlint
#スペースの設定
npm install --save-dev textlint-rule-preset-ja-spacing
#細かい表記ルールの設定
npm install --save-dev textlint-rule-preset-ja-technical-writing
#表記揺れの設定
npm install --save-dev textlint-rule-proofdict

※パッケージをインストールする際にインストールオプション(--globalか--save-dev)を途中から変更するとエラーが発生するので注意してください。

textlint/failed-to-load-textlints-module.md at master · textlint/textlint · GitHub

次にVS Codeにプラグインを入れます。

f:id:omuriceman:20190505010300p:plain

vscode-textlint - Visual Studio Marketplace

VS Codeのコマンドパレットで textlint: Create '.textlintrc' File を実行します。

f:id:omuriceman:20190505010409p:plain — textlint: Create '.textlintrc' File

※ファイルを直接開いている場合.textlintrcファイルの作成に失敗しますのでご注意ください。

textlintを自分好みの設定にカスタマイズする

次は公式のGitHubの説明を元にカスタマイズしていきましょう。

技術文書向けルールプリセット

GitHub - textlint-ja/textlint-rule-preset-ja-technical-writing: 技術文書向けのtextlintルールプリセット

上記に記載のある設定を全て有効にする場合は、

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

これだけで問題ありません。

以下個別の設定です。

1文の長さは120文字以下とする

    "senten $ce-length": {
        max: 120
    },

「ですます調」、「である調」を統一します

    "no-mix-dearu-desumasu": {
        "preferInHeader": "",
        "preferInBody": "ですます",
        "preferInList": "である",
        "strict": true
    },

ら抜き言葉を使用しない

    "no-dropping-the-ra": true,

同じ助詞を連続して使用しない

    "no-doubled-joshi": {
        "min_interval": 1
    },

スペースの設定

半角文字と全角文字の間にスペースを入れる場合の設定は下記のようになります。

    "preset-ja-spacing": {
      "ja-space-between-half-and-full-width": {
        space: "always",
        exceptPunctuation: true
      }
    },

が私の場合はスペースを空けることに全くこだわりがなかったので以下のような設定にしました。

    "preset-ja-spacing": true,

表記揺れの検知設定

        "proofdict": {
          "dictURL": "https://azu.github.io/proof-dictionary/"
        }

このproofdictはGitHubのリポジトリをフォークして自分用にカスタマイズができるようです。

Usage · Proofdict

まずは試しに使ってみたいので特に変更をかけずに使ってみます。

最終的にこのような設定ファイルになりました。

{
  "filters": {},
  "rules": {
    "preset-ja-technical-writing": {
      "sentence-length": {
        max: 120
      },
      "ja-no-mixed-period": false,
      "no-exclamation-question-mark": false,
      "no-mix-dearu-desumasu": {
        "preferInHeader": "",
        "preferInBody": "ですます",
        "preferInList": "である",
        "strict": true
      },
      "no-dropping-the-ra": true,
      "no-doubled-joshi": {
        "min_interval": 1
      },
    },
    "preset-ja-spacing": true,
    "proofdict": {
      "dictURL": "https://azu.github.io/proof-dictionary/"
    }
  }
}

これでtextlintの設定は終了になります。

Proofreading API

Proofreading APIとは

リクルートが作成している機械学習を活用した文章の怪しい箇所を検知するAPIです。

a3rt.recruit-tech.co.jp

上記にAPIの使用方法とデモサイトがありますので登録してみてください。リクルートのa3rtには他にも、文章要約APIや文章分類APIなど楽しそうなAPIが多数用意されています。 textlintが作成したルールに則って構成をかけるものに対してProofreading APIはルール外のものにも適用できる可能性があるので、この2つを組み合わせることで最強の検閲機能が生まれるはずなのでは無いかと予想されるのです。