]> git.ipfire.org Git - thirdparty/vuejs/core.git/commitdiff
docs: add note on compiler-sfc/server-renderer usage update [ci skip]
authorEvan You <yyx990803@gmail.com>
Wed, 22 Sep 2021 02:55:10 +0000 (22:55 -0400)
committerEvan You <yyx990803@gmail.com>
Wed, 22 Sep 2021 02:55:10 +0000 (22:55 -0400)
packages/compiler-sfc/README.md
packages/server-renderer/README.md

index 1d6d8db4252fc700c257e2aa49c531a002bbfd16..c76618e4a4d064792efb47aa8bcef10a08cb0a0c 100644 (file)
@@ -2,6 +2,8 @@
 
 > Lower level utilities for compiling Vue Single File Components
 
+**Note: as of 3.2.13+, this package is included as a dependency of the main `vue` package and can be accessed as `vue/compiler-sfc`. This means you no longer need to explicitly install this package and ensure its version match that of `vue`'s. Just use the main `vue/compiler-sfc` deep import instead.**
+
 This package contains lower level utilities that you can use if you are writing a plugin / transform for a bundler or module system that compiles Vue Single File Components (SFCs) into JavaScript. It is used in [vue-loader](https://github.com/vuejs/vue-loader), [rollup-plugin-vue](https://github.com/vuejs/rollup-plugin-vue) and [vite](https://github.com/vitejs/vite).
 
 ## API
@@ -9,6 +11,7 @@ This package contains lower level utilities that you can use if you are writing
 The API is intentionally low-level due to the various considerations when integrating Vue SFCs in a build system:
 
 - Separate hot-module replacement (HMR) for script, template and styles
+
   - template updates should not reset component state
   - style updates should be performed without component re-render
 
@@ -74,6 +77,4 @@ export default script
 
 Options needed for these APIs can be passed via the query string.
 
-
-
 For detailed API references and options, check out the source type definitions. For actual usage of these APIs, check out [rollup-plugin-vue](https://github.com/vuejs/rollup-plugin-vue/tree/next) or [vue-loader](https://github.com/vuejs/vue-loader/tree/next).
index 7cec9a6f25fcbdc1c8c7cce8b45e3c23efac8d0d..4188fc93fd7bc01476d2d8fef85f40f5243f6694 100644 (file)
@@ -1,5 +1,7 @@
 # @vue/server-renderer
 
+**Note: as of 3.2.13+, this package is included as a dependency of the main `vue` package and can be accessed as `vue/server-renderer`. This means you no longer need to explicitly install this package and ensure its version match that of `vue`'s. Just use the `vue/server-renderer` deep import instead.**
+
 ## Basic API
 
 ### `renderToString`