VSCode上に文章校正環境をすぐ作成できるようにした話
ブログや職務経歴書など、Markdownで文章を書く際に文章を校正してくれる環境を作成しました。 校正はtextlintで行っています。 VSCode上で動かすことを前提に作っています。
やっていることはtextlintなど、様々な先人たちの知恵をDockerfileなどにまとめて、VSCodeですぐに試せるようにしました、というだけです。 しかし意外なことに、これらをまとめて1つの環境にしている方は意外といなかったので、今回公開することにしました。 もしすでにいたらすいません、その場合は二番煎じです。
できること
VSCode上で文章を書きながら、自動で校正までやってくれます。 上図では試しにデタラメな文章を書いてみましたが、接続詞の繰り返しや、ら抜き言葉をしっかりと検知できていることが分かります。
VSCodeの拡張機能として静的な解析ツールや、PDF化できるツールも入れてあります。 またgitもコンテナー内で使用できるようにしてあるので、書いたものをgit管理したい方もすぐに使えます。
手順
以下の手順は2022/10/02現在のものです。
- VSCode, Git, Docker Desktopをダウンロードしておく。
- Gitのユーザー名とEmailアドレスを設定する。これを飛ばすとコンテナー内からGithubにpushなどができないか、一手間必要になるかもしれません。参考 逆に、Gitの機能が不要な方はスキップして構いません。
- このリポジトリをforkする。
- forkしたリポジトリをcloneする。
- cloneしたフォルダをVSCodeで開く。参考
- VSCodeの拡張機能Dev Containersをインストールする。
- Ctrl (command) + Shift + P を入力、
Remote-Containers: Reopen in Containerを選択する。 - コンテナーが立ち上がったら、執筆作業を開始できます。
（おまけ）なぜVSCodeにこだわっているか
textlintとDockerを使って１つの環境を用意されている方は何名かいました。
しかし私が作成したリポジトリには、あえてVSCodeしか使えないようなファイルがあります。 これには理由があって、文章校正を「書きながら」注意するレベルで行って欲しかったからです。 例えば口語体での会話や、ネットスラングのような崩した表現をそのまま書きたい場面を想定します。 この時、CIで自動修正されるようにしてしまうと、あえて崩した書き方をしている部分も修正されてしまう恐れがあります。 例えtextlintのルールには反していても、書き手が納得していればOKという使い方もできるように、VSCodeとtextlintのextensionを採用しています。
終わりに
今回Dockerを使った環境構築に初めて自力で挑戦してみました。 奥が深い技術で、正直使いこなせていない感は否めませんが、最低限調べながら実装できるレベルにはなれたのかなと感じてます。
