vscode-textlintで読みやすい文章を書く
読みやすい文章を作成するには｢校正｣が不可欠です。｢校正｣とは文章の誤字脱字や表記揺らぎを修正する作業のことです。事実関係の誤りの修正や不快表現の修正までを含めた作業は｢校閲｣と呼びます。
マイクロソフトWordの校閲機能が最も普及していますが、Wordではなく軽量のテキストエディタを使って長文を書きたい人もいます。そのような人には｢vscode-textlint｣がおすすめです。
vscode-textlintとは
｢vscode-textlint｣は、Visual Studio Codeに校正機能を追加する拡張機能です。Visual Studio Codeはマイクロソフト社製のテキストエディタです。
Visual Studio Code、vscode-textlint、どちらも無料です。Windows版とMac版が用意されています。
vscode-textlintの主な機能
主な機能は以下の通りです。
校正ルール違反箇所の表示
文章に対して、校正ルール違反箇所を赤線で表示し、マウスカーソルを重ねると、どのようなルール違反であるかの解説がポップアップ表示されます。
指摘箇所を修正してファイルを保存すると、ふたたび校正ルール違反のチェックが行われます。
校正ルール違反箇所の自動修正
自動修正可能な校正ルール違反については、違反箇所にテキストカーソルを置いた状態でキーボードの[Alt] + [Enter] (MacOSの場合は[command] + [. ])を同時押しすると、校正ルール違反は自動的に修正されます。
vscode-textlintの必要構成
ここから非常に難解な話になります。
vscode-textlintは単体では動作しません。使うには以下の要素を以下の手順に従って揃える必要があります。
- Node.jsとnpmのインストール
- textlintのインストール
- ルールプリセットのインストール
- Visual Studio Codeのインストール
- Visual Studio Codeの日本語化
- vscode-textlintのインストール
Node.jsとは
Node.jsは、JavaScript言語で書かれたプログラムを動かすための基本プログラムです。
textlintはJavaScript言語で書かれており、textlintを動作させるには、まずNode.jsをインストールする必要があります。
npmとは
Node.jsに同梱されているパッケージ管理ツールです。
パッケージ管理ツールは、WindowsやMacOSアプリにおけるインストーラに相当します。
近代的なコンピュータプログラムは複数のソフトウエア部品を組み合わせた構造であり、そのような構造であることを強調するためにプログラムのことをパッケージと呼びます。
textlintとは
textlintは、画面UIを持たない文書校正プログラムです。通常はコマンドプロンプト(MacOSの場合はターミナル.app)を使って操作します。
Visual Studio Codeとtextlintはそれぞれ独立した別のアプリですが、vscode-textlintにより、textlintの機能をVisual Studio Codeに組み込むことができます。
ルールプリセットとは
ルールプリセットとは、textlintで用いる校正ルールのうち多用されるルールをまとめたものです。｢語尾をですますで統一する｣｢二重否定表現は使わない｣などです。
詳細にルールを設定することも可能ですが、初心者はルールプリセットを使った方が無難です。
Visual Studio Codeとは
Visual Studio Codeはマイクロソフト社製のテキストエディタです。メモ帳(notepad.exe)と異なり、さまざまな拡張機能を追加インストールすることができます。
vscode-textlintとは
先ほどvscode-textlintは｢Visual Studio Codeに校正機能を追加する拡張機能｣だと説明しましたが、正確には｢Visual Studio Codeからtextlintを操作できるようにする拡張機能｣となります。
Visual Studio Codeとtextlintはそれぞれ独立した別のアプリですが、vscode-textlintにより、textlintの機能をVisual Studio Codeに組み込むことができます。
Node.jsとnpmのインストール
Node.jsは、JavaScript言語で書かれたプログラムを動かすための基本プログラムです。以下の手順でインストールしてください。
インストール手順
- 下記URLを開く https://nodejs.org/
- OSに合わせたインストーラが自動的に一覧表示されるので、画面左の｢Recommended For Most Users｣と書かれた方のボタンをクリックする(2022年1月現在のRecommendedはバージョン16.13.2)
- 保存先を指定して[保存]ボタンをクリックする
- 保存した.msiファイル(MacOSの場合は.pkgファイル)をダブルクリックする
- インストーラ画面の指示に従いインストールする
textlintのインストール
textlintは画面UIを持たない文書校正プログラムです。textlintのインストールにはコマンドプロンプト(MacOSの場合はターミナル.app)を使用します。
下記に C:¥textlint フォルダにtextlintをインストールする場合の手順を紹介します。
インストール手順
- コマンドプロンプト(MacOSの場合はターミナル.app)を開く
- コマンドプロンプトに｢cd ｣(シー、ディー、半角スペース)と文字入力する
- デスクトップに戻り、C:¥textlint フォルダをつかみ、コマンドプロンプト画面内に(MacOSの場合はターミナル.app画面内に)ドラッグアンドドロップする
- コマンドプロンプトに戻りキーボードの[Enter]を押すと、コマンドを実行する場所が C:¥textlint フォルダに切り替わる
- コマンドプロンプトに｢npm install --save-dev textlint｣と文字入力し、キーボードの[Enter]を押す。
- デスクトップに戻り、C:¥textlint フォルダを開き、以下ファイルフォルダが作成されていることを確認する
C:¥textlint
├ フォルダ node module
├ ファイル package.json
└ ファイル package-lock.json
注意点
textlintは、基本的には、自分の存在するフォルダおよびその下位フォルダの中にあるテキストファイルしか校正できません。コンテンツごとに最適な校正ルールは異なるはずだという考えに基づいています。
PC内のすべてのテキストファイルをtextlintの校正の対象とする方法については、お手数ですが｢textlint インストール Global｣で検索してください。
ルールプリセットのインストール
ルールプリセットとは、textlintで用いる校正ルールのうち多用されるルールをまとめたものです。｢語尾をですますで統一する｣｢二重否定表現は使わない｣などです。
詳細にルールを設定することも可能ですが、初心者はルールプリセットを使った方が無難です。
ルールプリセットは目的に応じて多数用意されています。入手可能なルールおよびルールプリセットについては、下記URLを参照してください。 https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule
ここでは｢技術文書向けルールプリセット｣を C:¥textlint フォルダ(注:必ずtextlint本体と同じ場所であること)にインストールする場合の手順を紹介します。
インストール手順
- コマンドプロンプト(MacOSの場合はターミナル.app)を開く
- コマンドプロンプトに｢cd ｣(シー、ディー、半角スペース)と文字入力する
- デスクトップに戻り、C:¥textlint フォルダをつかみ、コマンドプロンプト画面内に(MacOSの場合はターミナル.app画面内に)ドラッグアンドドロップする
- コマンドプロンプトに戻りキーボードの[Enter]を押すと、コマンドを実行する場所が C:¥textlint フォルダに切り替わる
- コマンドプロンプトに｢npm install --save-dev textlint-rule-preset-ja-technical-writing｣と文字入力し、キーボードの[Enter]を押す。
- コマンドプロンプトに｢npx textlint --init｣と文字入力し、キーボードの[Enter]を押すと、不可視のファイル｢.textlintrc｣がC:¥textlint フォルダに作成される
Visual Studio Codeのインストール
Visual Studio Codeはマイクロソフト社製のテキストエディタです。以下の手順でインストールしてください。
インストール手順
- 下記URLを開く https://code.visualstudio.com/download
- 自分のPC環境に合わせたダウンロードボタンをクリックする(たとえばM1チップ搭載Macを使用しているなら[Apple Silicon]ボタンをクリックする)
- 保存先を指定して[保存]ボタンをクリックする
- 保存した.exeファイルまたは.zipファイルをダブルクリックする
- Windowsの場合はインストーラ画面の指示に従いインストールする、Macの場合は解凍されたアプリをApplicationフォルダに移動する
Visual Studio Codeの日本語化
インストール直後のVisual Studio CodeはUIがすべて英語表記UIになっています。日本語表記に変更できます。以下の手順で変更してください。
日本語化手順
- Visual Studio Codeを起動する
- メニューより[view＞Command Pallete]を選ぶ
- 検索文字列欄に｢Configure Display Language｣と入力する
- 検索結果一覧より[Configure Display Language]をクリックする
- ポップアップメニューより[Install additional langages]をクリックする
- 画面左の選択肢一覧より[Japanese Language Pack for Visual Studio Code]をクリックする
- [Install]ボタンをクリックする
- 画面右下の[Restart Now]ボタンをクリックして再起動する
- 再起動後のUIが日本語になったことを確認する
vscode-textlintのインストール
Visual Studio Codeは、メモ帳(notepad.exe)と異なり、さまざまな拡張機能を追加インストールすることができます。以下の手順でvscode-textlintを追加インストールしてください。
インストール手順
- Visual Studio Codeを起動する
- 左端ツールバーより[拡張機能]アイコンをクリックする
- 検索入力欄に｢vscode-textlint｣と入力する
- 検索結果一覧より[vscode-textlint]アイコンをクリックする
- [インストール]ボタンをクリックする
- 画面右下の[再起動]ボタンをクリックして再起動する
vscode-textlintによる校正
vscode-textlintで校正作業を行うには、ファイルを開くより先にフォルダを開く必要があります。注意してください。
手順
- Visual Studio Codeを起動する
- メニューより[ファイル＞フォルダーを開く]を選ぶ
- ダイアログでtextlintのインストールされているフォルダを指定し、開く
- 画面左のフォルダ内ファイル一覧より、校正したいテキストファイルを選ぶ
校正ルールのカスタマイズ
先ほど紹介した技術文書向けルールプリセットの校正ルールが厳しすぎると感じる場合、校正ルールをカスタマイズできます。
しかしながら、校正ルールをカスタマイズするには、不可視ファイル.textlintrcを手作業で書き換えるという非常に難解な作業が必要です。
カスタマイズ方法については下記URLを参照してください。 https://github.com/textlint-ja/textlint-rule-preset-ja-technical-writing
無料アプリでも十分な校正支援を得られます。校正作業を忘れることなく読みやすい文章を作成してください。
以上