https://github.com/sghall/bundle-inspector-webpack-plugin
Bundle Inspector | Analysis Tool for Webpack
https://github.com/sghall/bundle-inspector-webpack-plugin
analysis bundle javascript tools webpack webpack-plugin
Last synced: 14 days ago
JSON representation
Bundle Inspector | Analysis Tool for Webpack
- Host: GitHub
- URL: https://github.com/sghall/bundle-inspector-webpack-plugin
- Owner: sghall
- License: mit
- Created: 2017-07-20T02:22:29.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-08T02:40:59.000Z (over 7 years ago)
- Last Synced: 2025-04-01T04:32:53.189Z (24 days ago)
- Topics: analysis, bundle, javascript, tools, webpack, webpack-plugin
- Language: JavaScript
- Homepage: https://sghall.github.io/bundle-inspector-webpack-plugin/#/
- Size: 5.62 MB
- Stars: 18
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## bundle-inspector-webpack-plugin
Under development. Feedback welcome.
## See a [demo in your browser](https://sghall.github.io/bundle-inspector-webpack-plugin/#/) - NOT mobile friendly
## CLI:
```
npm install -g bundle-inspector-webpack-plugin
```
Basic usage:
```
bundle-inspector-webpack-plugin /path/to/webpack/stats.json
```
How do I get JSON stats from webpack?
```
webpack --json > stats.json
```
See a demo:
```
bundle-inspector-webpack-plugin --demo
```
## Webpack Plugin:
```
npm install bundle-inspector-webpack-plugin --save-dev
```
### CJS Import:
```
const BundleInspector = require('bundle-inspector-webpack-plugin');
// Add it to the plugins in your webpack config...
// ...
plugins: [new BundleInspector()]
// ...
```
### ES6 Import:
```
import BundleInspector from 'bundle-inspector-webpack-plugin';
// Add it to the plugins in your webpack config...
// ...
plugins: [new BundleInspector()]
// ...
```
The server listens via websockets so it will update as you're developing.
The 3D graph can be resource intensive, so it may be better to keep it on the treemap while your working.
It will refresh to the page you're currently on each time webpack updates.
## Shoutouts
Uses the data processing from the awesome [Webpack Bundle Analyzer](https://github.com/th0r/webpack-bundle-analyzer).
The app is built using [Create React App](https://github.com/facebookincubator/create-react-app).
Lot of ideas and inspiration from [Bundle Buddy](https://github.com/samccone/bundle-buddy).
## Data Views:
### 3D Force Directed Graph
Uses:
[d3-force-3d](https://github.com/vasturiano/d3-force-3d) - 3D layout
[three.js](https://github.com/mrdoob/three.js/) - JavaScript WebGL
[subunit](https://github.com/sghall/subunit) - WebGL Selections
### Zoomable Treemap
Uses:
[d3](https://github.com/vasturiano/d3-force-3d) - Data Visualization Library
Uses the [zoomable treemaps](https://bost.ocks.org/mike/treemap/) concept by Mike Bostock.
## Screenshots:
## Roadmap
It's early days for this project. Lots of work to be done on the visualizations to make them more helpful.
Have a suggestion/idea/comment/criticism? Open an issue.
Logo image created by Oksana Latysheva from the [Noun Project](https://thenounproject.com/)