tl;dr
GW期間を利用してGoogle Cloudに関連するプロダクトやAPIの表記を校正するためのtextlintルールをOSSで作成、公開しました！
Google Cloudに関する記事を書くときに、是非使ってみてください！
利用方法は一般的なtextlintルールと同じなので割愛します。
textlintを使えばコマンドラインやVSCode拡張機能でルールのチェックができます。
このようにスペースを入れるところやキャピタリゼーションが異なるとエラーにしてくれます。
スペルミスなどのtypoは検出できませんが、他のスペルチェックのルールと組み合わせることである程度実現できると思います。
作り方解説
ソースコードはOSSとして公開していますが、せっかくなのでどのように作っているか解説します。
プロダクト情報の取得
まず、このルールを作る前にどのようにマスタとなるGoogle Cloudのプロダクト名一覧を取得しようか考えました。
手動で全てリストアップするのは避けたいですし、サービス名は追加、更新、削除されるので自動化を行いたいです。
AWSだとこういったズバリなAPIが用意されているみたいですが、探した限り見つからなかったので以下3点を情報リソースとしました。
これらを統合し1つのJSONファイルとして返却できるAPIをまずは作成しました。それがこちらです。
リソースから必要な情報を収集し統合する処理をGitHub Actionsで行い、GitHub PagesでなんちゃってAPIとして公開しています。
こちらもソースを公開しているのでご興味あれば。
textlintルールの作成
textlintルールを作って公開するのは初めての経験だったのですが、こちらの記事を参考にし作ることができました！
ルールの元となるファイルは前述のAPIをGitHub Actionsから呼び出すことで生成できるようにしました。
ルールを適用する部分はGeminiと相談しながら作りました。
AWSやAzureのルールは既に有志で作られていますがGoogle Cloudは調べた限りなさそうでした。
パートナーとしてプロダクト名を間違えるような失礼のないように、弊社CTO(@kaz_goto）からのリクエストで作成しました😤
よければスターやコントリビュートいただけると励みになります。
Discussion