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

move package library.plantuml -> library.plantuml.rules #959

Merged
merged 4 commits into from Sep 25, 2022

Conversation

codecholeric
Copy link
Collaborator

... to free up the namespace for further possible enhancements around PlantUML. Our upcoming 1.0.0 release is the perfect point in time to do this breaking change. This will allow us to also add some infrastructure to create diagrams in the future within the library.plantuml package and make it clear that all existing code has the context of creating rules from PlantUML.

Signed-off-by: Peter Gafert peter.gafert@tngtech.com

While trivial we should still test this function to avoid regression.

Signed-off-by: Peter Gafert <peter.gafert@tngtech.com>
Copy link
Member

@hankem hankem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for explicitly declaring @PublicAPI at the class level! 💙

This was a hacky shortcut, but we should in general never mock value objects (but use factories instead), since it destroys invariants and makes the code hard to maintain (as this case shows, because I stumbled over it when I wanted to make `JavaClass` `final` and this test broke as a result).

Signed-off-by: Peter Gafert <peter.gafert@tngtech.com>
So far we only marked members that were accessible as `@PublicAPI`, which made classes `@PublicAPI` implicitly. Some classes are also marked as `@PublicAPI` at the class level. We should make this consistent and easy to understand for users, so we mark every class toplevel as `@PublicAPI` that is part of the public API.

Signed-off-by: Peter Gafert <peter.gafert@tngtech.com>
... to free up the namespace for further possible enhancements around PlantUML. Our upcoming `1.0.0` release is the perfect point in time to do this breaking change. This will allow us to also add some infrastructure to create diagrams in the future within the `library.plantuml` package and make it clear that all existing code has the context of creating rules from PlantUML.

Signed-off-by: Peter Gafert <peter.gafert@tngtech.com>
@codecholeric codecholeric merged commit 5df1ce7 into main Sep 25, 2022
@codecholeric codecholeric deleted the relocate-PlantUML-rules branch September 25, 2022 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants