History

Evan You 54727f9874 feat: provide ability to overwrite feature flags in esm-bundler builds e.g. by replacing `__VUE_OPTIONS_API__` to `false` using webpack's `DefinePlugin`, the final bundle will drop all code supporting the options API. This does not break existing usage, but requires the user to explicitly configure the feature flags via bundlers to properly tree-shake the disabled branches. As a result, users will see a console warning if the flags have not been properly configured.		2020-07-20 21:51:30 -04:00
..
__tests__	fix(keep-alive): handle "0" as cache key (#1622 )	2020-07-19 13:31:07 -04:00
examples	test(Transition): more complete transition e2e tests (#1151 )	2020-06-25 14:04:23 -04:00
src	feat: provide ability to overwrite feature flags in esm-bundler builds	2020-07-20 21:51:30 -04:00
api-extractor.json	refactor(types): mark internal API exports and exclude from d.ts	2020-04-30 17:04:35 -04:00
index.js	build: add vue package	2018-10-23 11:58:37 -04:00
package.json	release: v3.0.0-rc.2	2020-07-19 14:52:42 -04:00
README.md	build: adjust build formats	2020-04-19 18:43:21 -04:00

vue

Which dist file to use?

vue(.runtime).global(.prod).js:
- For direct use via <script src="..."> in the browser. Exposes the Vue global.
- Note that global builds are not UMD builds. They are built as IIFEs and is only meant for direct use via <script src="...">.
- In-browser template compilation:
  - vue.global.js is the "full" build that includes both the compiler and the runtime so it supports compiling templates on the fly.
  - vue.runtime.global.js contains only the runtime and requires templates to be pre-compiled during a build step.
- Inlines all Vue core internal packages - i.e. it's a single file with no dependencies on other files. This means you must import everything from this file and this file only to ensure you are getting the same instance of code.
- Contains hard-coded prod/dev branches, and the prod build is pre-minified. Use the *.prod.js files for production.
vue(.runtime).esm-browser(.prod).js:
- For usage via native ES modules imports (in browser via <script type="module">.
- Shares the same runtime compilation, dependency inlining and hard-coded prod/dev behavior with the global build.

vue(.runtime).esm-bundler.js:
- For use with bundlers like webpack, rollup and parcel.
- Leaves prod/dev branches with process.env.NODE_ENV guards (must be replaced by bundler)
- Does not ship minified builds (to be done together with the rest of the code after bundling)
- Imports dependencies (e.g. @vue/runtime-core, @vue/runtime-compiler)
  - Imported dependencies are also esm-bundler builds and will in turn import their dependencies (e.g. @vue/runtime-core imports @vue/reactivity)
  - This means you can install/import these deps individually without ending up with different instances of these dependencies, but you must make sure they all resolve to the same version.
- In-browser template compilation:
  - vue.runtime.esm-bundler.js (default) is runtime only, and requires all templates to be pre-compiled. This is the default entry for bundlers (via module field in package.json) because when using a bundler templates are typically pre-compiled (e.g. in *.vue files).
  - vue.esm-bundler.js: includes the runtime compiler. Use this if you are using a bundler but still want runtime template compilation (e.g. in-DOM templates or templates via inline JavaScript strings). You will need to configure your bundler to alias vue to this file.

vue.cjs(.prod).js:
- For use in Node.js server-side rendering via require().
- If you bundle your app with webpack with target: 'node' and properly externalize vue, this is the build that will be loaded.
- The dev/prod files are pre-built, but the appropriate file is automatically required based on process.env.NODE_ENV.