textlintの使い方

textlintのインストール#

textlintは文書の文法チェックソフト。javascript製でありnode.js、npmが必須。まずはこの二つがインストールされていることを確認する。

textlintはグローバルにもローカルにもインストール可能であるが公式ではローカルインストールが推奨しているので、対象のプロジェクトにインストールする。

まずはプロジェクトのディレクトリに移動し、

npm init --yes

textlintをプロジェクトにインストールする。

npm install --save-dev textlint

textlintで使用するルールをインストールする。

npm install --save-dev textlint-rule-preset-ja-technical-writing
npm install --save-dev textlint-rule-preset-jtf-style
npm install --save-dev textlint-rule-preset-ja-spacing

.textlintrcファイルを生成する。

./node_modules/.bin/textlint --init

VS Codeへの機能拡張のインストール#

vscode-textlintをインストールする。