webpack-runtime-analyzer

webpack-runtime-analyzer

Webpack 1.x/2.x plugin for analyzing internal processes, state and structure of bundles. Built on rempl.

Install

npm install webpack-runtime-analyzer --save-dev

Usage

• Add plugin to your webpack config:

var RuntimeAnalyzerPlugin = require('webpack-runtime-analyzer');

// ...

plugins.push(new RuntimeAnalyzerPlugin());

• Start rempl server:

rempl

Also, you can use the GUI to control rempl server.

• Start building in watch-mode (wabpack --watch or webpack-dev-server) then open http://localhost:8177/ in your browser to see UI.

Try the example to see how it works:

cd example
npm i
npm run dev

Key features

Dashboard

The list of the modules and the assets is always at hand.

Left list contains all modules that included in your bundle.

Right list contains building output (bundles, chunks, static, etc).

Dependency graph

Take a look at the dependencies of the modules and at the modules stats.

There are a few basic module types:

• normal - module that you are requiring with require(...)
• context - complex module that unites other modules when you are using require.context(...)

Some modules can be marked as entry. It means that this module is declared in entry-section in you webpack-config.

Module is separated by file types (scripts, templates, styles, etc). Every file type has a different color. You can see these colors at the nodes of graph or at the color-bar above the graph.

As well you can hover mouse cursor at the node of graph or at the color bar section and see additional module-info or file type statistic.

File size map

Look at the file map and find out why your bundle is so big.

Realtime analyzing

Analyzing process is performing in realtime.

Working with a huge bundles

In a huge bundles there are many modules that are useless for analyzing.

For example, look at the AST Explorer bundle:

In this case graph is not usable, moreover overloaded graph decreases rendering performance.

You can enable Hide 3rd party modules in the Options menu to hide modules that isn't requiring your project-modules.

So, modules list, graph and file map will be contain only modules that requiring your project-modules.

Hide 3rd party modules is enabled by default.

Webpack 1.x support

All features is working correctly with webpack 2.x and 1.x

Plugin config

If you don't want to use default plugin config, then you can specify your own config:

new RuntimeAnalyzerPlugin({
    ui: {
        script: fs.readFileSync('/path/to/ui/bundle.js', 'utf-8'), // packed UI bundle (js + html + css + etc...)
        url: 'http://localhost:8080' // or URL to UI
    }
});

In case ui.url and ui.script are specified then ui.url will be used.

UI customization

The UI built on basis.js framework.

• Make changes in src/ui
• Run npm run build to build the UI bundle

In the future you will may host and customize the UI at web server without building a bundle, but rempl does not support this feature at this moment.

License

MIT