generating-swift-package-docs
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:
- Run:
./scripts/generate_docs.py "<module_name>" "<path_to.xcodeproj>" - Script outputs path to cached documentation file
- 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.
More from johnrogers/claude-swift-engineering
swift-style
Swift code style conventions for clean, readable code. Use when writing Swift code to ensure consistent formatting, naming, organization, and idiomatic patterns.
1.4Kios-hig
Use when designing iOS interfaces, implementing accessibility (VoiceOver, Dynamic Type), handling dark mode, ensuring adequate touch targets, providing animation/haptic feedback, or requesting user permissions. Apple Human Interface Guidelines for iOS compliance.
200swiftui-patterns
>-
176ios-26-platform
Use when implementing iOS 26 features (Liquid Glass, new SwiftUI APIs, WebView, Chart3D), deploying iOS 26+ apps, or supporting backward compatibility with iOS 17/18.
165swift-testing
Use when writing tests with Swift Testing (@Test, #expect, #require), migrating from XCTest, implementing async tests, or parameterizing tests.
136composable-architecture
Use when building features with TCA (The Composable Architecture), structuring reducers, managing state, handling effects, navigation, or testing TCA features. Covers @Reducer, Store, Effect, TestStore, reducer composition, and TCA patterns.
130