mcpField
G
generating-swift-package-docs

generating-swift-package-docs

github.com/johnrogers開発233117 回インストール40 週間前に更新
リポジトリ

generating-swift-package-docs について

Swift パッケージ依存関係の API ドキュメントを必要に応じて生成するツールです。`interfazzle` で Xcode DerivedData からシンボル情報を抽出し、未知のモジュールの調査を支援します。

主な機能

  1. 01オンデマンドの API ドキュメント生成
  2. 02コンパイル済みモジュールからのシンボル抽出
  3. 03ドキュメントのキャッシュ出力

活用シーン

  1. 01未知の Swift 依存関係の調査
  2. 02パッケージ API に関する質問への回答

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/johnrogers/claude-swift-engineering --skill generating-swift-package-docs

インストール後、Claude Code で/generating-swift-package-docsを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

reference.md
scripts/
generate_docs.py
swift_packages.py

詳細

Swift Package Documentation Generator

オンデマンドで Swift パッケージの依存関係に関する API ドキュメントを生成し、Xcode の DerivedData からシンボル情報を抽出して、「このライブラリは何をするのか？」という疑問に答えます。

概要

不慣れな依存関係を調べるときは、コードから推測する代わりに、そのドキュメントを自動生成します。このツールは interfazzle を使用して、コンパイル済みモジュールからシンボル情報を抽出します。

使用方法

不慣れな Swift モジュールのインポートについて質問されたときは、次の手順を実行します。

  1. 実行します：./scripts/generate_docs.py "<module_name>" "<path_to.xcodeproj>"
  2. スクリプトが、キャッシュされたドキュメントファイルのパスを出力します
  3. ファイルを読み、関連情報を提示します

前提条件：プロジェクトが一度ビルドされていること（DerivedData が存在すること）、interfazzle CLI がインストールされていること。

エラー処理と詳細については、reference.md を参照してください。

コメント

Markdown 対応