Skip to content
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

Multiple Sourcekitten Sourcefiles Undocumented Count #1317

Closed
mh-dmclean opened this issue Aug 31, 2022 · 2 comments
Closed

Multiple Sourcekitten Sourcefiles Undocumented Count #1317

mh-dmclean opened this issue Aug 31, 2022 · 2 comments
Labels

Comments

@mh-dmclean
Copy link

Hello, we recently upgraded our toolchain to Xcode 13.3 and as such have run into the breaking change with Swift 5.6 regarding undocumented changes and not using --module. As mentioned in #1306 , using Sourcekitten json works with --module. However this doesn't (logically) work when using multiple Sourcekitten files from multiple modules as advised in issues such as #1194 and #564 . Is there a new way to achieve this workflow now with Swift 5.6?

Example:

jazzy --module AppLock --sourcekitten-sourcefile AppLock.json,Badging.json
98% documentation coverage with 4 undocumented symbols
included 257 internal, public, or open symbols
skipped 83 private or fileprivate symbols (use `--min-acl` to specify a different minimum ACL)
building site
building search index
jam out ♪♫ to your fresh new docs in `docs`
jazzy --module Badging --sourcekitten-sourcefile AppLock.json,Badging.json
99% documentation coverage with 2 undocumented symbols
included 255 internal, public, or open symbols
skipped 83 private or fileprivate symbols (use `--min-acl` to specify a different minimum ACL)
building site
building search index
jam out ♪♫ to your fresh new docs in `docs`
@johnfairh
Copy link
Collaborator

I think the best you can do is edit the sourcekitten json files to undo the Swift 5.6 change:

sourcekitten doc --spm --module-name AppLock | grep -v '"key.modulename" : "AppLock"' > AppLock.json
sourcekitten doc --spm --module-name Badging | grep -v '"key.modulename" : "Badging"' > Badging.json

(I think I got the quoting right, seems to work for me, hope intention is clear enough)

...this lets jazzy work by associating all the decls with the 'implicit' module -- with the 5.6 change it gets harder to fool jazzy into thinking it's dealing with just one module.

@mh-dmclean
Copy link
Author

Just tried this and it works!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants