Restrict Paparazzi's public API #1264
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
saket
approved these changes
Jan 26, 2024
jrodbx
commented
Jan 26, 2024
paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/PaparazziPlugin.kt
Outdated
Show resolved
Hide resolved
@gamepro65 kindly reminds me that we have also internally implemented a workaround using |
paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/PaparazziPlugin.kt
Outdated
Show resolved
Hide resolved
jrodbx
force-pushed
the
jrod/2024-01-26/api-tightening
branch
from
5bcff1f
to
a20c95a
Compare
TWiStErRob
reviewed
Jan 27, 2024
paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/PaparazziPlugin.kt
Outdated
Show resolved
Hide resolved
paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/PaparazziPlugin.kt
Outdated
Show resolved
Hide resolved
jrodbx
force-pushed
the
jrod/2024-01-26/api-tightening
branch
2 times, most recently
from
39b7705
to
44a138a
Compare
Egorand
approved these changes
Jan 29, 2024
jrodbx
force-pushed
the
jrod/2024-01-26/api-tightening
branch
3 times, most recently
from
2dabf52
to
1bca5c9
Compare
TWiStErRob
reviewed
Jan 29, 2024
jrodbx
force-pushed
the
jrod/2024-01-26/api-tightening
branch
from
b2cb074
to
95baa53
Compare
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.
As a precursor to the SDKifying work, I've sadly realized that we haven't done a great job of restricting the API surface of the project. This PR attempts to correct that by adding the kotlin binary validation plugin + slapping internal on a lot of things.
One thing to call out is this PR will make
HtmlReportWriterandSnapshotVerifierinternal as well. I felt keepingSnapshotHandlerpublic was enough, but due to some current design shortcomings in the snapshot pipeline (to be addressed at some point!), that level of strictness might break current consumers of the project (which I'd like to avoid!) who have implemented workarounds.Therefore, I'd be open to reverting those 2 classes (and others!) for the time being, until we come up with a better solution/design. Please speak up!
cc: @TWiStErRob