Installations
npm install rollupScore
65
Supply Chain
100
Quality
98.8
Maintenance
100
Vulnerability
99.6
License
Releases
Contributors
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4){kind=avatar}
Developer
Module System
CommonJS, ESM
Statistics
25,382 Stars
5,773 Commits
1,528 Forks
258 Watching
32 Branches
413 Contributors
Updated on 20 Nov 2024
Bundle Size
388.76 kB
Minified
107.41 kB
Minified + Gzipped
Languages
JavaScript (76.61%)
TypeScript (19.56%)
Rust (3.74%)
HTML (0.09%)
Total Downloads
Cumulative downloads
Total Downloads
2,541,545,674
Last day
5.5%
5,440,512
Compared to previous day
Last week
5.4%
27,943,793
Compared to previous week
Last month
13.5%
114,125,903
Compared to previous month
Last year
63.9%
1,087,989,989
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
83
Optional Dependencies
19
Rollup
Overview
Rollup is a module bundler for JavaScript which compiles small pieces of code into something larger and more complex, such as a library or application. It uses the standardized ES module format for code, instead of previous idiosyncratic solutions such as CommonJS and AMD. ES modules let you freely and seamlessly combine the most useful individual functions from your favorite libraries. Rollup can optimize ES modules for faster native loading in modern browsers, or output a legacy module format allowing ES module workflows today.
Quick Start Guide
Install with npm install --global rollup. Rollup can be used either through a command line interface with an optional configuration file or else through its JavaScript API. Run rollup --help to see the available options and parameters. The starter project templates, rollup-starter-lib and rollup-starter-app, demonstrate common configuration options, and more detailed instructions are available throughout the user guide.
Commands
These commands assume the entry point to your application is named main.js, and that you'd like all imports compiled into a single file named bundle.js.
For browsers:
1# compile to a <script> containing a self-executing function 2rollup main.js --format iife --name "myBundle" --file bundle.js
For Node.js:
1# compile to a CommonJS module 2rollup main.js --format cjs --file bundle.js
For both browsers and Node.js:
1# UMD format requires a bundle name 2rollup main.js --format umd --name "myBundle" --file bundle.js
Why
Developing software is usually easier if you break your project into smaller separate pieces, since that often removes unexpected interactions and dramatically reduces the complexity of the problems you'll need to solve, and simply writing smaller projects in the first place isn't necessarily the answer. Unfortunately, JavaScript has not historically included this capability as a core feature in the language.
This finally changed with ES modules support in JavaScript, which provides a syntax for importing and exporting functions and data so they can be shared between separate scripts. Most browsers and Node.js support ES modules. However, Node.js releases before 12.17 support ES modules only behind the --experimental-modules flag, and older browsers like Internet Explorer do not support ES modules at all. Rollup allows you to write your code using ES modules, and run your application even in environments that do not support ES modules natively. For environments that support them, Rollup can output optimized ES modules; for environments that don't, Rollup can compile your code to other formats such as CommonJS modules, AMD modules, and IIFE-style scripts. This means that you get to write future-proof code, and you also get the tremendous benefits of...
Tree Shaking
In addition to enabling the use of ES modules, Rollup also statically analyzes and optimizes the code you are importing, and will exclude anything that isn't actually used. This allows you to build on top of existing tools and modules without adding extra dependencies or bloating the size of your project.
For example, with CommonJS, the entire tool or library must be imported.
1// import the entire utils object with CommonJS 2var utils = require('node:utils'); 3var query = 'Rollup'; 4// use the ajax method of the utils object 5utils.ajax('https://api.example.com?search=' + query).then(handleResponse);
But with ES modules, instead of importing the whole utils object, we can just import the one ajax function we need:
1// import the ajax function with an ES import statement 2import { ajax } from 'node:utils'; 3 4var query = 'Rollup'; 5// call the ajax function 6ajax('https://api.example.com?search=' + query).then(handleResponse);
Because Rollup includes the bare minimum, it results in lighter, faster, and less complicated libraries and applications. Since this approach is based on explicit import and export statements, it is vastly more effective than simply running an automated minifier to detect unused variables in the compiled output code.
Compatibility
Importing CommonJS
Rollup can import existing CommonJS modules through a plugin.
Publishing ES Modules
To make sure your ES modules are immediately usable by tools that work with CommonJS such as Node.js and webpack, you can use Rollup to compile to UMD or CommonJS format, and then point to that compiled version with the main property in your package.json file. If your package.json file also has a module field, ES-module-aware tools like Rollup and webpack will import the ES module version directly.
Contributors
This project exists thanks to all the people who contribute. [Contribute]. 
. If you want to contribute yourself, head over to the contribution guidelines.
Backers
Thank you to all our backers! 🙏 [Become a backer]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
Special Sponsor
TNG has been supporting the work of Lukas Taegert-Atkinson on Rollup since 2017.
License
Stable Version
The latest stable version of the package.
Stable Version
4.27.3
HIGH
3
6.4/10
Summary
DOM Clobbering Gadget found in rollup bundled scripts that leads to XSS
Affected Versions
< 2.79.2
Patched Versions
2.79.2
6.4/10
Summary
DOM Clobbering Gadget found in rollup bundled scripts that leads to XSS
Affected Versions
>= 3.0.0, < 3.29.5
Patched Versions
3.29.5
6.4/10
Summary
DOM Clobbering Gadget found in rollup bundled scripts that leads to XSS
Affected Versions
>= 4.0.0, < 4.22.4
Patched Versions
4.22.4
Reason
30 commit(s) and 14 issue activity found in the last 90 days -- score normalized to 10
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
branch protection is not maximal on development and all release branches
Details
- Info: 'allow deletion' disabled on branch 'master'
- Info: 'force pushes' disabled on branch 'master'
- Warn: 'branch protection settings apply to administrators' is disabled on branch 'master'
- Warn: required approving review count is 1 on branch 'master'
- Warn: codeowners review is not required on branch 'master'
- Info: status check found to merge onto on branch 'master'
- Info: PRs are required in order to make changes on branch 'master'
Reason
Found 8/23 approved changesets -- score normalized to 3
Reason
dependency not pinned by hash detected -- score normalized to 2
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:491: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:496: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:502: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:510: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:207: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:209: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:214: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:220: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:230: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:240: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:248: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:259: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:266: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:291: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:293: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:304: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:350: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:353: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:363: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:368: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:439: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:441: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:447: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:455: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:460: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-and-tests.yml:468: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/build-and-tests.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/clean-cache.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/clean-cache.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/performance-report.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/performance-report.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/performance-report.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/performance-report.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/performance-report.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/performance-report.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/performance-report.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/performance-report.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/performance-report.yml:90: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/performance-report.yml:101: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/performance-report.yml:106: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/performance-report.yml:114: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/performance-report.yml:124: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/performance-report.yml:131: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/performance-report.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:102: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:122: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/repl-artefacts.yml:127: update your workflow using https://app.stepsecurity.io/secureworkflow/rollup/rollup/repl-artefacts.yml/master?enable=pin
- Info: 0 out of 38 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 18 third-party GitHubAction dependencies pinned
- Info: 8 out of 8 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: jobLevel 'packages' permission set to 'write': .github/workflows/build-and-tests.yml:313
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/build-and-tests.yml:478
- Info: topLevel 'contents' permission set to 'read': .github/workflows/build-and-tests.yml:25
- Warn: no topLevel permission defined: .github/workflows/clean-cache.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/performance-report.yml:16
- Info: topLevel 'contents' permission set to 'read': .github/workflows/repl-artefacts.yml:16
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 19 are checked with a SAST tool
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
6.1
/10
Last Scanned on 2024-11-11
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More