La hsen Smira

ドキュメントは、壊れたリンクがユーザーを苛立たせたり、README が誰かを 404 ページに飛ばしたりするまで、開発者が最後に考えるものです。

Markdown ドキュメント内のリンクを CI 中に自動的に検証するシンプルな方法が欲しかったので、urldn-link-check を構築しました。

これはドキュメントをスキャンしてマージ前に問題を報告する、オープンソースの GitHub Action と CLI です。

機能
✅ 壊れたリンクの検出 (404/500)
↪️ リダイレクトチェーンの検出
🔒 安全でない HTTP リンクの検出
📏 長すぎる URL の検出
📄 Markdown と MDX ファイルのスキャン
⚡ 高速な並行スキャン
💬 GitHub PR サマリー
📊 JSON と Markdown レポート
インストール
npm install -D urldn-link-check

または

npx urldn-link-check .
GitHub Action

  • uses: urldn/link-check@v1

以上です。

すべてのプッシュまたはプルリクエストで、ドキュメントを自動的に検証できます。

なぜ構築したのか

ドキュメントをメンテナンスしている中で、壊れたリンクが誰かに報告されるまで気づかれないことが多いことに気づきました。

手動でチェックする代わりに、GitHub Actions に直接統合され、CI ワークフローに自然に組み込める軽量ツールが欲しかったのです。

オープンソース

プロジェクトは MIT ライセンスで、コントリビューションを歓迎します。

⭐ GitHub: https://github.com/urldn/link-check

📦 npm: https://www.npmjs.com/package/urldn-link-check
https://www.npmjs.com/package/urldn-link-check

これは URLDN エコシステムにおける最初の開発者ツールであり、将来的にはより多くのオープンソースプロジェクトを予定しています。

アイデアやフィードバックがあれば、ぜひお聞かせください。