feat: introduce a dedicated function to get the version #2965
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This simplifies the process of obtaining the version of `bpmn-visualization`. Previously, it was necessary to instantiate `BpmnVisualization` to obtain the version, whereas this information was available without any other prerequisites. The version can now be retrieved directly by calling the new `getVersion` function. The old `BpmnVisualization.getVersion` method has therefore been marked as deprecated, and will be removed in the future. In the API documentation, the new function and the existing `Version` type are not categorized. The `Version` type was previously categorized as "Initialization & Configuration", but in fact is not related to this topic. In addition, the TypeScript configuration dedicated to Typedoc has been updated to take into account only the `src` folder and no longer the demo folder, which is not part of the API documentation. This speeds up documentation generation.
tbouffard
added
enhancement
|
♻️ PR Preview 7677afe has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
|
♻️ PR Preview 7677afe has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
|
Kudos, SonarCloud Quality Gate passed! |
This was referenced Nov 16, 2023
Closed
csouchet
approved these changes
Nov 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This simplifies the process of obtaining the version of
bpmn-visualization.Previously, it was necessary to instantiate
BpmnVisualizationto obtain the version, whereas this information was available without any other prerequisites.The version can now be retrieved directly by calling the new
getVersionfunction. The oldBpmnVisualization.getVersionmethod has therefore been marked as deprecated, and will be removed in the future. In the API documentation, the new function and the existingVersiontype are not categorized. TheVersiontype was previously categorized as "Initialization & Configuration", but in fact is not related to this topic.In addition, the TypeScript configuration dedicated to Typedoc has been updated to take into account only the
srcfolder and no longer the demo folder, which is not part of the API documentation. This speeds up documentation generation.