mcpField
G
generating-swift-package-docs

generating-swift-package-docs

github.com/johnrogersDevelopment233117 installsUpdated 40w ago
Repository

About generating-swift-package-docs

A tool for generating API documentation on demand for Swift package dependencies. It helps developers inspect unfamiliar modules by extracting symbol information from Xcode DerivedData using `interfazzle`.

Key features

  1. 01On-demand API documentation
  2. 02Symbol extraction from compiled modules
  3. 03Cached documentation output

Use cases

  1. 01Exploring an unfamiliar Swift dependency
  2. 02Answering questions about a package API

Install

Copy the command and run it in a terminal.

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

After installing, type/generating-swift-package-docsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

reference.md
scripts/
generate_docs.py
swift_packages.py

Details

From the project README

Swift Package Documentation Generator

Generates API documentation for Swift package dependencies on-demand, extracting symbol information from Xcode's DerivedData to answer "what does this library do?"

Overview

When exploring unfamiliar dependencies, generate their documentation automatically instead of guessing from code. This tool uses interfazzle to extract symbol information from compiled modules.

How to Use

When asked about an unfamiliar Swift module import:

  1. Run: ./scripts/generate_docs.py "<module_name>" "<path_to.xcodeproj>"
  2. Script outputs path to cached documentation file
  3. Read the file and provide relevant information

Prerequisites: Project must be built once (DerivedData exists), interfazzle CLI installed.

See reference.md for error handling and details.

Comments

Markdown supported