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 vuex from 3.6.2 to 4.1.0 #10

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

Conversation

LLotme
Copy link
Owner

@LLotme LLotme commented Jun 11, 2024

This PR was automatically created by Snyk using the credentials of a real user.


![snyk-top-banner](https://github.com/andygongea/OWASP-Benchmark/assets/818805/c518c423-16fe-447e-b67f-ad5a49b5d123)

Snyk has created this PR to upgrade vuex from 3.6.2 to 4.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 11 versions ahead of your current version.

  • The recommended version was released on 2 years ago.

Release notes
Package name: vuex
  • 4.1.0 - 2022-10-14

    release: v4.1.0

  • 4.0.2 - 2021-06-17

    Bug Fixes

    • devtools: fix no getters displayed on root module + better getters inspector (#1986) (bc20295)
    • build: cjs build failing due to __VUE_PROD_DEVTOOLS__ defined (#1991) (#1992) (7151622)
  • 4.0.1 - 2021-05-24

    Features

    • dx: add devtools integration (#1949)
  • 4.0.0 - 2021-02-02

    This is the official Vuex 4 release.

    The focus for Vuex 4 is compatibility. Vuex 4 supports Vue 3, and it provides the exact same API as Vuex 3, so users can reuse their existing Vuex code with Vue 3.

    There are a few breaking changes described in a later section, so please check them out.

    You can find basic usage with both Option and Composition API in the example directory.

    It's still released under next tag in NPM package as same as Vue 3. We're planning to remove next tag once Vue 3 is ready to remove it.

    There have been a lot of contribution to make Vuex 4 stable. Thank you all for your very much appreciated help. It wouldn't have been possible without this wonderful Vue community!

    Documentation

    To check out docs, visit next.vuex.vuejs.org.

    Breaking changes

    Installation process has changed

    To align with the new Vue 3 initialization process, the installation process of Vuex has changed.

    To create a new store instance, users are now encouraged to use the newly introduced createStore function.

    import { createStore } from 'vuex'

    export const store = createStore({
    state() {
    return {
    count: 1
    }
    }
    })

    Whilst this is not technically a breaking change, you may still use the new Store(...) syntax, we recommend this approach to align with Vue 3 and Vue Router 4.

    To install Vuex to a Vue instance, pass the store instance instead of Vuex.

    import { createApp } from 'vue'
    import { store } from './store'
    import App from './App.vue'

    const app = createApp(App)

    app.use(store)

    app.mount('#app')

    Bundles are now aligned with Vue 3

    The following bundles are generated to align with Vue 3 bundles:

    • vuex.global(.prod).js
      • For direct use with <script src="..."> in the browser. Exposes the Vuex global.
      • Global build is built as IIFE, and not UMD, and is only meant for direct use with <script src="...">.
      • Contains hard-coded prod/dev branches and the prod build is pre-minified. Use the .prod.js files for production.
    • vuex.esm-browser(.prod).js
      • For use with native ES module imports (including module supporting browsers via <script type="module">.
    • vuex.esm-bundler.js
      • For use with bundlers such as webpack, rollup and parcel.
      • Leaves prod/dev branches with process.env.NODE_ENV guards (must be replaced by bundler).
      • Does not ship minified builds (to be done together with the rest of the code after bundling).
    • vuex.cjs.js
      • For use in Node.js server-side rendering with require().

    Typings for ComponentCustomProperties

    Vuex 4 removes its global typings for this.$store within Vue Component to solve issue #994. When used with TypeScript, you must declare your own module augmentation.

    Place the following code in your project to allow this.$store to be typed correctly:

    // vuex-shim.d.ts

    import { ComponentCustomProperties } from 'vue'
    import { Store } from 'vuex'

    declare module '@ vue/runtime-core' {
    // Declare your own store states.
    interface State {
    count: number
    }

    interface ComponentCustomProperties {
    $store: Store<State>
    }
    }

    createLogger function is exported from the core module

    In Vuex 3, createLogger function was exported from vuex/dist/logger but it's now included in the core package. You should import the function directly from vuex package.

    import { createLogger } from 'vuex'

    Bug Fixes Included Since 4.0.0-rc.2

  • 4.0.0-rc.2 - 2020-11-25

    Bug Fixes

    • fix getters stop working when component is destroyed (#1884) (c3a695e)
    • stop throwing an error on hasModule when parent does not exists (#1850) (f76d72d)

    Features

    • build: enable named esm module import on node.js >= 14 (4f4a909)
  • 4.0.0-rc.1 - 2020-10-30

    Bug Fixes

    Features

    • types: adding logger type for logger plugin (#1853) (cb3198d)
  • 4.0.0-beta.4 - 2020-06-29

    Bug Fixes

    • types: add missing logger.d.ts file to the package (#1789) (a477334)
    • warn when unregistering non existing module (#1786) (7cec79d)
  • 4.0.0-beta.3 - 2020-06-29
  • 4.0.0-beta.2 - 2020-05-11
  • 4.0.0-beta.1 - 2020-04-25
  • 4.0.0-alpha.1 - 2020-03-15
  • 3.6.2 - 2021-01-26

    Bug Fixes

    • build: fix wrong path name for the export module (679313b)
from vuex 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:

Snyk has created this PR to upgrade vuex from 3.6.2 to 4.1.0.

See this package in npm:
vuex

See this project in Snyk:
https://app.snyk.io/org/llotme/project/c3b42dca-bab5-4358-bb4c-57476275984f?utm_source=github&utm_medium=referral&page=upgrade-pr
Copy link

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "feat: upgrade vuex from 3.6.2 to 4.1.0":
    • probably contains Jira ticket reference (5-4358). Please remove Jira tickets from commit messages.
    • body's lines must not be longer than 100 characters

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello LLotme, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 0a97bf2

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants