-
Notifications
You must be signed in to change notification settings - Fork 84
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
Cleanup deprecated types #332
Conversation
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!
This reminds me of a thought: shall we rename the internal model classes such as SNode
, SEdge
in order to avoid the name conflict with the protocol interfaces? This name clash is rather confusing for users (where do I need to import that from?)
Example: SNodeImpl
, SEdgeImpl
etc.
I aggree, we definitely have to find a cleaner solution than the way we handle it right now. However, I'm not sure if renaming the internal model is the way to go here. This would introduce a major API break and affects a large part of the code base. We could also go the other way round and rexport sprotty-protocol as part of sprotty with some modifications i.e. renaming the clashing interfaces from sprotty protocol. (e.g. Pros and Cons for both approaches so we probably should discuss & handle this in a follow-up. |
That's true. But I would prefer such an API break for the transition to version 1.0 over keeping a confusing naming scheme for years to come. I'm not sure re-exporting with different names is the best option – in the worst case, that would increase the confusion. |
@tortmayr |
2d80db8
to
03c1ea6
Compare
Ensure that deprecated types are isolated and don't leak into non-deprecated definitions. => Consistently use definitions from sprotty protocol in non-deprecated classes,functions or type definitions.
03c1ea6
to
a11a540
Compare
@spoenemann I have rebased the change and addressed the two open comments/issues. |
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!
Ensure that deprecated types are isolated and don't leak into non-deprecated definitions. => Consistently use definitions from sprotty protocol in non-deprecated classes,functions or type definitions.