Add SPM plugin for generating Markdown CLI docs#1
Merged
Conversation
Implements the swift-cli-docs-plugin: a Swift Package Manager command plugin that turns any Swift Argument Parser CLI into beautiful Markdown documentation. Architecture: - Plugin invokes a helper executable that parses --experimental-dump-help - ContextBuilder pre-computes everything (synopsis, defaults, links, escapes) into a stable RenderContext view-model - Stencil templates are logic-less: they only iterate and substitute - Three built-in themes (default, minimal, github) with user theme overrides - Multi-file and single-file layouts, configured via .swift-cli-docs.yml Includes unit tests with fixtures, an Examples/DemoCLI consumer, and CI matrix for macOS + Linux on Swift 5.9 and 6.0. https://claude.ai/code/session_01L8VEwZS2SbtRfPpGMK924y
ArgumentParserToolInfo is an internal target of swift-argument-parser, not a public product, so it can't be imported from another package. Re-declare the Codable schema (ToolInfoV0, CommandInfoV0, ArgumentInfoV0, NameInfoV0) locally so DumpHelpRunner can decode --experimental-dump-help JSON without the upstream module. https://claude.ai/code/session_01L8VEwZS2SbtRfPpGMK924y
displayName for an option includes all of its names joined by commas, so the rendered output is "- \`-v, --verbose <level>\`" — not "- \`--verbose <level>\`". Update the assertion to match. https://claude.ai/code/session_01L8VEwZS2SbtRfPpGMK924y
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implements the swift-cli-docs-plugin: a Swift Package Manager command plugin
that turns any Swift Argument Parser CLI into beautiful Markdown documentation.
Architecture:
into a stable RenderContext view-model
Includes unit tests with fixtures, an Examples/DemoCLI consumer, and CI
matrix for macOS + Linux on Swift 5.9 and 6.0.
https://claude.ai/code/session_01L8VEwZS2SbtRfPpGMK924y