refactor!: transform StyleDefault into an object #2728

tbouffard · 2023-06-04T19:27:24Z

StyleDefault was previously an enum but there is no need to enumerate the values. In addition, the values store both number and string which is generally considered confusing and a bad practice. Switching to a regular object make things more explicit and fix several SonarCloud code smells related to the enum usage (mix value types and non literal values).

Notes

This PR applies something similar to MarkerIdentifiers and BpmnStyleIdentifiers with #1617 and #2716
See also https://www.typescriptlang.org/docs/handbook/enums.html#objects-vs-enums for more reasons to use objects instead of enum.
Using enum for StyleDefault, cause issues while trying to migrate to maxGraph because of the mixed number and string: it forced us to cast some values.

AFAIK, this impacts the way the HTML API is produced.
The API still lists the entries (there is no dedicated doc for entries) but in a different way. The entries are still available in the IDE.

before	now

Fixed SonarCloud code smells

TS rule typescript:S6583 Enum members should not mix value types

TypeScript provides both numeric and string-based enums. Members of enums can be assigned strings, numbers, both, or none, which default to numbers starting from zero. Although it is possible to mix the types of enum member values, it is generally considered confusing and a bad practice.
Enum members should be consistently assigned values of the same type, that is, strings or numbers.

typescript:S6550 Explicit enum value must only be a literal value (string, number, boolean, etc).

TypeScript allows all sorts of expressions to initialize enum members. However, as enums create their own scope, using identifiers can lead to unexpected results. The recommendation is thus to use only literal values when defining enum members.

Tasks

in the examples repository, used the IIFE bundle from the npm package produced by this PR to check there is no change in the examples using StyleDefault. refactor: simplify reset of StyleDefault bpmn-visualization-examples#505
add HTML API screenshots for comparison
prepare next Release Notes breaking changes section

github-actions · 2023-06-04T19:28:45Z

♻️ PR Preview cdb1711 has been successfully destroyed since this PR has been closed.

_{🤖 By surge-preview}

github-actions · 2023-06-04T19:28:45Z

♻️ PR Preview cdb1711 has been successfully destroyed since this PR has been closed.

_{🤖 By surge-preview}

`StyleDefault` was previously an enum but there is no need to enumerate the values. In addition, the values store both number and string which is generally considered confusing and a bad practice. Switching to a regular object make things more explicit and fix 23 SonarCloud code smells.