-
Notifications
You must be signed in to change notification settings - Fork 192
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove dependency on argument-parser #149
Conversation
Removes swift-markdown's dependency on swift-argument-parser by refactoring the markdown-tool target into its own package. Markdown-tool is largely intended as a tool for developers working on swift-markdown so there isn't a need to vend it to clients. Removing argument-parser as a dependency allows for more clients to depend on swift-markdown since it removes any potential conflicts with different argument-parser versions.
fa7b3a0
to
20e3562
Compare
@swift-ci please test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this; this should help make it easier to use Swift-Markdown in the future.
Note to self: The invocation is now swift run --package-path Tools markdown-tool
.
Also such workaround solution may also apply to swift-docc-symbolkit's dependency on argument-parser and the circle issue between swift-docc-symbolkit and swift-docc-plugin.
|
# This is the 1st commit message: replace to String(decoding:as) from String(data:encoding) # This is the commit message #2: Add link title support for commonmark (swiftlang#140) * Add link title support for commonmark * Update cmark_node_get logic for Link and Image # This is the commit message #3: Remove dependency on argument-parser (swiftlang#149) Removes swift-markdown's dependency on swift-argument-parser by refactoring the markdown-tool target into its own package. Markdown-tool is largely intended as a tool for developers working on swift-markdown so there isn't a need to vend it to clients. Removing argument-parser as a dependency allows for more clients to depend on swift-markdown since it removes any potential conflicts with different argument-parser versions.
Removes swift-markdown's dependency on swift-argument-parser by refactoring the markdown-tool target into its own package. Markdown-tool is largely intended as a tool for developers working on swift-markdown so there isn't a need to vend it to clients. Removing argument-parser as a dependency allows for more clients to depend on swift-markdown since it removes any potential conflicts with different argument-parser versions.
This PR contains the following updates: | Package | Update | Change | |---|---|---| | [apple/swift-markdown](https://redirect.github.com/apple/swift-markdown) | minor | `0.4.0` -> `0.5.0` | --- ### Release Notes <details> <summary>apple/swift-markdown (apple/swift-markdown)</summary> ### [`v0.5.0`](https://redirect.github.com/swiftlang/swift-markdown/releases/tag/0.5.0): Swift-Markdown 0.5.0 [Compare Source](https://redirect.github.com/apple/swift-markdown/compare/0.4.0...0.5.0) This release is based on the code that shipped into Swift 6.0. #### What's Changed - Add link title support for commonmark by [@​Kyle-Ye](https://redirect.github.com/Kyle-Ye) in [https://github.com/swiftlang/swift-markdown/pull/140](https://redirect.github.com/swiftlang/swift-markdown/pull/140) - Remove dependency on argument-parser by [@​ethan-kusters](https://redirect.github.com/ethan-kusters) in [https://github.com/swiftlang/swift-markdown/pull/149](https://redirect.github.com/swiftlang/swift-markdown/pull/149) - Fix utf8 decode by [@​zunda-pixel](https://redirect.github.com/zunda-pixel) in [https://github.com/swiftlang/swift-markdown/pull/145](https://redirect.github.com/swiftlang/swift-markdown/pull/145) - Fix multi line symbol link source range issue by [@​Kyle-Ye](https://redirect.github.com/Kyle-Ye) in [https://github.com/swiftlang/swift-markdown/pull/151](https://redirect.github.com/swiftlang/swift-markdown/pull/151) - Fix multiline directive without content parsing range issue by [@​Kyle-Ye](https://redirect.github.com/Kyle-Ye) in [https://github.com/swiftlang/swift-markdown/pull/154](https://redirect.github.com/swiftlang/swift-markdown/pull/154) - build: add a CMake based build by [@​compnerd](https://redirect.github.com/compnerd) in [https://github.com/swiftlang/swift-markdown/pull/141](https://redirect.github.com/swiftlang/swift-markdown/pull/141) - Add 2024 as an accepted year number by [@​Kyle-Ye](https://redirect.github.com/Kyle-Ye) in [https://github.com/swiftlang/swift-markdown/pull/160](https://redirect.github.com/swiftlang/swift-markdown/pull/160) - Fix Directive argument name and value ranges on non-first line by [@​Kyle-Ye](https://redirect.github.com/Kyle-Ye) in [https://github.com/swiftlang/swift-markdown/pull/79](https://redirect.github.com/swiftlang/swift-markdown/pull/79) - Add support for Doxygen discussion/note tags by [@​j-f1](https://redirect.github.com/j-f1) in [https://github.com/swiftlang/swift-markdown/pull/159](https://redirect.github.com/swiftlang/swift-markdown/pull/159) - Add support for formatting the new Doxygen types using MarkupFormatter by [@​j-f1](https://redirect.github.com/j-f1) in [https://github.com/swiftlang/swift-markdown/pull/163](https://redirect.github.com/swiftlang/swift-markdown/pull/163) - Support Windows ARM64 builds by [@​hjyamauchi](https://redirect.github.com/hjyamauchi) in [https://github.com/swiftlang/swift-markdown/pull/164](https://redirect.github.com/swiftlang/swift-markdown/pull/164) - build: silence warning about CMakeLists.txt from SPM by [@​compnerd](https://redirect.github.com/compnerd) in [https://github.com/swiftlang/swift-markdown/pull/167](https://redirect.github.com/swiftlang/swift-markdown/pull/167) #### New Contributors - [@​zunda-pixel](https://redirect.github.com/zunda-pixel) made their first contribution in [https://github.com/swiftlang/swift-markdown/pull/145](https://redirect.github.com/swiftlang/swift-markdown/pull/145) - [@​j-f1](https://redirect.github.com/j-f1) made their first contribution in [https://github.com/swiftlang/swift-markdown/pull/159](https://redirect.github.com/swiftlang/swift-markdown/pull/159) - [@​hjyamauchi](https://redirect.github.com/hjyamauchi) made their first contribution in [https://github.com/swiftlang/swift-markdown/pull/164](https://redirect.github.com/swiftlang/swift-markdown/pull/164) **Full Changelog**: swiftlang/swift-markdown@0.4.0...0.5.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://redirect.github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://redirect.github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC44OS4xIiwidXBkYXRlZEluVmVyIjoiMzguODkuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==--> Co-authored-by: cgrindel-self-hosted-renovate[bot] <139595543+cgrindel-self-hosted-renovate[bot]@users.noreply.github.com>
Summary
Removes swift-markdown's dependency on swift-argument-parser by refactoring the markdown-tool target into its own package.
Markdown-tool is largely intended as a tool for developers working on swift-markdown so there isn't a need to vend it to clients. Removing argument-parser as a dependency allows for more clients to depend on swift-markdown since it removes any potential conflicts with different argument-parser versions.
I'm opening this PR after being unable to build a project that depended on both a recent version of Argument-Parser and Swift-Markdown.
Testing
Confirm that markdown-tool and swift-markdown continue to build and work as expected.