README のバッジが壊れていること、意外と多くないですか？
GitHub を見ていると、README にバッジを付けているプロジェクトはとても多いです。
例えば：
- CI status
- coverage
- npm version
- PyPI version
- license
- GitHub stars
README の最初に並んでいるあのバッジです。
ただ、いろいろなリポジトリを見ていると、こんなケースがよくあります。
- Travis CI のバッジが残っている（実際は GitHub Actions）
- coverage バッジが壊れている
- shields.io の URL が古い
- 同じバッジが重複している
つまり README のバッジは意外と壊れやすいです。
README のバッジ管理、地味に面倒
バッジを追加するのは簡単ですが、
長く運用しているといろいろな問題が出てきます。
例えば：
- CI を変更した
- パッケージマネージャが変わった
- coverage サービスが変わった
- shields.io の URL が変わった
そのたびに README を手動で修正するのは少し面倒です。
README バッジをチェックする CLI を作りました
そこで README のバッジをチェック・修正する CLI を作りました。
badge-sync
https://github.com/yeongseon/badge-sync
できること：
- broken badge の検出
- 古い badge URL の正規化
- README バッジの修復
- CI でのチェック
使い方
インストール
npm install -g badge-sync
チェック
badge-sync check
修復
badge-sync repair
README バッジ状態確認
badge-sync doctor
まとめ
README のバッジは便利ですが、
長く運用していると壊れてしまうことがあります。
badge-sync を使うと
- バッジの状態チェック
- 壊れたバッジの修復
- README の整理
が簡単にできます。
README のバッジ管理に困っている方がいれば、ぜひ試してみてください。