Added ability to skip @Preview functions #401
Merged
Conversation
This file contains 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
vinaygaba
commented
Dec 11, 2024
| @@ -78,7 +78,7 @@ class ShowkaseProcessor @JvmOverloads constructor( | |||
| ?.toSet()?.let { set.addAll(it) } | |||
| return set | |||
| } | |||
| override fun getSupportedOptions() = mutableSetOf("skipPrivatePreviews", "multiPreviewType") | |||
| override fun getSupportedOptions() = mutableSetOf("skipPrivatePreviews", "skipFunctionsWithPreviewAnnotation", "multiPreviewType") | |||
There was a problem hiding this comment.
Open to having a name other than skipFunctionsWithPreviewAnnotation 🫤 Couldn't think of anything better and not a huge fan of what I ended up using
elihart
approved these changes
Dec 12, 2024
| override fun getSupportedOptions() = mutableSetOf("skipPrivatePreviews", "multiPreviewType") | ||
| override fun getSupportedOptions() = mutableSetOf( | ||
| "skipPrivatePreviews", | ||
| "skipFunctionsWithPreviewAnnotation", |
There was a problem hiding this comment.
might consider a more explicit name, as this won't skip all functions with preview annotations (ie, it keeps the ones with showkase annotation)
Suggested change
| "skipFunctionsWithPreviewAnnotation", | |
| "skipPreviewFunctionsWithoutShowkaseAnnotation", |
or
Suggested change
| "skipFunctionsWithPreviewAnnotation", | |
| "requireShowkaseAnnotation", |
There was a problem hiding this comment.
this makes sense, thanks for the tip!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds the ability to skip
@Previewcomposable from being picked up by Showkase. I had previously added the ability to skip an individual composable using theskipproperty that's added to theShowkaseComposableannotation.However, this config option allows one to skip all
@Previewannotation with a single line. While Showkase picking up functions annotated with@Previewis an important feature that makes the library more useful, there might be cases where you might want to enforce usage of theShowkaseComposableannotation instead as that's a more explicit way to integrate with Showkase. In order to use this feature, you can use the following snippet in your gradle file.If you use KSP:
ksp { arg("requireShowkaseComposableAnnotation", "true") }If you use KAPT:
kapt { arguments { arg("requireShowkaseComposableAnnotation", "true") } }This PR also contains upgrades to Detekt + Gradle and the fixes that detekt required as a result. Would've been ideal to split this in separate PR's but since I didn't anticipate needing these many changes and I was further along, I decided to just continue adding it to this PR.
@elihart @allenchen1154