Rollup Smart Asset Plugin

Overview

Rollup plugin to rebase, inline or copy assets referenced from the JavaScript code.

Usage

1import smartAsset from 'rollup-plugin-smart-asset'
2
3const smartAssetOpts = { ... }
4
5export default {
6  input: 'src/index.tsx',
7  output: {
8    file: 'dist/index.js',
9    format: 'iife'
10  },
11  plugins: [
12    ...
13    smartAsset(smartAssetOpts)
14    ...
15  ]
16}

Configuration

For libraries it is recommended to use inline or copy mode with keepImport option to delegate bundling to consumer's package bundler. Asset hasing is not needed for this case and it is safe to set useHash: false and keepName: true.

For applications it is also recommended to use inline or copy mode with enabled by default hashing.

Default settings are set to be the same as in postcss-smart-asset to have one config for both of them.

Main options:

• url: Mode: rebase (default), inline and copy
• extensions: What file extensions to process, defaults to [".svg", ".gif", ".png", ".jpg"]

Mode: rebase

Rebase asset references to be relative to specific directory.

Output:

1// without keepImport
2export default "public_path_to_asset"
3// with keepImport
4export default require("relative_path_to_asset_from_bundle")

Options:

• publicPath: Reference file from JS using this path, relative to html page where asset is referenced. Could be relative, absolute or CDN.
• rebasePath: Rebase all asset urls to this directory, defaults to current directory.
• keepImport: Keep import, so consumer of your package could define their own bundle configuration.
• sourceMap: Set to true to keep source map.

Mode: inline

Inline assets as base64 urls directly in source code.

Keep in mind, all options for copy mode will be used if falled back to copy mode.

Output:

1export default "data:{mimeType};base64,{data}"

Options:

• maxSize: Max file size to inline, fallback is copy mode, defaults to 14 kbytes.

Mode: copy

Copy asset to target directory and rebase original references to point to it depending on provided configuration.

Output:

1// without keepImport
2export default "public_path_to_asset"
3// with keepImport
4export default require("relative_path_to_asset_from_bundle")
5// + file is copied to target directory

Options:

• publicPath: Reference file from JS using this path, relative to html page where asset is referenced. Could be relative, absolute or CDN.
• assetsPath: Copy assets to this directory, relative to rollup output.
• useHash: Use [hash][ext] instead of default [name][ext]
• keepName: Use both hash and name [name]-[hash][ext] if useHash is true
• nameFormat: Use custom name format using these patterns [name], [ext], [hash].
• hashOptions: See more: https://github.com/sebastian-software/asset-hash
  • hash: Any valid hashing algorithm e.g. metrohash128 (default), metrohash64, xxhash64, xxhash32, sha1, md5, ...
  • encoding: Any valid encoding for built-in digests hex, base64, base62 (default), ...
  • maxLength: Maximum length of returned digest. Keep in mind that reducing it increases collison probability.
• keepImport: Keep import, so consumer of your package could define their own bundle configuration.

Alternatives

rollup-plugin-url

https://github.com/rollup/rollup-plugin-url

rollup-plugin-url has fewer options, doesn't work if asset is already loaded by another plugin (by sourcemaps, for example) and, what is most important, has non permissive license (as of 2018-03-02). This plugin has also keepImport feature that is not available in rollup-plugin-url.

postcss-smart-asset

https://github.com/sebastian-software/postcss-smart-asset

postcss-smart-asset works well when you need to bundle assets referenced from CSS, but doesn't work for assets imported from JavaScript.

rollup-plugin-rebase

https://github.com/sebastian-software/rollup-plugin-rebase

rollup-plugin-rebase designed for libraries, not applications. This plugin designed for all use cases.

TODO

• port remaining options from postcss-smart-asset and rollup-plugin-url

Contribution

PRs are very welcome!

License

MIT