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

fix: Divergence on toolType/toolName naming convention #1216

Merged
merged 2 commits into from
Apr 10, 2020

Conversation

brunoalvesdefaria
Copy link
Collaborator

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

    • Bug fix with divergent toolType/toolName being added to event data.
    • Updated documentation with toolName as being the new attribute to be used.
    • Added comments to the code with deprecation notice of toolType attribute.
  • What is the current behavior? (You can also link to an open issue here)

    • Some tools/manipulators were triggering events with toolType attribute and others with toolName attribute.
  • What is the new behavior (if this is a feature change)?

    • Until the toolType attribute is removed, all the event data are including both toolType and toolName attributes.
  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

    • No, but it introduce a deprecation notice for the usage of toolType attribute.
    • It will be a breaking change when toolType is removed for good.
  • Other information:

    • toolType naming is now going to be used to categorize types of tools (e.g. general, annotation, stack, segmentation, etc.)

@codecov
Copy link

codecov bot commented Apr 10, 2020

Codecov Report

Merging #1216 into master will decrease coverage by 0.00%.
The diff coverage is 34.48%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1216      +/-   ##
==========================================
- Coverage   18.71%   18.71%   -0.01%     
==========================================
  Files         286      286              
  Lines        8582     8583       +1     
  Branches     1459     1459              
==========================================
  Hits         1606     1606              
- Misses       5783     5784       +1     
  Partials     1193     1193              
Impacted Files Coverage Δ
...ispatchers/mouseEventHandlers/addNewMeasurement.js 6.25% <ø> (ø)
...ispatchers/touchEventHandlers/addNewMeasurement.js 4.00% <ø> (ø)
src/manipulators/moveAllHandles.js 6.89% <ø> (ø)
src/manipulators/moveHandle.js 6.17% <0.00%> (ø)
src/manipulators/moveNewHandle.js 5.55% <ø> (ø)
...rc/stateManagement/frameOfReferenceStateManager.js 10.34% <0.00%> (ø)
src/stateManagement/stackSpecificStateManager.js 7.40% <0.00%> (ø)
src/stateManagement/toolState.js 0.00% <0.00%> (ø)
src/store/setToolMode.js 21.89% <ø> (ø)
src/tools/annotation/AngleTool.js 0.00% <ø> (ø)
... and 13 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3fb6cf6...905ed17. Read the comment docs.

Copy link
Member

@dannyrb dannyrb left a comment

Choose a reason for hiding this comment

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

Assuming the demo plays nicely, it builds, and tests pass, then this should help clarify things quite a bit! I did call out when renaming that may not be correct that we should double check.

@dannyrb dannyrb merged commit cefbb34 into cornerstonejs:master Apr 10, 2020
@dannyrb
Copy link
Member

dannyrb commented Apr 10, 2020

🎉 This PR is included in version 4.15.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@mikehazell
Copy link
Contributor

This PR resolved #991

@mikehazell mikehazell mentioned this pull request Jul 15, 2020
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants