rollup-plugin-visualizer
Advanced tools
Package description
The rollup-plugin-visualizer is a plugin for Rollup that generates a visual representation of the module tree or bundle contents. It helps in analyzing the bundle's composition, such as the size of individual modules and their dependencies. This can be particularly useful for optimizing the bundle size by identifying large modules or unexpected dependencies.
Visualizing bundle composition
This feature allows users to visualize the composition of their bundle. The plugin generates an HTML file that displays the sizes of the modules in the bundle. The 'filename' option specifies the output file for the visualization, and the 'open' option can be set to true to automatically open the generated file in a web browser.
import visualizer from 'rollup-plugin-visualizer';
export default {
plugins: [
visualizer({
filename: './bundle-stats.html',
open: true
})
]
};Customizing the visualization
This feature allows for customization of the visualization output. Users can choose between different visualization templates such as 'treemap', 'sunburst', or 'network'. Additionally, the title of the visualization can be customized using the 'title' option.
import visualizer from 'rollup-plugin-visualizer';
export default {
plugins: [
visualizer({
filename: './bundle-stats.html',
template: 'treemap', // or 'sunburst', 'network'
title: 'My Bundle Visualization'
})
]
};Similar to rollup-plugin-visualizer, webpack-bundle-analyzer is a plugin for Webpack that provides a detailed visualization of the contents of bundles. It supports interactive zoomable treemaps for analyzing the size of webpack output files. While rollup-plugin-visualizer is tailored for Rollup, webpack-bundle-analyzer serves a similar purpose for Webpack bundles.
Source-map-explorer analyzes JavaScript bundles using the source maps. It helps in understanding where code bloat is coming from by generating a treemap visualization of the space that each source file occupies. Unlike rollup-plugin-visualizer which is a Rollup plugin, source-map-explorer can be used independently of the bundler used.
Changelog
5.3.4
Readme
Visualize and analyze your Rollup bundle to see which modules are taking up space.
npm install --save-dev rollup-plugin-visualizer
or via yarn:
yarn add --dev rollup-plugin-visualizer
Version V5 contains seveal minor breaking changes, depending your current installation take such steps before upgrade:
gzipLength or brotliLengthupgrade to rollup 2.44 at least. In V5 i use provided by rollup api to get rendered module code for size estimations, instead of original sources as it was before.To upgrade plugin change import/require statement like it is shown in installation section.
Es imports:
import { visualizer } from 'rollup-plugin-visualizer';
//...
plugins: [
// other plugins
// ....
//
visualizer()
],
//...
Cjs require:
const { visualizer } = require('rollup-plugin-visualizer');
//...
plugins: [
// other plugins
// ....
//
visualizer()
],
//...
filename (string, default stats.html) - name of the file with diagram to generate
title (string, default Rollup Visualizer) - title tag value
sourcemap (boolean, default false) - Use sourcemaps to calculate sizes (e.g. after UglifyJs or Terser). Always add plugin as last option.
open (boolean, default false) - Open generated file in default user agent
template (string, default treemap) - Which diagram type to use: sunburst, treemap, network.
json (boolean, default false) - Produce portable json file that can be used with plugin CLI util to generate graph from several json files. Every UI property ignored in this case.
gzipSize (boolean, default false) - Collect gzip size from source code and display it at chart.
brotliSize (boolean, default false) - Collect brotli size from source code and display it at chart.
projectRoot (string | RegExp, default process.cwd()) - This is some common root(s) path to your files. This is used to cut absolute files paths out.
This plugin provides cli util rollup-plugin-visualizer. Add --help to check actual options. It can be used like:
rollup-plugin-visualizer [OPTIONS] stat1.json stat2.json ../stat3.json
This can be usefull in case you have different config files in the same project and you want to display all of them in the same chart.
For development if you need to build plugin, just exec:
npm run build
Generated html files do not and never will contain your source code (contents of files). They can contain only js/html/css code required to build chart (plugin code) and statistical information about your source code.
This statistical information can contain:
See CHANGELOG.md.
FAQs
[](https://npmjs.org/package/rollup-plugin-visualizer) [](https://github.com/btd
The npm package rollup-plugin-visualizer receives a total of 1,017,532 weekly downloads. As such, rollup-plugin-visualizer popularity was classified as popular.
We found that rollup-plugin-visualizer demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.