Skip to content

Commit 6952fea

Browse files
skirtles-codeskirtles-code
committed
Prepare perf-releases branch to release a fork
1 parent 8d28f20 commit 6952fea

File tree

6 files changed

+20
-99
lines changed

6 files changed

+20
-99
lines changed

‎.github/funding.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
github: [posva]
1+
github: [posva, skirtles-code]
22
open_collective: vuejs

‎README.md

Lines changed: 5 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,9 @@
1-
# vue-router [![release candidate](https://img.shields.io/npm/v/vue-router.svg)](https://www.npmjs.com/package/vue-router) [![test](https://github.com/vuejs/router/actions/workflows/test.yml/badge.svg)](https://github.com/vuejs/router/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/vuejs/router/graph/badge.svg?token=azNM3FI0d1)](https://codecov.io/gh/vuejs/router)
1+
# @skirtle/vue-router-perf
22

3-
> - This is the repository for Vue Router 4 (for Vue 3)
4-
> - For Vue Router 3 (for Vue 2) see [vuejs/vue-router](https://github.com/vuejs/vue-router).
3+
This is a fork of [Vue Router](https://github.com/vuejs/router) with improved performance.
54

6-
<h2 align="center">Supporting Vue Router</h2>
5+
The [`perf-releases`](https://github.com/skirtles-code/vue-router/tree/perf-releases) branch is used to make releases to the npm package `@skirtle/vue-router-perf`.
76

8-
Vue Router is part of the Vue Ecosystem and is an MIT-licensed open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider:
7+
The package `@skirtle/vue-router-perf` is intended to be a drop-in replacement for `vue-router`. It includes performance improvements that aren't yet available in the official package.
98

10-
- [Become a Sponsor on GitHub](https://github.com/sponsors/posva)
11-
- [One-time donation via PayPal](https://paypal.me/posva)
12-
13-
<!--sponsors start-->
14-
15-
<h4 align="center">Silver Sponsors</h4>
16-
<p align="center">
17-
<a href="https://route4me.com" target="_blank" rel="noopener noreferrer">
18-
<picture>
19-
<source srcset="https://posva-sponsors.pages.dev/logos/route4me.png" media="(prefers-color-scheme: dark)" height="42px" alt="Route Optimizer and Route Planner Software" />
20-
<img src="https://posva-sponsors.pages.dev/logos/route4me.png" height="42px" alt="Route Optimizer and Route Planner Software" />
21-
</picture>
22-
</a>
23-
<a href="https://www.prefect.io/" target="_blank" rel="noopener noreferrer">
24-
<picture>
25-
<source srcset="https://posva-sponsors.pages.dev/logos/prefectlogo-dark.svg" media="(prefers-color-scheme: dark)" height="42px" alt="Prefect" />
26-
<img src="https://posva-sponsors.pages.dev/logos/prefectlogo-light.svg" height="42px" alt="Prefect" />
27-
</picture>
28-
</a>
29-
<a href="https://www.vuemastery.com/" target="_blank" rel="noopener noreferrer">
30-
<picture>
31-
<source srcset="https://posva-sponsors.pages.dev/logos/vuemastery-dark.png" media="(prefers-color-scheme: dark)" height="42px" alt="VueMastery" />
32-
<img src="https://posva-sponsors.pages.dev/logos/vuemastery-light.svg" height="42px" alt="VueMastery" />
33-
</picture>
34-
</a>
35-
</p>
36-
37-
<h4 align="center">Bronze Sponsors</h4>
38-
<p align="center">
39-
<a href="https://storyblok.com" target="_blank" rel="noopener noreferrer">
40-
<picture>
41-
<source srcset="https://posva-sponsors.pages.dev/logos/storyblok.png" media="(prefers-color-scheme: dark)" height="26px" alt="Storyblok" />
42-
<img src="https://posva-sponsors.pages.dev/logos/storyblok.png" height="26px" alt="Storyblok" />
43-
</picture>
44-
</a>
45-
<a href="https://ui.nuxt.com/pro" target="_blank" rel="noopener noreferrer">
46-
<picture>
47-
<source srcset="https://posva-sponsors.pages.dev/logos/nuxt-dark.svg" media="(prefers-color-scheme: dark)" height="26px" alt="Nuxt UI Pro Templates" />
48-
<img src="https://posva-sponsors.pages.dev/logos/nuxt-light.svg" height="26px" alt="Nuxt UI Pro Templates" />
49-
</picture>
50-
</a>
51-
<a href="https://www.vuejs.de" target="_blank" rel="noopener noreferrer">
52-
<picture>
53-
<source srcset="https://avatars.githubusercontent.com/u/4183726?u=6b50a8ea16de29d2982f43c5640b1db9299ebcd1&v=4" media="(prefers-color-scheme: dark)" height="26px" alt="Antony Konstantinidis" />
54-
<img src="https://avatars.githubusercontent.com/u/4183726?u=6b50a8ea16de29d2982f43c5640b1db9299ebcd1&v=4" height="26px" alt="Antony Konstantinidis" />
55-
</picture>
56-
</a>
57-
<a href="https://stormier.ninja" target="_blank" rel="noopener noreferrer">
58-
<picture>
59-
<source srcset="https://avatars.githubusercontent.com/u/2486424?u=7b0c73ae5d090ce53bf59473094e9606fe082c59&v=4" media="(prefers-color-scheme: dark)" height="26px" alt="Stanislas Ormières" />
60-
<img src="https://avatars.githubusercontent.com/u/2486424?u=7b0c73ae5d090ce53bf59473094e9606fe082c59&v=4" height="26px" alt="Stanislas Ormières" />
61-
</picture>
62-
</a>
63-
</p>
64-
65-
<!--sponsors end-->
66-
67-
---
68-
69-
Get started with the [documentation](https://router.vuejs.org).
70-
71-
## Quickstart
72-
73-
- Via CDN: `<script src="https://unpkg.com/vue-router@4"></script>`
74-
- In-browser playground on [CodeSandbox](https://codesandbox.io/s/vue-router-4-reproduction-hb9lh)
75-
- Add it to an existing Vue Project:
76-
77-
```bash
78-
npm install vue-router@4
79-
```
80-
81-
## Changes from Vue Router 3
82-
83-
Please consult the [Migration Guide](https://router.vuejs.org/guide/migration/).
84-
85-
## Contributing
86-
87-
See [Contributing Guide](https://github.com/vuejs/router/blob/main/.github/contributing.md).
88-
89-
## Special Thanks
90-
91-
<a href="https://www.browserstack.com">
92-
<img src="https://github.com/vuejs/vue-router/raw/dev/assets/browserstack-logo-600x315.png" height="80" title="BrowserStack Logo" alt="BrowserStack Logo" />
93-
</a>
94-
95-
Special thanks to [BrowserStack](https://www.browserstack.com) for letting the maintainers use their service to debug browser specific issues.
9+
It should be much faster for applications with large numbers of routes. The performance improvements affect both the creation of the router and the resolving of routes.

‎packages/router/.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,3 @@ old-e2e/reports
44
old-e2e/screenshots
55
tests_output
66
logs
7-
# copied from root during release
8-
README.md

‎packages/router/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
This is the changelog for `vue-router`. It does not include changes to `@skirtle/vue-router-perf`.
2+
13
## [4.4.3](https://github.com/vuejs/router/compare/v4.4.2...v4.4.3) (2024-08-06)
24

35
### Bug Fixes

‎packages/router/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# @skirtle/vue-router-perf
2+
3+
This is a fork of [Vue Router](https://github.com/vuejs/router) with improved performance.
4+
5+
See <https://github.com/skirtles-code/vue-router/tree/perf-releases#readme> for details.

‎packages/router/package.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "vue-router",
3-
"version": "4.4.3",
2+
"name": "@skirtle/vue-router-perf",
3+
"version": "0.0.0",
44
"main": "index.js",
55
"unpkg": "dist/vue-router.global.js",
66
"jsdelivr": "dist/vue-router.global.js",
@@ -71,12 +71,14 @@
7171
"license": "MIT",
7272
"repository": {
7373
"type": "git",
74-
"url": "git+https://github.com/vuejs/router.git"
74+
"url": "git+https://github.com/skirtles-code/vue-router.git"
7575
},
7676
"bugs": {
77-
"url": "https://github.com/vuejs/router/issues"
77+
"url": "https://github.com/skirtles-code/vue-router/issues"
7878
},
79-
"homepage": "https://github.com/vuejs/router#readme",
79+
"homepage": "https://github.com/skirtles-code/vue-router/tree/perf-releases#readme",
80+
"keywords": ["vue", "router", "vue-router", "performance", "perf"],
81+
"description": "Fork of vue-router with improved performance",
8082
"files": [
8183
"index.js",
8284
"dist/*.{js,cjs,mjs}",

0 commit comments

Comments
 (0)