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

Add ability to specify which files should be included and excluded when documenting a module. #699

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mrabiciu
Copy link

@mrabiciu mrabiciu commented Jun 2, 2021

This change allows us to pass in a list of files to explicitly include and explicitly exclude from the doc command. This can dramatically improve parsing performance for large projects where we only need to document a subset of the files.

This change is specifically targeted at jazzy's use case and is meant to mirror the behavior of the include and exclude flags from that package. Currently the entire module is parsed even if jazzy is given include and exclude flags. With this change jazzy should be able to forward these flags to sourcekitten

In our case this change was able to reduce the parsing time by 80% when generating docs, going from 15 minutes to 3 minutes.

@johnfairh
Copy link
Collaborator

This looks like a good idea, have had a few jazzy users wanting this kind of thing.

Could do with some unit tests for those extensions. NSPredicate is incomplete on non-Darwin so I think that part needs a different approach.

What should we do about objc mode?

See CONTRIBUTING.md for changelog advice.

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

Successfully merging this pull request may close these issues.

2 participants