Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shunnnet/vue-caster
Command line tool that can switch Vue versions.
https://github.com/shunnnet/vue-caster
vue vue-demi vue2 vue3
Last synced: about 1 month ago
JSON representation
Command line tool that can switch Vue versions.
- Host: GitHub
- URL: https://github.com/shunnnet/vue-caster
- Owner: shunnNet
- Created: 2024-07-29T23:14:27.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-30T16:26:23.000Z (4 months ago)
- Last Synced: 2024-10-11T09:01:11.808Z (about 1 month ago)
- Topics: vue, vue-demi, vue2, vue3
- Language: JavaScript
- Homepage:
- Size: 45.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🛠️ vue-caster
- [🛠️ vue-caster](#️-vue-caster)
- [How this works?](#how-this-works)
- [Usage](#usage)
- [Why](#why)
- [TODO](#todo)
- [License](#license)
This is a command line tool that can switch between Vue versions. It can be used in conjunction with [vue-demi](https://github.com/vueuse/vue-demi) for developing components for Vue 2 and Vue 3.
## How this works?
The way this package works is by using [npm install alias](https://docs.npmjs.com/cli/v8/commands/npm-install).
First, install this package as "vue". Then, in the same project, install different versions of `Vue` under different names, such as `vue2.7`, `vue2.6`, `vue3`. Next, run the command line to switch `Vue` versions, and `vue-caster` will export the corresponding version of Vue.
If you are familiar with `vue-demi`, then the way `vue-caster` works is similar to `vue-demi`.
## Usage
1. Install `vue-caster` as `vue`:
```bash
npm install -D vue@npm:vue-caster vue-demi
```
2. Install different versions of `Vue` with different names:
```bash
npm install vue2.7@npm:[email protected]
npm install vue3@npm:[email protected]
```
3. Switch between Vue versions:
```bash
# v-cast
v-cast 2.7 vue2.7
vue-demi-switch 2.7 vue2.7
# Switch to Vue 3
v-cast 3 vue3
vue-demi-switch 3 vue3
```
4. Import Vue in your code, use it as usual:
```js
// If Vue 2
import Vue from 'vue';
// If Vue 3
import { ref } from 'vue';
```
Or you can directly import from `vue-demi`
```js
import { version } from 'vue-demi'; // is the the version of Vue you are using
console.log(version); // version of Vue you are using
```
When you want to publish your package using `Vite`, just mark `vue` as external in `vite.config.js`:
```js
export default {
optimizeDeps: {
exclude: ['vue-demi', 'vue'],
},
rollupInputOptions: {
external: ['vue-demi', 'vue'],
},
};
```
When you need to bundle or use `vitest`, you will need `vue-demi`'s `isVue2` and `isVue3` to switch build configurations. You can refer to the `vite.config.ts` in the `/example` directory.
## Why
You might ask, why do we still need `vue-caster` when we already have `vue-demi`? The main reason is that when developing components that are compatible with both Vue 2 and Vue 3, it's difficult to use `.vue` files with only `vue-demi`. You might want to develop using TypeScript in `.vue` files, or for various reasons, you need to bundle it, but you find that there can only be one version of `vue` in `node_modules`. So when you want to bundle or test, version error messages pop up because they all import or require `vue`.
Can Vite `resolve.alias` solve this problem? No, because although alias can convert runtime code, it cannot handle the import or require of build tools.
To solve this problem, you could install different versions of Vue in different projects or pull out the packages with version dependency errors for customization. These are not comfortable solutions.
Thus, `vue-caster` was created. It is a proxy tool for Vue that can be used as different versions of Vue. Since it is installed as the name "vue" at the package level, the aforementioned path conversion issues are resolved.
## TODO
- [ ] Issue when direct vue import in vue-demi (entry not found: ./dist)
- [ ] vue-test-utils type error
- [ ] vite-plugin-dts cannot rollup types.
- [ ] There are still some of vue exports not be handled.
## License
MIT