全力開発ブログの作り方:textlintとMarkdownlintで品質を維持する

こんにちは、全力開発部の @konoka-iori です。 今回からしばらくの間、「全力開発ブログの作り方」シリーズの記事を投稿します。 このシリーズでは、 メンバーがどのようにして全力開発ブログに記事を投稿しているか 記事を投稿するにあたって、守るべきルールやコーディング規約にはどんなものがあるのか 全力開発ブログのリポジトリの構成や運用方法はどのようなものか 全力開発ブログのカスタマイズについて など、全力開発ブログの裏側についてご紹介いたします。 今回の記事では、全力開発ブログで導入されているlintツールについてご紹介します。 以前の記事では、WordPressからHugoに移行した経緯などをご紹介しました。ぜひこちらもご覧ください。 WordPressからHugoに移行してみた - 全力開発ブログ textlint導入までの道 textlintは、主にMarkdownファイルに対してルールベースでテキストをチェックするlintツールです。 全力開発ブログでは、誤字脱字や表記揺れなどをチェックするためにtextlintを導入しています。 きっかけ 執筆環境の更新に伴い、Markdownで記事を執筆することができるようになりました。 VS Codeなど馴染みのあるエディターを使って執筆できる一方で、誤字脱字のチェックがしにくく、結果的に誤字脱字や表記揺れが増えてしまいました。 このままレビュー工程に入ると修正箇所が多くなり、レビューにかかる時間が増えて執筆者もレビュアーも負担が増えてしまいます。 そこで、執筆段階で誤字脱字や表記揺れを機械的にチェックできるtextlintを導入することにしました。 Node.jsの壁。拡張機能で代用 textlintによる自動チェックを行いたいと思いつつも、当初は執筆環境がしっかり統一されておらず、各自がリポジトリをクローンしてローカル環境で執筆していたため、Node.jsが必要なtextlintを導入することは難しいと考えました。 そこで、VS Codeの拡張機能として提供されている テキスト校正くん を使うことで、Node.jsを使わずにある程度のチェックを行うことができるようになりました。 開発元による「テキスト校正くん」の紹介記事はこちらです。 素晴らしい拡張機能をありがとうございます! 文章作成・メール作成に役立つ! VS Codeの拡張機能「テキスト校正くん」を公開 - ICS MEDIA - ICS MEDIA 文章の校正チェックを自動で行うVisual Studio Codeの拡張機能「テキスト校正くん」を弊社からリリースしました。無料で利用できます。 ...

Posted 2024-11-17 ·  konoka-iori ·  Tech