Merge branch 'main' into mjames/UW-34662

Author: urbnjamesmi1

.circleci/config.yml

@@ -0,0 +1,59 @@
+name: "\U0001F41E Bug report"
+description: Create a report to help us improve
+labels: ['bug: pending triage']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+        Please note that Vuex is now in maintenance mode and we will only prioritize critical issues.
+        Consider checking out [Pinia](https://pinia.vuejs.org/) for a more type-friendly and actively
+        maintained alternative.
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: What version of Vuex is used in your project?
+    validations:
+      required: true
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
+      placeholder: Bug description
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: Steps to reproduce the behavior.
+      placeholder: Reproduction
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+      placeholder: Expected behavior
+    validations:
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the bug report here.
+  - type: checkboxes
+    id: checkboxes
+    attributes:
+      label: Validations
+      description: Before submitting the issue, please make sure you do the following
+      options:
+        - label: Follow our [Code of Conduct](https://vuejs.org/about/coc.html)
+          required: true
+        - label: Read the [docs](https://vuex.vuejs.org/).
+          required: true
+        - label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
+          required: true

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,28 @@
+name: 'ci'
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read # to fetch code (actions/checkout)
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set node version to 16
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+
+      - name: Install deps
+        uses: bahmutov/npm-install@v1
+
+      - name: Run tests
+        run: npm test

.github/workflows/ci.yml

@@ -1,3 +1,16 @@
+# [4.1.0](https://github.com/vuejs/vuex/compare/v4.0.2...v4.1.0) (2022-10-14)
+
+### Vue Core Version Requirement Change
+
+**This release contains an important fix ([#1883](https://github.com/vuejs/vuex/pull/1883)) that relies on the `effectScope` API from Vue core, which is only available in Vue 3.2+.**
+
+### Bug Fixes
+
+* **build:** node deprecated warning in export module ([#2048](https://github.com/vuejs/vuex/issues/2048)) ([397e9fb](https://github.com/vuejs/vuex/commit/397e9fba45c8b4ec0c4a33d2578e34829bd348d7))
+* getters being destroyed on component destroy ([#1878](https://github.com/vuejs/vuex/issues/1878)) ([#1883](https://github.com/vuejs/vuex/issues/1883)) ([b2f851f](https://github.com/vuejs/vuex/commit/b2f851f427aa872d1e4f5a4774e07c4c69562789))
+
+
+
 ## [4.0.2](https://github.com/vuejs/vuex/compare/v4.0.1...v4.0.2) (2021-06-17)
 
 ### Bug Fixes

CHANGELOG.md

@@ -1,21 +1,25 @@
 # Vuex
 
-[![npm](https://img.shields.io/npm/v/vuex/next.svg)](https://npmjs.com/package/vuex)
-[![ci status](https://circleci.com/gh/vuejs/vuex/tree/dev.png?style=shield)](https://circleci.com/gh/vuejs/vuex)
+[![npm](https://img.shields.io/npm/v/vuex.svg)](https://npmjs.com/package/vuex)
+[![ci status](https://github.com/vuejs/vuex/actions/workflows/ci.yml/badge.svg)](https://github.com/vuejs/vuex/actions/workflows/ci.yml)
 
 ---
 
-:fire: **HEADS UP!** You're currently looking at Vuex 4 branch. If you're looking for Vuex 3, [please check out `dev` branch](https://github.com/vuejs/vuex).
+**Pinia is now the new default**
+
+The official state management library for Vue has changed to [Pinia](https://pinia.vuejs.org). Pinia has almost the exact same or enhanced API as Vuex 5, described in [Vuex 5 RFC](https://github.com/vuejs/rfcs/pull/271). You could simply consider Pinia as Vuex 5 with a different name. Pinia also works with Vue 2.x as well.
+
+Vuex 3 and 4 will still be maintained. However, it's unlikely to add new functionalities to it. Vuex and Pinia can be installed in the same project. If you're migrating existing Vuex app to Pinia, it might be a suitable option. However, if you're planning to start a new project, we highly recommend using Pinia instead.
 
 ---
 
 Vuex is a state management pattern + library for Vue.js applications. It serves as a centralized store for all the components in an application, with rules ensuring that the state can only be mutated in a predictable fashion. It also integrates with Vue's official [devtools extension](https://github.com/vuejs/vue-devtools) to provide advanced features such as zero-config time-travel debugging and state snapshot export / import.
 
-Learn more about Vuex at "[What is Vuex?](https://next.vuex.vuejs.org/)", or get started by looking into [full documentation](http://next.vuex.vuejs.org/).
+Learn more about Vuex at "[What is Vuex?](https://vuex.vuejs.org/)", or get started by looking into [full documentation](http://vuex.vuejs.org/).
 
 ## Documentation
 
-To check out docs, visit [vuex.vuejs.org](https://next.vuex.vuejs.org/).
+To check out docs, visit [vuex.vuejs.org](https://vuex.vuejs.org/).
 
 ## Examples
 
@@ -34,7 +38,7 @@ For questions and support please use the [Discord chat server](https://chat.vuej
 
 ## Issues
 
-Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vuex/blob/dev/.github/contributing.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
+Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vuex/blob/main/.github/contributing.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
 
 ## Changelog
 
@@ -46,7 +50,7 @@ For latest releases and announcements, follow on Twitter: [@vuejs](https://twitt
 
 ## Contribution
 
-Please make sure to read the [Contributing Guide](https://github.com/vuejs/vuex/blob/dev/.github/contributing.md) before making a pull request.
+Please make sure to read the [Contributing Guide](https://github.com/vuejs/vuex/blob/main/.github/contributing.md) before making a pull request.
 
 ## License
 

README.md

@@ -36,7 +36,7 @@ module.exports = {
   themeConfig: {
     repo: 'vuejs/vuex',
     docsDir: 'docs',
-    docsBranch: '4.0',
+    docsBranch: 'main',
 
     editLinks: true,
 
@@ -54,7 +54,7 @@ module.exports = {
           {
             text: 'v4.x',
             items: [
-              { text: 'v3.x', link: 'https://vuex.vuejs.org/' }
+              { text: 'v3.x', link: 'https://v3.vuex.vuejs.org/' }
             ]
           }
         ],
@@ -113,7 +113,7 @@ module.exports = {
           {
             text: 'v4.x',
             items: [
-              { text: 'v3.x', link: 'https://vuex.vuejs.org/zh' }
+              { text: 'v3.x', link: 'https://v3.vuex.vuejs.org/zh' }
             ]
           }
         ],
@@ -172,7 +172,7 @@ module.exports = {
           {
             text: 'v4.x',
             items: [
-              { text: 'v3.x', link: 'https://vuex.vuejs.org/ja' }
+              { text: 'v3.x', link: 'https://v3.vuex.vuejs.org/ja' }
             ]
           }
         ],
@@ -231,7 +231,7 @@ module.exports = {
           {
             text: 'v4.x',
             items: [
-              { text: 'v3.x', link: 'https://vuex.vuejs.org/ptbr/' }
+              { text: 'v3.x', link: 'https://v3.vuex.vuejs.org/ptbr/' }
             ]
           }
         ],

docs/.vitepress/config.js

@@ -37,7 +37,7 @@ export default {
 
 ## Accessing Mutations and Actions
 
-When accessing mutations and actions, you can simply provide the `commit` and `dispatch` function inside the `setup` hook.
+When accessing mutations and actions, you can simply provide the `commit` and `dispatch` method inside the `setup` hook.
 
 ```js
 import { useStore } from 'vuex'

docs/guide/composition-api.md

@@ -17,11 +17,7 @@ If more than one component needs to make use of this, we have to either duplicat
 Vuex allows us to define "getters" in the store. You can think of them as computed properties for stores.
 
 ::: warning WARNING
-As of Vue 3.0, the getter's result is **not cached** as the computed property does. This is a known issue that requires Vue 3.1 to be released. You can learn more at [PR #1878](https://github.com/vuejs/vuex/pull/1883).
-:::
-
-::: warning WARNING
-As of Vue 3.0, the getter's result is **not cached** as the computed property does. This is a known issue that requires Vue 3.2 to be released. You can learn more at [PR #1883](https://github.com/vuejs/vuex/pull/1883).
+As of Vue 3.0, the getter's result is **not cached** as the computed property does. This is a known issue that requires Vue 3.1 to be released. You can learn more at [PR #1878](https://github.com/vuejs/vuex/pull/1878).
 :::
 
 Getters will receive the state as their 1st argument:

docs/guide/getters.md

@@ -38,7 +38,7 @@ if (module.hot) {
 }
 ```
 
-Checkout the [counter-hot example](https://github.com/vuejs/vuex/tree/dev/examples/counter-hot) to play with hot-reload.
+Checkout the [counter-hot example](https://github.com/vuejs/vuex/tree/main/examples/counter-hot) to play with hot-reload.
 
 ## Dynamic module hot reloading
 

docs/guide/hot-reload.md

@@ -12,7 +12,6 @@ To do so, declare custom typings for Vue's `ComponentCustomProperties` by adding
 
 ```ts
 // vuex.d.ts
-import { ComponentCustomProperties } from 'vue'
 import { Store } from 'vuex'
 
 declare module '@vue/runtime-core' {