はじめに
本記事は、プログラミング初学者が学習を進めていて疑問に思った点について調べた結果を備忘録も兼ねてまとめたものです。
そのため、記事の内容に誤りが含まれている可能性があります。ご容赦ください。
間違いを見つけた方は、お手数ですが、ご指摘いただけますと幸いです。
textlint editorを使ってブラウザで文章校正をする
textlint editorをchromeに追加する
以下からtextlint editorを「chromeに追加」します。
ワーカースクリプトをインストールする
textlint editorはchromeに追加しただけでは使用できません。
使用できるようにするためには、ワーカースクリプトをインストールします。
README.mdでは以下のワーカースクリプトが例示されています。
それぞれ、文章校正のルールが異なりますのでご確認ください。
ワーカースクリプト1：https://azu.github.io/textlintrc/
GitHub：https://github.com/azu/textlintrc
ワーカースクリプト2：https://textlint-ja.github.io/textlint-rule-preset-Japanese/
GitHub：https://github.com/textlint-ja/textlint-rule-preset-japanese
ワーカースクリプト3：https://textlint-ja.github.io/textlint-rule-preset-ja-technical-writing/
GitHub：https://github.com/textlint-ja/textlint-rule-preset-ja-technical-writing
ワーカースクリプトのURLにアクセスすると以下のような画面が表示されます。
上方の「input your text」の欄にテキストを入力すると文章校正を試すことができます。
ワーカースクリプトのインストールは以下の手順で行います。
まず、下画像赤枠の「install」をクリックします。
表示された画面で再度「install」をクリックします。
textlint editorのアイコンをクリックして以下のようにワーカースクリプトが表示されればインストール完了です。
文章校正のルールをカスタマイズする
上記の手順で既に文章校正ができる状態になっています。
しかし、textlint-rule-preset-ja-technical-writingでは、一文の字数制限のデフォルト値が100文字となっています。
これを60文字に変更します。
ルールのみを変更するのであれば上画像の「Edit」から変更できるようですが、編集が非常にしづらいです。
また、プラグインの追加もできません。
そのため、今回はテンプレートを使用して自分好みに設定したいとおもいます。
まず、以下のURLにアクセスします。
表示されたページの「Use this template」をクリックしてリポジトリを作成します。
作成が完了したら以下の画面でGitHub Pagesの設定をします。
この作業は自分で設定したものを「ワーカースクリプトをインストールする」と同じ手順でインストールするために必要です。
次に、リポジトリをクローンしてローカルで編集できるようにします。
$ git clone git@github.com:<owner name>/<your-repo-name>.git
$ cd <your-repo-name>
$ npm install
上記ができたら、必要なルールプリセット等をインストールします。
ルールプリセット等の選定は以下を参考にしてください。
今回は以下のコマンドを実行します。
$ npm install textlint-rule-preset-ja-technical-writing
コマンド実行後、textlintの設定ファイルである.textllint.jsonを編集します。
{
"filters": {
"comments": true
},
"rules": {
"preset-ja-technical-writing": {
"sentence-length": {
"max": 60
}
}
},
"plugins": {
"@textlint/text": true,
"@textlint/markdown": true
}
}
編集後、Gitにpushします。
$ git add -A
$ git commit -m "コメント"
$ git push origin main
pushするとCIが走ってデプロイされます。
GitHub Pagesの設定画面に記載せれているURLにアクセスします。
「ワーカースクリプトをインストールする」の手順でインストールすれば使用できるようになります。