Skip to content

Commit c43a911

Browse files
authored
Merge branch 'main' into fix/5830
2 parents 66352d5 + e3bc21f commit c43a911

File tree

243 files changed

+6373
-2137
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

243 files changed

+6373
-2137
lines changed

.eslintrc.js

+16-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ module.exports = {
66
parserOptions: {
77
sourceType: 'module'
88
},
9+
plugins: ["jest"],
910
rules: {
11+
'no-debugger': 'error',
1012
'no-unused-vars': [
1113
'error',
1214
// we are only using this rule to check for unused arguments since TS
@@ -16,10 +18,11 @@ module.exports = {
1618
// most of the codebase are expected to be env agnostic
1719
'no-restricted-globals': ['error', ...DOMGlobals, ...NodeGlobals],
1820
// since we target ES2015 for baseline support, we need to forbid object
19-
// rest spread usage (both assign and destructure)
21+
// rest spread usage in destructure as it compiles into a verbose helper.
22+
// TS now compiles assignment spread into Object.assign() calls so that
23+
// is allowed.
2024
'no-restricted-syntax': [
2125
'error',
22-
'ObjectExpression > SpreadElement',
2326
'ObjectPattern > RestElement',
2427
'AwaitExpression'
2528
]
@@ -30,7 +33,9 @@ module.exports = {
3033
files: ['**/__tests__/**', 'test-dts/**'],
3134
rules: {
3235
'no-restricted-globals': 'off',
33-
'no-restricted-syntax': 'off'
36+
'no-restricted-syntax': 'off',
37+
'jest/no-disabled-tests': 'error',
38+
'jest/no-focused-tests': 'error'
3439
}
3540
},
3641
// shared, may be used in any env
@@ -64,6 +69,14 @@ module.exports = {
6469
'no-restricted-globals': ['error', ...NodeGlobals],
6570
'no-restricted-syntax': 'off'
6671
}
72+
},
73+
// Node scripts
74+
{
75+
files: ['scripts/**', './*.js', 'packages/**/index.js', 'packages/size-check/**'],
76+
rules: {
77+
'no-restricted-globals': 'off',
78+
'no-restricted-syntax': 'off'
79+
}
6780
}
6881
]
6982
}

.github/ISSUE_TEMPLATE/bug_report.yml

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: "\U0001F41E Bug report"
2+
description: Create a report to help us improve
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
**Before You Start...**
8+
9+
This form is only for submitting bug reports. If you have a usage question
10+
or are unsure if this is really a bug, make sure to:
11+
12+
- Read the [docs](https://vuejs.org/)
13+
- Ask on [Discord Chat](https://chat.vuejs.org/)
14+
- Ask on [GitHub Discussions](https://github.com/vuejs/core/discussions)
15+
- Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/ask?tags=vue.js)
16+
17+
Also try to search for your issue - it may have already been answered or even fixed in the development branch.
18+
However, if you find that an old, closed issue still persists in the latest version,
19+
you should open a new issue using the form below instead of commenting on the old issue.
20+
- type: input
21+
id: version
22+
attributes:
23+
label: Vue version
24+
validations:
25+
required: true
26+
- type: input
27+
id: reproduction-link
28+
attributes:
29+
label: Link to minimal reproduction
30+
description: |
31+
The easiest way to provide a reproduction is by showing the bug in [The SFC Playground](https://sfc.vuejs.org/).
32+
If it cannot be reproduced in the playground and requires a proper build setup, try [StackBlitz](https://vite.new/vue).
33+
If neither of these are suitable, you can always provide a GitHub repository.
34+
35+
The reproduction should be **minimal** - i.e. it should contain only the bare minimum amount of code needed
36+
to show the bug. See [Bug Reproduction Guidelines](https://github.com/vuejs/core/blob/main/.github/bug-repro-guidelines.md) for more details.
37+
38+
Please do not just fill in a random link. The issue will be closed if no valid reproduction is provided.
39+
placeholder: Reproduction Link
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: steps-to-reproduce
44+
attributes:
45+
label: Steps to reproduce
46+
description: |
47+
What do we need to do after opening your repro in order to make the bug happen? Clear and concise reproduction instructions are important for us to be able to triage your issue in a timely manner. Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format lists and code.
48+
placeholder: Steps to reproduce
49+
validations:
50+
required: true
51+
- type: textarea
52+
id: expected
53+
attributes:
54+
label: What is expected?
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: actually-happening
59+
attributes:
60+
label: What is actually happening?
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: system-info
65+
attributes:
66+
label: System Info
67+
description: Output of `npx envinfo --system --npmPackages vue --binaries --browsers`
68+
render: shell
69+
placeholder: System, Binaries, Browsers
70+
- type: textarea
71+
id: additional-comments
72+
attributes:
73+
label: Any additional comments?
74+
description: e.g. some background/context of how you ran into this bug.

.github/ISSUE_TEMPLATE/config.yml

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: Create new issue
4-
url: https://new-issue.vuejs.org/?repo=vuejs/core
5-
about: Please use the following link to create a new issue.
3+
- name: Discord Chat
4+
url: https://chat.vuejs.org
5+
about: Ask questions and discuss with other Vue users in real time.
6+
- name: Questions & Discussions
7+
url: https://github.com/vuejs/core/discussions
8+
about: Use GitHub discussions for message-board style questions and discussions.
69
- name: Patreon
710
url: https://www.patreon.com/evanyou
811
about: Love Vue.js? Please consider supporting us via Patreon.
+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: "\U0001F680 New feature proposal"
2+
description: Suggest an idea for this project
3+
labels: [":sparkles: feature request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Before You Start...**
9+
10+
This form is only for submitting feature requests. If you have a usage question
11+
or are unsure if this is really a bug, make sure to:
12+
13+
- Read the [docs](https://vuejs.org/)
14+
- Ask on [Discord Chat](https://chat.vuejs.org/)
15+
- Ask on [GitHub Discussions](https://github.com/vuejs/core/discussions)
16+
- Look for / ask questions on [Stack Overflow](https://stackoverflow.com/questions/ask?tags=vue.js)
17+
18+
Also try to search for your issue - another user may have already requested something similar!
19+
20+
- type: textarea
21+
id: problem-description
22+
attributes:
23+
label: What problem does this feature solve?
24+
description: |
25+
Explain your use case, context, and rationale behind this feature request. More importantly, what is the **end user experience** you are trying to build that led to the need for this feature?
26+
27+
An important design goal of Vue is keeping the API surface small and straightforward. In general, we only consider adding new features that solve a problem that cannot be easily dealt with using existing APIs (i.e. not just an alternative way of doing things that can already be done). The problem should also be common enough to justify the addition.
28+
placeholder: Problem description
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: proposed-API
33+
attributes:
34+
label: What does the proposed API look like?
35+
description: |
36+
Describe how you propose to solve the problem and provide code samples of how the API would work once implemented. Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format your code blocks.
37+
placeholder: Steps to reproduce
38+
validations:
39+
required: true

.github/bug-repro-guidelines.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## About Bug Reproductions
2+
3+
A bug reproduction is a piece of code that can run and demonstrate how a bug can happen.
4+
5+
### Text is not enough
6+
7+
It's impossible to fix a bug from mere text descriptions. First, it's very difficult to precisely describe a technical problem while keeping it easy to follow; Second, the real cause may very well be something that you forgot to even mention. A reproduction is the only way that can reliably help us understand what is going on, so please provide one.
8+
9+
### A repro must be runnable
10+
11+
Screenshots or videos are NOT reproductions! They only show that the bug exists, but do not provide enough information on why it happens. Only runnable code provides the most complete context and allows us to properly debug the scenario. That said, in some cases videos/gifs can help explain interaction issues that are hard to describe in text.
12+
13+
### A repro should be minimal
14+
15+
Some users would give us a link to a real project and hope we can help them figure out what is wrong. We generally do not accept such requests because:
16+
17+
You are already familiar with your codebase, but we are not. It is extremely time-consuming to hunt a bug in a big and unfamiliar codebase.
18+
19+
The problematic behavior may very well be caused by your code rather than by a bug in Vue.
20+
21+
A minimal reproduction means it demonstrates the bug, and the bug only. It should only contain the bare minimum amount of code that can reliably cause the bug. Try your best to get rid of anything that aren't directly related to the problem.
22+
23+
### How to create a repro
24+
25+
For Vue 3 core reproductions, try reproducing it in [The SFC Playground](https://sfc.vuejs.org/).
26+
27+
If it cannot be reproduced in the playground and requires a proper build setup, try [StackBlitz](https://vite.new/vue).
28+
29+
If neither of these are suitable, you can always provide a GitHub repository.

.github/contributing.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ Hi! I'm really excited that you are interested in contributing to Vue.js. Before
1717

1818
## Pull Request Guidelines
1919

20-
- Checkout a topic branch from a base branch, e.g. `master`, and merge back against that branch.
20+
- Checkout a topic branch from a base branch, e.g. `main`, and merge back against that branch.
21+
22+
- [Make sure to tick the "Allow edits from maintainers" box](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). This allows us to directly make minor edits / refactors and saves a lot of time.
2123

2224
- If adding a new feature:
2325

@@ -38,9 +40,23 @@ Hi! I'm really excited that you are interested in contributing to Vue.js. Before
3840

3941
- No need to worry about code style as long as you have installed the dev dependencies - modified files are automatically formatted with Prettier on commit (by invoking [Git Hooks](https://git-scm.com/docs/githooks) via [yorkie](https://github.com/yyx990803/yorkie)).
4042

43+
### Advanced Pull Request Tips
44+
45+
- The PR should fix the intended bug **only** and not introduce unrelated changes. This includes unnecessary refactors - a PR should focus on the fix and not code style, this makes it easier to trace changes in the future.
46+
47+
- Consider the performance / size impact of the changes, and whether the bug being fixes justifies the cost. If the bug being fixed is a very niche edge case, we should try to minimize the size / perf cost to make it worthwhile.
48+
49+
- Is the code perf-sensitive (e.g. in "hot paths" like component updates or the vdom patch function?)
50+
- If the branch is dev-only, performance is less of a concern.
51+
52+
- Check how much extra bundle size the change introduces.
53+
- Make sure to put dev-only code in `__DEV__` branches so they are tree-shakable.
54+
- Runtime code is more sensitive to size increase than compiler code.
55+
- Make sure it doesn't accidentally cause dev-only or compiler-only code branches to be included in the runtime build. Notable case is that some functions in `@vue/shared` are compiler-only and should not be used in runtime code, e.g. `isHTMLTag` and `isSVGTag`.
56+
4157
## Development Setup
4258

43-
You will need [Node.js](https://nodejs.org) **version 16+**, and [PNPM](https://pnpm.io).
59+
You will need [Node.js](https://nodejs.org) **version 16+**, and [PNPM](https://pnpm.io) **version 7+**.
4460

4561
We also recommend installing [ni](https://github.com/antfu/ni) to help switching between repos using different package managers. `ni` also provides the handy `nr` command which running npm scripts easier.
4662

.github/dependabot.yml

+6
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,9 @@ updates:
6262
- dependency-name: node-notifier
6363
versions:
6464
- 8.0.1
65+
- package-ecosystem: "github-actions"
66+
directory: "/"
67+
schedule:
68+
interval: monthly
69+
open-pull-requests-limit: 10
70+
versioning-strategy: lockfile-only

.github/workflows/ci.yml

+37-17
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,68 @@ on:
66
pull_request:
77
branches:
88
- main
9+
10+
permissions:
11+
contents: read # to fetch code (actions/checkout)
12+
913
jobs:
10-
test:
14+
unit-test:
1115
runs-on: ubuntu-latest
1216
steps:
13-
- uses: actions/checkout@v2
17+
- uses: actions/checkout@v3
1418

1519
- name: Install pnpm
16-
uses: pnpm/[email protected]
17-
with:
18-
version: 6.15.1
20+
uses: pnpm/action-setup@v3
1921

2022
- name: Set node version to 16
21-
uses: actions/setup-node@v2
23+
uses: actions/setup-node@v3
2224
with:
2325
node-version: 16
2426
cache: 'pnpm'
2527

2628
- run: pnpm install
2729

2830
- name: Run unit tests
29-
run: pnpm run test
31+
run: pnpm run test-unit
3032

31-
test-dts:
33+
e2e-test:
3234
runs-on: ubuntu-latest
3335
steps:
34-
- uses: actions/checkout@v2
36+
- uses: actions/checkout@v3
3537

3638
- name: Install pnpm
37-
uses: pnpm/[email protected]
39+
uses: pnpm/action-setup@v2
40+
41+
- name: Set node version to 16
42+
uses: actions/setup-node@v3
3843
with:
39-
version: 6.15.1
44+
node-version: 16
45+
cache: 'pnpm'
46+
47+
- run: pnpm install
48+
49+
- name: Run e2e tests
50+
run: pnpm run test-e2e
51+
52+
lint-and-test-dts:
53+
runs-on: ubuntu-latest
54+
steps:
55+
- uses: actions/checkout@v3
56+
57+
- name: Install pnpm
58+
uses: pnpm/action-setup@v2
4059

4160
- name: Set node version to 16
42-
uses: actions/setup-node@v2
61+
uses: actions/setup-node@v3
4362
with:
4463
node-version: 16
4564
cache: 'pnpm'
4665

4766
- run: pnpm install
4867

68+
- name: Run eslint
69+
run: pnpm run lint
70+
4971
- name: Run type declaration tests
5072
run: pnpm run test-dts
5173

@@ -54,15 +76,13 @@ jobs:
5476
env:
5577
CI_JOB_NUMBER: 1
5678
steps:
57-
- uses: actions/checkout@v2
79+
- uses: actions/checkout@v3
5880

5981
- name: Install pnpm
60-
uses: pnpm/[email protected]
61-
with:
62-
version: 6.15.1
82+
uses: pnpm/action-setup@v2
6383

6484
- name: Set node version to 16
65-
uses: actions/setup-node@v2
85+
uses: actions/setup-node@v3
6686
with:
6787
node-version: 16
6888
cache: 'pnpm'

.github/workflows/release-tag.yml

+4
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,12 @@ on:
55

66
name: Create Release
77

8+
permissions: {}
89
jobs:
910
build:
11+
permissions:
12+
contents: write # to create release (yyx990803/release-tag)
13+
1014
name: Create Release
1115
runs-on: ubuntu-latest
1216
steps:

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ explorations
77
TODOs.md
88
*.log
99
.idea
10+
.eslintcache

0 commit comments

Comments
 (0)