Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rollup/rollup-plugin-url
This module has moved and is now available at @rollup/plugin-url / https://github.com/rollup/plugins/blob/master/packages/url
https://github.com/rollup/rollup-plugin-url
Last synced: 16 days ago
JSON representation
This module has moved and is now available at @rollup/plugin-url / https://github.com/rollup/plugins/blob/master/packages/url
- Host: GitHub
- URL: https://github.com/rollup/rollup-plugin-url
- Owner: rollup
- License: mit
- Archived: true
- Created: 2016-02-07T23:10:27.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-08-04T17:26:20.000Z (over 3 years ago)
- Last Synced: 2024-10-15T12:03:16.760Z (29 days ago)
- Language: JavaScript
- Homepage:
- Size: 117 KB
- Stars: 75
- Watchers: 10
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Moved
This module has moved and is now available at [@rollup/plugin-url](https://github.com/rollup/plugins). Please update your dependencies. This repository is no longer maintained.
# rollup-plugin-url
Inline import files as data-URIs, or copy them to output
## Install
```sh
npm i --save-dev rollup-plugin-url
```
## Usage
```js
import {rollup} from "rollup"
import url from "rollup-plugin-url"
const writeoptions = {dest: "output/output.js"}
const plugin = url({
limit: 10 * 1024, // inline files < 10k, copy files > 10k
include: ["**/*.svg"], // defaults to .svg, .png, .jpg and .gif files
emitFiles: true // defaults to true
})
rollup({
entry: "main.js",
plugins: [plugin],
})
.then(bundle => bundle.write(writeoptions))
```
## Options
### limit
Optional. Type: `number`.
This is the file size limit to inline files. If files exceed this limit, they
will be copied instead to the destination folder and the hashed filename will
be given instead. If value set to `0` all files will be copied.
Defaults to 14336 (14kb).
### include / exclude
Optional. Type: a minimatch pattern, or array of minimatch patterns
These patterns determine which files are inlined. Defaults to .svg, .png, .jpg
and .gif files.
### publicPath
Optional. Type: `string`
The `publicPath` will be added in front of file names when they are not inlined
but copied.
### emitFiles
Optional. Type: `boolean`
The `emitFiles` option is used to run the plugin as you normally would but prevents any files being emitted. This is useful for when you are using rollup to emit both a client side and server side bundle.
### fileName
Optional. Type: `string`
When `emitFiles` is `true`, the `fileName` option can be used to rename the emitted files. It accepts the following string replacements:
- `[hash]` - The hash value of the file's contents
- `[name]` - The name of the imported file, without it's file extension
- `[extname]` - The extension of the imported file, including the leading `.`
- `[dirname]` - The parent directory name of the imported file, including trailing `/`
Defaults to: `"[hash][extname]"`
### sourceDir
Optional. Type: `string`
When using the `[dirname]` replacement in `fileName`, uses this directory as the source directory to create the file path from rather than the parent directory of the imported file. For example:
*src/path/to/file.js*
```js
import png from "./image.png";
```
*rollup.config.js*
```js
url({
fileName: "[dirname][hash][extname]",
sourceDir: path.join(__dirname, "src")
})
```
Emitted File: `path/to/image.png`
### destDir
Optional. Type: `string`
The destination dir to copy assets, usually used to rebase the assets according to HTML files.