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

refactor!: rename values in ShapeBpmnMarkerKind #3147

Merged

Conversation

tbouffard
Copy link
Member

@tbouffard tbouffard commented Aug 16, 2024

The previous values related to "multi instance" included spaces which is not consistent with values in other enums.
They now follow the kebab-case convention and their values are shorter.

Refactor also the way markers are painted in BaseActivityShape: remove the use of the switch in favor of the use of a Map.
This makes the implementation consistent with EventShape.

BREAKING CHANGES: some values in ShapeBpmnMarkerKind have changed. Values are not supposed to be used directly, so this change should not have any impact. For applications using such values, use the enum directly, in particular for:

  • MULTI_INSTANCE_PARALLEL
  • MULTI_INSTANCE_SEQUENTIAL

Notes

Covers #3146

The previous values included spaces which is not consistent with values in other enums.
Use a kebab case and shorten the values.

Refactor also the way markers are painted in `BaseActivityShape`: remove the use of the switch
in favor of the use of a Map.
This makes the implementation consistent with `EventShape`.

BREAKING CHANGES: some values in `ShapeBpmnMarkerKind` have changed.
Values are not supposed to be used directly, so this change should not have any impact.
For applications using such values, replace the value by the of the enum, in particular for:
  - MULTI_INSTANCE_PARALLEL
  - MULTI_INSTANCE_SEQUENTIAL
@tbouffard tbouffard added the refactoring Code refactoring label Aug 16, 2024
Copy link

github-actions bot commented Aug 16, 2024

🎊 PR Preview 8ad7a72 has been successfully built and deployed to https://process-analytics-bpmn-visualization-js-doc_preview-pr-3147.surge.sh

🕐 Build time: 0.01s

🤖 By surge-preview

Copy link

github-actions bot commented Aug 16, 2024

🎊 PR Preview 8ad7a72 has been successfully built and deployed to https://process-analytics-bpmn-visualization-js-demo_preview-pr-3147.surge.sh

🕐 Build time: 0.011s

🤖 By surge-preview

@tbouffard tbouffard changed the title refactor!: rename values of multi instance in ShapeBpmnMarkerKind refactor!: rename values in ShapeBpmnMarkerKind Aug 16, 2024
Copy link

@tbouffard tbouffard marked this pull request as ready for review August 21, 2024 12:26
@tbouffard tbouffard requested a review from csouchet August 21, 2024 12:26
@tbouffard tbouffard merged commit e3f48eb into master Aug 21, 2024
23 checks passed
@tbouffard tbouffard deleted the refactor/rename_values_ShapeBpmnMarkerKind_multi-instance branch August 21, 2024 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Code refactoring
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants