Zenn
📝

textlintを使ってみる

2023/12/27に公開
Node.js
textlint
文章校正
tech

概要

textlintとは、テキストファイルを特定のルールにしたがってチェックする文章校正ツールである。

本記事は公式に従って導入→利用してみたときのメモ。

以下は事前にインストールされていることを前提とする。

  • npm（パッケージ管理ツール）
  • Node.js 16+

導入

  1. textlintをインストール
    作業したいフォルダにcdコマンド等で移動し、以下のコマンドでローカルインストールする
    （-gオプションでグローバルインストールでもいいが、公式ではローカルインストールを推奨している模様）
$ npm install textlint --save-dev
  1. 文章校正のためのルールをインストール
    textlintは特定のルールに従って文章校正するツールである。この"特定のルール"のインストールを行う。
    独自で作成してもいいが、今回はtextlintの日本語ルールを作成するコミュニティにあるtextlint-rule-preset-ja-technical-writingという技術文書向けルールを利用する。
npm install --save-dev textlint textlint-rule-preset-ja-technical-writing
  1. ルールを適用する
    先ほどインストールしたルールを適用する。以下のコマンドで.textlintrc.jsonというファイルが生成され、そこで適用するルールを記述する。
npx textlint --init

.textlintrc.jsonファイル内で"preset-ja-technical-writing": trueとなっていればOK

実践

インストール・ルールの設定が終わったので実際にtextlintで文章校正してみる。

試しに以下内容のtextファイルtest.txtを作成

APIの場合で認可を行いたい場合は、OAuthを理容すればいいと思います

test.txtに対してtextlint実行

npx textlint .\test.txt

出力

  1:8   error  【dict5】 "認可を行う"は冗長な表現です。"認可する"など簡潔な表現にすると文章が明瞭になります。解説: https://github.com/textlint-ja/textlint-rule-ja-no-redundant-expression#dict5  ja-technical-writing/ja-no-redundant-expression
  1:33  error  弱い表現: "思います" が使われています。                                                         ja-technical-writing/ja-no-weak-phrase
  1:36  error  文末が"。"で終わっていません。                                                                  ja-technical-writing/ja-no-mixed-period

✖ 3 problems (3 errors, 0 warnings)

「場合」が2回使われている点や、「理容」という漢字のミスを指摘してくれるのかなと思い実施してみましたが、そこまでは実施してくれないみたい・・・
日本語ルールを作成するコミュニティを参考に複数ルール追加したりしていい感じにならないか個人的に試行していく予定です

以上！

Discussion