textlint で Front Matter の内容をチェックするルールをつくった
- 投稿した日
- 更新した日
- 書いたひと
- ひらたけ
textlint で Front Matter の内容をチェックするルールをつくりパッケージを公開 しました🎉
パッケージの公開自体は 2 ヶ月ほど前からしていたのですが、考えていた機能を実装するための時間がなかなか取れなかったなどの理由でひっそりと公開されているような状態でした。
ルールを追加すると、Front Matter（Markdown 形式でブログ記事などを書くときに上に付けるやつ）の内容をチェックすることができます。 特定の項目がちゃんと指定されているか （title は必須、とか）や、 項目が指定の形式になっているか （アルファベットだけ、数字だけ、とか）を textlint 実行時に検証するように設定が可能です。
ルールは以下でインストールできます。
# npm
$ npm install -D @hiratake/textlint-rule-front-matter
# yarn
$ yarn add -D @hiratake/textlint-rule-front-matter
# pnpm
$ pnpm add -D @hiratake/textlint-rule-front-matter
以前 textlint のルールをつくったときと同様に、今回も create-textlint-rule というルールをつくる環境を簡単に用意できるパッケージを使用させていただいたのですが、テストの実行などの用意もされていて非常に便利でした。
不具合などありましたら、ご連絡いただけますと助かります。