-
Notifications
You must be signed in to change notification settings - Fork 414
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 support for an "include" option #950
Conversation
This implementation is used internally by our team. Opening this PR to facilitate discussion. |
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 the patch, looks fine to me -- just a couple of nitpicks. Could you also please update the README 'controlling what is documented' section to describe the flag and how it interacts with --exclude
?
CHANGELOG.md
Outdated
@@ -5,8 +5,11 @@ | |||
* None. | |||
|
|||
##### Enhancements | |||
|
|||
* None. | |||
-------------------------------------------------------------------------------- |
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.
Don't need this line, see style in the rest of the file. Could drop the 'to jazzy' part too, I think the context is clear.
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.
✅
lib/jazzy/sourcekitten.rb
Outdated
included_files = Config.instance.included_files | ||
json.map do |doc| | ||
key = doc.keys.first | ||
doc if included_files.detect do |foo| |
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.
Maybe a better variable name :-)
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.
Oops! 🤦♂️
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.
✅
@johnfairh I've addressed your feedback and updated the README. Let me know what you think! |
LGTM - could you squash these commits please? |
* Added support for -i or -include which has the opposite behavior of the exclude flag * Updated file filtering to account for include flag * Updated README and documentation
@johnfairh squashed 👍 |
Great - thank you. |
🎉 |
Addresses #949