Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changed bundler to Rollup #367

Merged
merged 23 commits into from
Mar 23, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update
  • Loading branch information
krisk committed Mar 23, 2020
commit 3c4547354d989f88f6822c3eda0394ac76e9a2b2
14 changes: 6 additions & 8 deletions dist/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
## Explanation of Build Files

| | UMD | CommonJS | ES Module (for bundlers) | ES Module (for direct import in browser) |
| --------------- | ----------- | -------------- | ------------------------ | ---------------------------------------- |
| **Development** | fuse.js | fuse.common.js | fuse.esm.js | fuse.esm.browser.js |
| **Production** | fuse.min.js | - | - | fuse.esm.browser.min.js |
| | UMD | CommonJS | ES Module (for bundlers) |
| --------------- | ----------- | -------------- | ------------------------ |
| **Development** | fuse.js | fuse.common.js | fuse.esm.js |
| **Production** | fuse.min.js | - | - |

### Terms

- **[UMD](https://github.com/umdjs/umd)**: UMD builds can be used directly in the browser via a `<script>` tag. The default file from jsDelivr CDN at https://cdn.jsdelivr.net/npm/fuse.js is the UMD build (`fuse.js`).

- **[CommonJS](http://wiki.commonjs.org/wiki/Modules/1.1)**: CommonJS builds are intended for use with older bundlers like [browserify](http://browserify.org/) or [webpack 1](https://webpack.github.io). The default file for these bundlers (`pkg.main`) is the CommonJS build (`fuse.common.js`).
- **[CommonJS](http://wiki.commonjs.org/wiki/Modules/1.1)**: CommonJS builds are intended for use with older bundlers like [browserify](http://browserify.org/) or [webpack 1](https://webpack.github.io). The file for these bundlers (`pkg.main`) is the CommonJS build (`fuse.common.js`).

- **[ES Module](http://exploringjs.com/es6/ch_modules.html)**: Fuse.js provides two ES Modules (ESM) builds:
- **ESM for bundlers**: intended for use with modern bundlers like [Webpack 2](https://webpack.js.org) or [Rollup](http://rollupjs.org/). ESM format is designed to be statically analyzable so the bundlers can take advantage of that to perform “tree-shaking” and eliminate unused code from your final bundle. The default file for these bundlers (`pkg.module`) is the ES Module build (`fuse.esm.js`).
- **ESM for browsers**: intended for direct imports in modern browsers via `<script type="module">`.
- **[ES Module](http://exploringjs.com/es6/ch_modules.html)**: Intended for use with modern bundlers like [Webpack 2](https://webpack.js.org) or [Rollup](http://rollupjs.org/). The file for these bundlers (`pkg.module`) is the ES Module build (`fuse.esm.js`).
Loading