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

Use explicit API mode #535

Closed
nbransby opened this issue Jun 16, 2024 · 3 comments · Fixed by #550
Closed

Use explicit API mode #535

nbransby opened this issue Jun 16, 2024 · 3 comments · Fixed by #550

Comments

@nbransby
Copy link
Member

With explicit API mode, you must:

Add visibility modifiers to your declarations to make them public, instead of relying on the default public visibility. This ensures that you've considered what you're exposing as part of the public API.

Define the types for all your public functions and properties to prevent unintended changes to your API from inferred types.

https://kotlinlang.org/docs/whatsnew14.html#explicit-api-mode-for-library-authors

@nbransby
Copy link
Member Author

@Daeda88 this would help with ensuring we don't unintentionally expose internal APIs as we still need to fix this (waiting for you response there btw)

@Daeda88
Copy link
Contributor

Daeda88 commented Jun 16, 2024

Great. I have a branch forked from my k2 brach that adds the binary compatibility validation. On holiday this week but I can add this to it when back. Will pr that branch once k2 is merged, but since I also added ktlint it's rather big so keeping it separate for readability

@nbransby
Copy link
Member Author

nbransby commented Jun 25, 2024

That would be great! I would like to finish this PR and other breaking changes such as removing the exposed internal functions and roll it all into a single major version release, 2.0.0 (which also syncs nicely with upgrading to Kotlin 2.0)

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 a pull request may close this issue.

2 participants