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

[Snyk] Upgrade chartjs-plugin-annotation from 2.2.1 to 3.1.0 #24

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nerdy-tech-com-gitub
Copy link
Owner

@nerdy-tech-com-gitub nerdy-tech-com-gitub commented Dec 8, 2024

snyk-top-banner

Snyk has created this PR to upgrade chartjs-plugin-annotation from 2.2.1 to 3.1.0.

ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.


⚠️ Warning: This PR contains major version upgrade(s), and may be a breaking change.

  • The recommended version is 3 versions ahead of your current version.

  • The recommended version was released on 2 months ago.

Release notes
Package name: chartjs-plugin-annotation
  • 3.1.0 - 2024-10-16

    Essential Links

    Enhancements

    • #825 Enable centered label drawing for doughnut controllers
    • #939 Change borderCapStyle and borderJoinStyle defaults to be compatible with SKIA canvas
    • #889 Enable drawTime option as integer to relate the annotation drawing to a specific dataset drawing
    • #892 Add getAnnotations function to plugin and remove _getState private one
    • #869 Add defined and loaded elements to annotation context
    • #902 Add hitTolerance option to all annotations

    Types

    • #942 Fix init option (initial animation) type
    • #894 Remove default type from module augmentation of PluginOptionsByType

    Documentation

    • #891 Add annotations option to the plugin configuration documentation
    • #916 Replace chart.min.js by chart.umd.js

    Development

    • #951 Bump package to 3.1.0
    • #949 Bump socket.io from 4.6.1 to 4.8.0
    • #948 Bump rollup from 3.17.3 to 3.29.5
    • #945 Bump serve-static and express
    • #946 Bump send and express
    • #943 Bump body-parser and express
    • #944 Bump elliptic from 6.5.4 to 6.5.7
    • #932 Bump ws from 6.2.2 to 6.2.3
    • #927 Bump express from 4.18.2 to 4.19.2
    • #925 Bump follow-redirects from 1.15.4 to 1.15.6
    • #923 Bump ip from 1.1.8 to 1.1.9
    • #920 Bump follow-redirects from 1.15.2 to 1.15.4
    • #912 Bump @ babel/traverse from 7.21.2 to 7.23.2
    • #914 Bump browserify-sign from 4.2.1 to 4.2.2
    • #904 Bump word-wrap from 1.2.3 to 1.2.4
    • #893 Bump socket.io-parser from 4.2.2 to 4.2.3

    Thanks to @ JimmyGouraud, @ LeeLenaleee, @ dependabot, @ dependabot[bot], @ fteamkr, @ mlohbihler and @ stockiNail

  • 3.0.1 - 2023-05-15

    Essential Links

    Bugs Fixed

    • #885 Fix documentation after setting plugin as module

    Documentation

    • #885 Fix documentation after setting plugin as module

    Development

    • #888 Bump to version 3.0.1

    Thanks to @ stockiNail

  • 3.0.0 - 2023-05-10

    Essential Links

    Breaking Changes

    • #838 Set the plugin as module
    • #863 Define default init animation logic to each annotation element

    Enhancements

    • #863 Define default init animation logic to each annotation element

    Bugs Fixed

    • #877 Fix compile errors when using multiple plugins

    Documentation

    • #882 Update migration guide for version 3

    Development

    • #883 Bump to version 3.0.0
    • #838 Set the plugin as module
    • #881 Bump engine.io from 6.4.1 to 6.4.2

    Thanks to @ SebastiaanSafeguard, @ dependabot, @ dependabot[bot], @ kurkle and @ stockiNail

  • 2.2.1 - 2023-03-15

    Essential Links

    Bugs Fixed

    • #867 Fix init option type setting it as optional

    Types

    • #867 Fix init option type setting it as optional

    Development

    • #868 Bump to version 2.2.1

    Thanks to @ stockiNail

from chartjs-plugin-annotation GitHub release notes

Important

  • Warning: This PR contains a major version upgrade, and may be a breaking change.
  • Check the changes in this PR to ensure they won't cause issues with your project.
  • This PR was automatically created by Snyk using the credentials of a real user.

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

Summary by Sourcery

Upgrade the chartjs-plugin-annotation dependency from version 2.2.1 to 3.1.0 in the package.json file, which may introduce breaking changes due to the major version update.

Snyk has created this PR to upgrade chartjs-plugin-annotation from 2.2.1 to 3.1.0.

See this package in npm:
chartjs-plugin-annotation

See this project in Snyk:
https://app.snyk.io/org/nerds-github/project/ef708957-d107-4807-bb9b-ffb67ea15337?utm_source=github&utm_medium=referral&page=upgrade-pr
Copy link

sourcery-ai bot commented Dec 8, 2024

Reviewer's Guide by Sourcery

This PR upgrades the chartjs-plugin-annotation package from version 2.2.1 to 3.1.0. This is a major version upgrade that includes breaking changes, new features, and various bug fixes. The most significant change is that the plugin is now set as a module, which affects how it needs to be imported and used.

Class diagram for chartjs-plugin-annotation upgrade

classDiagram
    class ChartJSPluginAnnotation {
        +enableCenteredLabelDrawing()
        +changeBorderCapStyle()
        +changeBorderJoinStyle()
        +enableDrawTimeOption()
        +getAnnotations()
        +addHitToleranceOption()
    }
    note for ChartJSPluginAnnotation "This class now includes new methods and options as part of the upgrade to version 3.1.0."
    class ChartJSPluginAnnotationV2 {
        -_getState()
    }
    ChartJSPluginAnnotationV2 <|-- ChartJSPluginAnnotation : Upgrade
    note for ChartJSPluginAnnotationV2 "This class represents the previous version 2.2.1 with the removed _getState method."
Loading

File-Level Changes

Change Details Files
Major version upgrade with breaking changes
  • Plugin is now set as a module, affecting import and usage patterns
  • Default init animation logic defined for each annotation element
  • Changed borderCapStyle and borderJoinStyle defaults for SKIA canvas compatibility
dashboard/package.json
New features and enhancements added
  • Added centered label drawing for doughnut controllers
  • Added drawTime option as integer for dataset drawing relation
  • Added getAnnotations function and removed private _getState
  • Added defined and loaded elements to annotation context
  • Added hitTolerance option to all annotations
dashboard/package.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We have skipped reviewing this pull request. Here's why:

  • It seems to have been created by a bot ('[Snyk]' found in title). We assume it knows what it's doing!
  • We don't review packaging changes - Let us know if you'd like us to change this.

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.

2 participants