diff --git a/packages/vue-compat/README.md b/packages/vue-compat/README.md index 62c5aa571e3..75ce5386ba9 100644 --- a/packages/vue-compat/README.md +++ b/packages/vue-compat/README.md @@ -1 +1,329 @@ -# @vue/compat \ No newline at end of file +# `@vue/compat` + +## Overview + +`@vue/compat` (aka "the migration build") is a build of Vue 3 that provides configurable Vue 2 compatible behavior. + +The migration build runs in Vue 2 mode by default - most public APIs behave exactly like Vue 2, with only [a few exceptions](TODO). Usage of features that have changed or been deprecated in Vue 3 will emit runtime warnings. A feature's compatibility can be enabled/disabled on a per-component basis. + +### Intended Use Cases + +- Upgrading a Vue 2 application to Vue 3 (with limitations) +- Migrate a library to support Vue 3 +- For experienced Vue 2 developers who have not tried Vue 3 yet, the migration build can be used in place of Vue 3 to help learn the difference between versions. + +### Known Limitations + +While we've tried hard to make the migration build mimic Vue 2 behavior as much as possible, there are some limitations that may prevent your app from being eligible for upgrading: + +- Dependencies that rely on Vue 2 internal APIs or undocumented behavior. The most common case is usage of private properties on vnodes. If your project relies on component libraries like Vuetify, Quasar or ElementUI, it is best to wait for their Vue 3 compatible versions. + +- IE11 support: [Vue 3 has officially dropped the plan for IE11 support](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0038-vue3-ie11-support.md). If you still need to support IE11 or below, you will have to stay on Vue 2. + +- SSR: the migration build can be used for SSR, but migrating a custom SSR setup is much more involved. The general idea is replacing `vue-server-renderer` with [`@vue/server-renderer`](https://github.com/vuejs/vue-next/tree/master/packages/server-renderer). Vue 3 no longer provides a bundle renderer and it is recommended to use Vue 3 SSR with [Vite](https://vitejs.dev/guide/ssr.html). If you are using Nuxt, it is probably better to wait for Nuxt 3. + +### Expectations + +Please note that the migration build aims to cover only publicly documented Vue 2 APIs and behavior. If your app fails to run under migration build due to reliance on undocumented behavior, it is unlikely for us to tweak the migration build to cater to your specific case. Consider refactoring to remove reliance on the behavior in question instead. + +A word of caution: if your app is large and complex, migration will likely be a challenge even with the migration build. If your app is unfortunately not suitable for upgrade, do note that we are planning to backport Composition API and some other Vue 3 features to the 2.7 (estimated late Q3 2021). + +If you do get your app running on migration build, you **can** ship it to production before the migration is complete. Although there is a small performance/size overhead, it should not noticeably affect production UX. You may have to do so when you have dependencies that relies on Vue 2 behavior, and cannot be upgraded/replaced. + +The migration build will be provided starting with 3.1, and will continue to be published alongside the 3.2 release line. We do plan to eventually stop publishing migration build in a future minor version (no earlier than EOY 2021), so you should still aim to switch to the standard build before then. + +## Upgrade Workflow + +The following workflow walks through the steps of migrating an actual Vue 2 app (Vue HackerNews 2.0) to Vue 3. The full commits can be found [here](https://github.com/vuejs/vue-hackernews-2.0/compare/migration). Note that the actual steps required for your project may vary, and these steps should be treated as general guidance rather than strict instructions. + +### Preparations + +- If you are still using the [deprecated named / scoped slot syntax](https://vuejs.org/v2/guide/components-slots.html#Deprecated-Syntax), update it to the latest syntax first (which is already supported in 2.6). + +### Installation + +1. Upgrade tooling if applicable. + + - If using custom webpack setup: Upgrade `vue-loader` to `^16.0.0`. + - If using `vue-cli`: upgrade to the latest `@vue/cli-service` with `vue upgrade` + - (Alternative) migrate to [Vite](https://vitejs.dev/) + [vite-plugin-vue2](https://github.com/underfin/vite-plugin-vue2). [[Example commit](https://github.com/vuejs/vue-hackernews-2.0/commit/565b948919eb58f22a32afca7e321b490cb3b074)] + +2. In `package.json`, update `vue` to 3.1, install `@vue/compat` of the same version, and replace `vue-template-compiler` (if present) with `@vue/compiler-sfc`: + + ```diff + "dependencies": { + - "vue": "^2.6.12", + + "vue": "^3.1.0-0", + + "@vue/compat": "^3.1.0-0" + ... + }, + "devDependencies": { + - "vue-template-compiler": "^2.6.12" + + "@vue/compiler-sfc": "^3.1.0-0" + } + ``` + + > Note: the -0 at the end of the version is to account for pre-releases. + + [Example commit](https://github.com/vuejs/vue-hackernews-2.0/commit/14f6f1879b43f8610add60342661bf915f5c4b20) + +3. In the build setup, alias `vue` to `@vue/compat` and enable compat mode via Vue compiler options. + + **Example Configs** + +
+ vue-cli + + ```js + // vue.config.js + module.exports = { + chainWebpack: config => { + config.resolve.alias.set('vue', '@vue/compat') + + config.module + .rule('vue') + .use('vue-loader') + .tap(options => { + return { + ...options, + compilerOptions: { + compatConfig: { + MODE: 2 + } + } + } + }) + } + ``` +
+ +
+ Plain webpack + + ```js + // webpack.config.js + module.exports = { + resolve: { + alias: { + vue: '@vue/compat' + } + }, + module: { + rules: [ + { + test: /\.vue$/, + loader: 'vue-loader', + options: { + compilerOptions: { + compatConfig: { + MODE: 2 + } + } + } + } + ] + } + } + ``` +
+ +
+ Vite + + ```js + // vite.config.js + export default { + resolve: { + alias: { + vue: '@vue/compat' + } + }, + plugins: [ + vue({ + template: { + compilerOptions: { + compatConfig: { + MODE: 2 + } + } + } + }) + ] + } + ``` +
+ +4. At this point, your application may encounter some compile-time errors / warnings (e.g. use of filters). Fix them first. If all compiler warnings are gone, you can also set the compiler to Vue 3 mode. + + [Example commit](https://github.com/vuejs/vue-hackernews-2.0/commit/b05d9555f6e115dea7016d7e5a1a80e8f825be52) + +5. After fixing the errors, the app should be able to run if it is not subject to the [limitations](#known-limitations) mentioned above. + + You will likely see a LOT of warnings from both the command line and the browser console. Here are some general tips: + + - You can filter for specific warnings in the browser console. It's a good idea to use the filter and focus on fixing one item at a time. You can also use negated filters like `-GLOBAL_MOUNT`. + + - You can suppress specific deperecations via [compat configuration](#compat-configuration). + + - Some warnings maybe caused by a dependency that you use (e.g. `vue-router`). You can check this from the warning's component trace or stack trace (expanded on click). Focus on fixing the warnings that originates from your own source code first. + + - If you are using `vue-router`, note `` and `` will not work with `` until you upgrade to `vue-router` v4. + +6. Update [`` class names](https://v3.vuejs.org/guide/migration/transition.html). This is the only feature that does not have a runtime warning. You can do a project-wide search for `.*-enter` and `.*-leave` CSS class names. + + [Example commit](https://github.com/vuejs/vue-hackernews-2.0/commit/d300103ba622ae26ac26a82cd688e0f70b6c1d8f) + +7. Update app entry to use [new global mounting API](https://v3.vuejs.org/guide/migration/global-api.html#a-new-global-api-createapp). + + [Example commit](https://github.com/vuejs/vue-hackernews-2.0/commit/a6e0c9ac7b1f4131908a4b1e43641f608593f714) + +9. [Upgrade `vuex` to v4](https://next.vuex.vuejs.org/guide/migrating-to-4-0-from-3-x.html). + + [Example commit](https://github.com/vuejs/vue-hackernews-2.0/commit/5bfd4c61ee50f358cd5daebaa584f2c3f91e0205) + +10. [Upgrade `vue-router` to v4](https://next.router.vuejs.org/guide/migration/index.html). If you also use `vuex-router-sync`, you can replace it with a store getter. + + After the upgrade, to use `` and `` with `` requires using the new [scoped-slot based syntax](https://next.router.vuejs.org/guide/migration/index.html#router-view-keep-alive-and-transition). + + [Example commit](https://github.com/vuejs/vue-hackernews-2.0/commit/758961e73ac4089890079d4ce14996741cf9344b) + +11. Pick off individual warnings. Note some features have conflicting behavior between Vue 2 and Vue 3 - for example, the render function API, or the functional component vs. async component change. To migrate to Vue 3 API without affecting the rest of the application, you can opt-in to Vue 3 behavior on a per-component basis with the [`compatConfig` option](#per-component-config). + + [Example commit](https://github.com/vuejs/vue-hackernews-2.0/commit/d0c7d3ae789be71b8fd56ce79cb4cb1f921f893b) + +12. When all warnings are fixed, you can remove the migration build and switch to Vue 3 proper. Note you may not be able to do so if you still have dependencies that rely on Vue 2 behavior. + + [Example commit](https://github.com/vuejs/vue-hackernews-2.0/commit/9beb45490bc5f938c9e87b4ac1357cfb799565bd) + +## Compat Configuration + +### Global Config + +Compat features can be disabled individually: + +```js +import { configureCompat } from 'vue' + +// disable compat for certain features +configureCompat({ + FEATURE_ID_A: false, + FEATURE_ID_B: false +}) +``` + +Alternatively, the entire application can default to Vue 3 behavior, with only certain compat features enabled: + +```js +import { configureCompat } from 'vue' + +// default everything to Vue 3 behavior, and only enable compat +// for certain features +configureCompat({ + MODE: 3, + FEATURE_ID_A: true, + FEATURE_ID_B: true +}) +``` + +### Per-Component Config + +A component can use the `compatConfig` option which expects the same options with the global `configureCompat` method: + +```js +export default { + compatConfig: { + MODE: 3, // opt-in to Vue 3 behavior for this component only + FEATURE_ID_A: true // features can also be toggled at component level + }, + // ... +} +``` + +### Compiler-specific Config + +Features that start with `COMPILER_` are compiler-specific: if you are using the full build (with in-browser compiler), they can be configured at runtime. However if using a build setup, they must be configured via the `compilerOptions` in the build config instead (see example configs above). + +## Feature Reference + +### Compatibility Types + +- ● Fully compatible +- ◐ Partially Compatible with caveats +- ⃠ Incompatible (warning only) +- ⭘ Compat only (no warning) + +### Incompatible + +> Should be fixed upfront or will likely lead to errors + +| ID | Type | Description | Docs | +|---------------------------------------|------|---------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| +| GLOBAL_MOUNT_CONTAINER | ⃠ | Mounted application does not replace the element it's mounted to | [link](https://v3.vuejs.org/guide/migration/mount-changes.html) | +| CONFIG_DEVTOOLS | ⃠ | production devtools is now a build-time flag | [link](https://github.com/vuejs/vue-next/tree/master/packages/vue#bundler-build-feature-flags) | +| COMPILER_V_IF_V_FOR_PRECEDENCE | ⃠ | v-if and v-for precedence when used on the same element has changed | [link](https://v3.vuejs.org/guide/migration/v-if-v-for.html) | +| COMPILER_V_IF_SAME_KEY | ⃠ | v-if branches can no longer have the same key | [link](https://v3.vuejs.org/guide/migration/key-attribute.html#on-conditional-branches) | +| COMPILER_V_FOR_TEMPLATE_KEY_PLACEMENT | ⃠ | `