https://github.com/rollup/stream
🍣 Stream Rollup build results
https://github.com/rollup/stream
readable readable-stream rollup rollup-js rollupjs stream
Last synced: about 1 month ago
JSON representation
🍣 Stream Rollup build results
- Host: GitHub
- URL: https://github.com/rollup/stream
- Owner: rollup
- License: mit
- Created: 2019-12-22T04:03:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-14T05:12:53.000Z (over 1 year ago)
- Last Synced: 2025-04-14T00:13:13.835Z (about 1 month ago)
- Topics: readable, readable-stream, rollup, rollup-js, rollupjs, stream
- Language: TypeScript
- Homepage:
- Size: 405 KB
- Stars: 21
- Watchers: 7
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[cover]: https://codecov.io/gh/rollup/stream/branch/master/graph/badge.svg
[cover-url]: https://codecov.io/gh/rollup/stream
[tests]: https://img.shields.io/circleci/project/github/rollup/stream.svg
[tests-url]: https://circleci.com/gh/rollup/stream
[npm]: https://img.shields.io/npm/v/@rollup/stream
[npm-url]: https://www.npmjs.com/package/@rollup/stream
[size]: https://packagephobia.now.sh/badge?p=@rollup/stream
[size-url]: https://packagephobia.now.sh/result?p=@rollup/stream
[![tests][tests]][tests-url]
[![cover][cover]][cover-url]
[![npm][npm]][npm-url]
[![size][size]][size-url]
[](https://liberamanifesto.com)
# @rollup/stream
🍣 Stream Rollup build results
This package exists to provide a streaming interface for Rollup builds. This is useful in situations where a build system is working with [vinyl files](https://github.com/gulpjs/vinyl), such as [`gulp.js`](https://gulpjs.com/).
## Requirements
This plugin requires an [LTS](https://github.com/nodejs/Release) Node version (v8.0.0+) and Rollup v1.20.0+.
## Install
Using npm:
```console
npm install @rollup/stream --save-dev
```
## Usage
Assume a `src/index.js` file exists and contains code like the following:
```js
export default 'jingle bells, batman smells';
```
We can bundle `src/index.js` using streams such like:
```js
import rollupStream from '@rollup/stream';
const { log } = console;
const options = {
input: 'src/index.js',
output: { format: 'cjs' },
};
const stream = rollupStream(options);
let bundle = '';
stream.on('data', (data) => (bundle += data));
stream.on('end', () => log(bundle));
```
The preceding code will concatenate each chunk (or asset) and output the entire bundle's content when Rollup has completed bundling and the stream has ended.
## Options
All [Rollup options](https://www.rollupjs.org/guide/en/#configuration-files) are valid to pass as options to `@rollup/stream`.
### Usage with Gulp
Using Gulp requires piping. Suppose one wanted to take the bundle content and run it through a minifier, such as [`terser`](https://www.npmjs.com/package/terser):
```js
import rollupStream from '@rollup/stream';
import gulp from 'gulp';
import terser from 'gulp-terser';
import source from 'vinyl-source-stream';
gulp.task('rollup', () => {
const options = { input: 'src/index.js' };
return rollupStream(options)
.pipe(source('bundle.js'))
.pipe(terser({ keep_fnames: true, mangle: false }))
.pipe(gulp.dest('dist'));
});
```
### Using Sourcemaps
Rollup can produce source maps by specifying the `sourcemap` output option. For example; to use the generated sourcemaps with Gulp and `@rollup/stream`:
```js
import rollupStream from '@rollup/stream';
import buffer from 'vinyl-buffer';
import gulp from 'gulp';
import sourcemaps from 'gulp-sourcemaps';
import source from 'vinyl-source-stream';
gulp.task('rollup', () => {
const options = { input: 'src/index.js', output: { sourcemap: true } };
return rollupStream(options)
.pipe(source('bundle.js'))
.pipe(buffer())
.pipe(sourcemaps.init({ loadMaps: true }))
.pipe(sourcemaps.write('dist'))
.pipe(gulp.dest('dist'));
});
```
### Caching
The ability to cache a build is already [built into Rollup](https://www.rollupjs.org/guide/en/#cache), so users of `@rollup/stream` get that for free. Caching can be useful to reduce or optimize build times, and is often used when watching files that are part of a build. For example; to utilize caching with Gulp and `@rollup/stream`:
```js
import rollupStream from '@rollup/stream';
import buffer from 'vinyl-buffer';
import gulp from 'gulp';
import source from 'vinyl-source-stream';
// declare the cache variable outside of task scopes
let cache;
gulp.task('rollup', () => {
return rollupStream({
input: 'src/index.js',
// define the cache in Rollup options
cache,
})
.on('bundle', (bundle) => {
// update the cache after every new bundle is created
cache = bundle;
})
.pipe(source('bundle.js'))
.pipe(buffer())
.pipe(gulp.dest('dist'));
});
gulp.task('watch', (done) => {
gulp.watch('./src/**/*.js', gulp.series('rollup'));
// or, with Gulp v3
// gulp.watch('./src/**/*.js', ['rollup']);
done();
});
```
_(Example based on the [rollup-stream README](https://github.com/Permutatrix/rollup-stream#readme))_
## Meta
[CONTRIBUTING](/.github/CONTRIBUTING.md)
[LICENSE (MIT)](/LICENSE)