theluyuan/vue3-yuanma
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: more details on build formats [ci skip]

Browse Source
This commit is contained in:
Evan You 2019-12-23 10:12:35 -05:00
parent f601f87dad
commit 51764d3195
2 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
.github/contributing.md vendored
View File

@ -68,12 +68,30 @@ yarn build runtime-core
yarn build runtime --all yarn build runtime --all
``` ```
#### Build Formats
By default, each package will be built in multiple distribution formats as specified in the `buildOptions.formats` field in its `package.json`. These can be overwritten via the `-f` flag. The following formats are supported: By default, each package will be built in multiple distribution formats as specified in the `buildOptions.formats` field in its `package.json`. These can be overwritten via the `-f` flag. The following formats are supported:
- **`global`**: for direct use via `<script>` in the browser. The global variable exposed is specified via the `buildOptions.name` field in a package's `package.json`. - **`global`**:
- **`esm-bundler`**: for use with bundlers like `webpack`, `rollup` and `parcel`. - for direct use via `<script>` in the browser. The global variable exposed is specified via the `buildOptions.name` field in a package's `package.json`.
- **`esm`**: for usage via native ES modules imports (in browser via `<script type="module">`, or via Node.js native ES modules support in the future) - Note: global builds are not [UMD](https://github.com/umdjs/umd) builds. Instead they are built as [IIFEs](https://developer.mozilla.org/en-US/docs/Glossary/IIFE).
- **`cjs`**: for use in Node.js via `require()`.
- **`esm-bundler`**:
- for use with bundlers like `webpack`, `rollup` and `parcel`.
- imports dependencies (e.g. `@vue/runtime-core`, `@vue/runtime-compiler`)
- imported depdencies 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 without ending up with different instances of these dependencies
- Leaves prod/dev branches with `process.env.NODE_ENV` guards (to be replaced by bundler)
- Does not ship a minified build (to be done together with the rest of the code after bundling)
- **`esm`**:
- for usage via native ES modules imports (in browser via `<script type="module">`, or via Node.js native ES modules support in the future)
- inlines all dependencies - i.e. it's a single ES module with no imports from other files
- this means you **must** import everything from `vue` and `vue` only to ensure you are getting the same instance of code.
- hard-coded prod/dev branches, and the prod build is pre-minified (you will have to use different paths/aliases for dev/prod)
- **`cjs`**:
- for use in Node.js server-side rendering via `require()`.
For example, to build `runtime-core` with the global build only: For example, to build `runtime-core` with the global build only:

2
README.md
View File

@ -12,6 +12,7 @@ We have achieved most of the architectural goals and new features planned for v3
- [x] Built-in identifier prefixing (aka "stripWith") - [x] Built-in identifier prefixing (aka "stripWith")
- [x] Built-in pretty-printing - [x] Built-in pretty-printing
- [x] Lean ~10kb brotli-compressed browser build after dropping source map and identifier prefixing - [x] Lean ~10kb brotli-compressed browser build after dropping source map and identifier prefixing
- [x] SFC compiler (replacement of `@vue/component-compiler-utils`)
- Runtime - Runtime
- [x] Significantly faster - [x] Significantly faster
@ -23,7 +24,6 @@ We have achieved most of the architectural goals and new features planned for v3
## Major TODOs: ## Major TODOs:
- [ ] SFC compiler
- [ ] Server-side rendering - [ ] Server-side rendering
Also note that the current implementation requires native ES2015+ in the runtime environment and does not support IE11 (yet). Also note that the current implementation requires native ES2015+ in the runtime environment and does not support IE11 (yet).