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

Update dependency vuex to v4 #691

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

Update dependency vuex to v4 #691

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 22, 2022

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
vuex 3.6.2 -> 4.1.0 age adoption passing confidence

Release Notes

vuejs/vuex (vuex)

v4.1.0

Compare Source

Vue Core Version Requirement Change

This release contains an important fix (#​1883) that relies on the effectScope API from Vue core, which is only available in Vue 3.2+.

Bug Fixes

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)

v4.0.2

Compare Source

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)

v4.0.1

Compare Source

Features
  • dx: add devtools integration (#​1949)

v4.0.0

Compare Source

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 Next.

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 '@&#8203;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

Configuration

📅 Schedule: Branch creation - "after 3pm and before 7pm" in timezone Asia/Tokyo, Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the renovate create PR by Renovate label Nov 22, 2022
@renovate
Copy link
Contributor Author

renovate bot commented Nov 22, 2022

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: package-lock.json
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR! 
npm ERR! While resolving: syakusyaku@undefined
npm ERR! Found: vue@2.7.16
npm ERR! node_modules/vue
npm ERR!   vue@"2.7.16" from the root project
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peer vue@"^3.2.0" from vuex@4.1.0
npm ERR! node_modules/vuex
npm ERR!   vuex@"4.1.0" from the root project
npm ERR! 
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR! 
npm ERR! See /tmp/renovate/cache/others/npm/eresolve-report.txt for a full report.

npm ERR! A complete log of this run can be found in:
npm ERR!     /tmp/renovate/cache/others/npm/_logs/2024-05-07T11_28_20_052Z-debug-0.log

@renovate renovate bot force-pushed the renovate/vuex-4.x branch 4 times, most recently from f36f8b0 to 8fffe55 Compare November 29, 2022 08:19
@renovate renovate bot force-pushed the renovate/vuex-4.x branch 5 times, most recently from 1a9aea8 to 98af137 Compare December 6, 2022 11:20
@renovate renovate bot force-pushed the renovate/vuex-4.x branch 4 times, most recently from 490b300 to e528b23 Compare December 14, 2022 09:24
@renovate renovate bot force-pushed the renovate/vuex-4.x branch 6 times, most recently from b038c58 to afd402f Compare December 21, 2022 10:10
@renovate renovate bot force-pushed the renovate/vuex-4.x branch 4 times, most recently from 2df2dd9 to ba4d2a2 Compare January 5, 2023 12:04
@renovate renovate bot force-pushed the renovate/vuex-4.x branch 4 times, most recently from b3a4786 to 2acb58b Compare January 11, 2023 09:13
@renovate renovate bot force-pushed the renovate/vuex-4.x branch 2 times, most recently from 4ae6142 to 06564a3 Compare September 26, 2024 10:05
@renovate renovate bot force-pushed the renovate/vuex-4.x branch 2 times, most recently from de3e04e to bb8757f Compare October 3, 2024 09:22
@renovate renovate bot force-pushed the renovate/vuex-4.x branch 6 times, most recently from 543466a to 7d15915 Compare October 17, 2024 15:49
@renovate renovate bot force-pushed the renovate/vuex-4.x branch 9 times, most recently from 9dcb836 to f0d093a Compare October 24, 2024 11:32
@renovate renovate bot force-pushed the renovate/vuex-4.x branch 8 times, most recently from 6c0019f to 3e0052f Compare November 1, 2024 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
renovate create PR by Renovate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants