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

Rename internal model classes with 'Impl' suffix #355

Merged
merged 1 commit into from
May 17, 2023

Conversation

spoenemann
Copy link
Contributor

This has been discussed before for quite some time, now I'd like to make a step forward in preparation of #231: The internal model classes like SModelElement, SNode etc. have the same names as the external model interfaces defined in sprotty-protocol. This is a source of confusion for users.

Historically, the external model interfaces had a Schema suffix to disambiguate, but I removed that during the move to the sprotty-protocol package. I now regard the external model as the primary interface. The internal model is used primarily at the diagram configuration with InversifyJS (configureModelElement) and as arguments to custom services such as views.

I propose to use the Impl suffix for internal model classes and deprecate the previous symbols. I would release v0.14.0 with this change (and maybe others) so users can migrate gracefully with the deprecation notices. Then I'd remove all deprecated code when we shift to v1.0.0.

Copy link
Contributor

@dhuebner dhuebner left a comment

Choose a reason for hiding this comment

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

I think the Impl suffix fits well and makes things clear.

Review all the rename, copyright and quotation mark changes is not really necessary I suppose.

Copy link
Contributor

@tortmayr tortmayr left a comment

Choose a reason for hiding this comment

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

LGTM! 👍🏼

@spoenemann spoenemann added this to the v0.14.0 milestone May 17, 2023
@spoenemann spoenemann merged commit ac93ad6 into master May 17, 2023
@spoenemann spoenemann deleted the internal-model-rename branch May 17, 2023 06:34
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 this pull request may close these issues.

3 participants