From 6952feadc5f458756205e6b4b2935d766ed3d80a Mon Sep 17 00:00:00 2001 From: skirtle <65301168+skirtles-code@users.noreply.github.com> Date: Wed, 4 Sep 2024 05:19:06 +0100 Subject: [PATCH] Prepare perf-releases branch to release a fork --- .github/funding.yml | 2 +- README.md | 96 ++---------------------------------- packages/router/.gitignore | 2 - packages/router/CHANGELOG.md | 2 + packages/router/README.md | 5 ++ packages/router/package.json | 12 +++-- 6 files changed, 20 insertions(+), 99 deletions(-) create mode 100644 packages/router/README.md diff --git a/.github/funding.yml b/.github/funding.yml index 063af581a..168f28a19 100644 --- a/.github/funding.yml +++ b/.github/funding.yml @@ -1,2 +1,2 @@ -github: [posva] +github: [posva, skirtles-code] open_collective: vuejs diff --git a/README.md b/README.md index b47ebb527..4ad629dc8 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,9 @@ -# 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) +# @skirtle/vue-router-perf -> - This is the repository for Vue Router 4 (for Vue 3) -> - For Vue Router 3 (for Vue 2) see [vuejs/vue-router](https://github.com/vuejs/vue-router). +This is a fork of [Vue Router](https://github.com/vuejs/router) with improved performance. -

Supporting Vue Router

+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`. -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: +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. -- [Become a Sponsor on GitHub](https://github.com/sponsors/posva) -- [One-time donation via PayPal](https://paypal.me/posva) - - - -

Silver Sponsors

-

- - - - Route Optimizer and Route Planner Software - - - - - - Prefect - - - - - - VueMastery - - -

- -

Bronze Sponsors

-

- - - - Storyblok - - - - - - Nuxt UI Pro Templates - - - - - - Antony Konstantinidis - - - - - - Stanislas Ormières - - -

- - - ---- - -Get started with the [documentation](https://router.vuejs.org). - -## Quickstart - -- Via CDN: `` -- In-browser playground on [CodeSandbox](https://codesandbox.io/s/vue-router-4-reproduction-hb9lh) -- Add it to an existing Vue Project: - - ```bash - npm install vue-router@4 - ``` - -## Changes from Vue Router 3 - -Please consult the [Migration Guide](https://router.vuejs.org/guide/migration/). - -## Contributing - -See [Contributing Guide](https://github.com/vuejs/router/blob/main/.github/contributing.md). - -## Special Thanks - - - BrowserStack Logo - - -Special thanks to [BrowserStack](https://www.browserstack.com) for letting the maintainers use their service to debug browser specific issues. +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. diff --git a/packages/router/.gitignore b/packages/router/.gitignore index b5bb1d88f..6b1632b93 100644 --- a/packages/router/.gitignore +++ b/packages/router/.gitignore @@ -4,5 +4,3 @@ old-e2e/reports old-e2e/screenshots tests_output logs -# copied from root during release -README.md diff --git a/packages/router/CHANGELOG.md b/packages/router/CHANGELOG.md index 0ed655457..9b3d15aad 100644 --- a/packages/router/CHANGELOG.md +++ b/packages/router/CHANGELOG.md @@ -1,3 +1,5 @@ +This is the changelog for `vue-router`. It does not include changes to `@skirtle/vue-router-perf`. + ## [4.4.3](https://github.com/vuejs/router/compare/v4.4.2...v4.4.3) (2024-08-06) ### Bug Fixes diff --git a/packages/router/README.md b/packages/router/README.md new file mode 100644 index 000000000..2ab7d2851 --- /dev/null +++ b/packages/router/README.md @@ -0,0 +1,5 @@ +# @skirtle/vue-router-perf + +This is a fork of [Vue Router](https://github.com/vuejs/router) with improved performance. + +See for details. diff --git a/packages/router/package.json b/packages/router/package.json index 0843823dd..868af2dde 100644 --- a/packages/router/package.json +++ b/packages/router/package.json @@ -1,6 +1,6 @@ { - "name": "vue-router", - "version": "4.4.3", + "name": "@skirtle/vue-router-perf", + "version": "0.0.0", "main": "index.js", "unpkg": "dist/vue-router.global.js", "jsdelivr": "dist/vue-router.global.js", @@ -71,12 +71,14 @@ "license": "MIT", "repository": { "type": "git", - "url": "git+https://github.com/vuejs/router.git" + "url": "git+https://github.com/skirtles-code/vue-router.git" }, "bugs": { - "url": "https://github.com/vuejs/router/issues" + "url": "https://github.com/skirtles-code/vue-router/issues" }, - "homepage": "https://github.com/vuejs/router#readme", + "homepage": "https://github.com/skirtles-code/vue-router/tree/perf-releases#readme", + "keywords": ["vue", "router", "vue-router", "performance", "perf"], + "description": "Fork of vue-router with improved performance", "files": [ "index.js", "dist/*.{js,cjs,mjs}",