Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stephencookdev/speed-measure-webpack-plugin
⏱ See how fast (or not) your plugins and loaders are, so you can optimise your builds
https://github.com/stephencookdev/speed-measure-webpack-plugin
measure plugin speed stats timer webpack
Last synced: 2 days ago
JSON representation
⏱ See how fast (or not) your plugins and loaders are, so you can optimise your builds
- Host: GitHub
- URL: https://github.com/stephencookdev/speed-measure-webpack-plugin
- Owner: stephencookdev
- License: mit
- Created: 2018-01-27T11:19:00.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T08:06:39.000Z (over 1 year ago)
- Last Synced: 2024-10-29T15:01:08.787Z (about 1 month ago)
- Topics: measure, plugin, speed, stats, timer, webpack
- Language: JavaScript
- Homepage:
- Size: 1.94 MB
- Stars: 2,411
- Watchers: 14
- Forks: 79
- Open Issues: 78
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - speed-measure-webpack-plugin
- awesome-list - speed-measure-webpack-plugin
- awesome-f2e-libs - **speed-measure-webpack-plugin** - 统计 webpack 各阶段耗时。 (打包工具 / webpack 辅助工具、Loader 和插件)
- awesome-fe - **speed-measure-webpack-plugin** - 统计 webpack 各阶段耗时。 (打包工具 / webpack 辅助工具、Loader 和插件)
- awesome-star-libs - stephencookdev / speed-measure-webpack-plugin
README
Speed Measure Plugin
(for webpack)
The first step to optimising your webpack build speed, is to know where to focus your attention.
This plugin measures your webpack build speed, giving an output like this:
## Install
```bash
npm install --save-dev speed-measure-webpack-plugin
```
or
```bash
yarn add -D speed-measure-webpack-plugin
```
## Requirements
SMP requires at least **Node v6**. But otherwise, accepts **all webpack** versions (1, 2, 3, and 4).
## Usage
Change your webpack config from
```javascript
const webpackConfig = {
plugins: [new MyPlugin(), new MyOtherPlugin()],
};
```
to
```javascript
const SpeedMeasurePlugin = require("speed-measure-webpack-plugin");
const smp = new SpeedMeasurePlugin();
const webpackConfig = smp.wrap({
plugins: [new MyPlugin(), new MyOtherPlugin()],
});
```
and you're done! SMP will now be printing timing output to the console by default.
Check out the [examples folder](/examples) for some more examples.
## Options
Pass these into the constructor, as an object:
```javascript
const smp = new SpeedMeasurePlugin(options);
```
### `options.disable`
Type: `Boolean`
Default: `false`
If truthy, this plugin does nothing at all.
`{ disable: !process.env.MEASURE }` allows opt-in measurements with `MEASURE=true npm run build`.
### `options.outputFormat`
Type: `String|Function`
Default: `"human"`
Determines in what format this plugin prints its measurements
- `"json"` - produces a JSON blob
- `"human"` - produces a human readable output
- `"humanVerbose"` - produces a more verbose version of the human readable output
- If a function, it will call the function with the JSON blob, and output the response
### `options.outputTarget`
Type: `String|Function`
Default: `console.log`
- If a string, it specifies the path to a file to output to.
- If a function, it will call the function with the output as the first parameter
### `options.pluginNames`
Type: `Object`
Default: `{}`
By default, SMP derives plugin names through `plugin.constructor.name`. For some
plugins this doesn't work (or you may want to override this default). This option
takes an object of `pluginName: PluginConstructor`, e.g.
```javascript
const uglify = new UglifyJSPlugin();
const smp = new SpeedMeasurePlugin({
pluginNames: {
customUglifyName: uglify,
},
});
const webpackConfig = smp.wrap({
plugins: [uglify],
});
```
### `options.loaderTopFiles`
Type: `Number`
Default: `0`
You can configure SMP to include the files that take the most time per loader, when using `outputFormat: 'humanVerbose'`. E.g., to show the top 10 files per loader:
```javascript
const smp = new SpeedMeasurePlugin({
outputFormat: "humanVerbose",
loaderTopFiles: 10,
});
```
### `options.compareLoadersBuild`
Type: `Object`
Default: `{}`
This option gives you a comparison over time of the module count and time spent, per loader. This option provides more data when `outputFormat: "humanVerbose"`.
Given a required `filePath` to store the build information, this option allows you to compare differences to your codebase over time. E.g.
```javascript
const smp = new SpeedMeasurePlugin({
compareLoadersBuild: {
filePath: "./buildInfo.json",
},
});
```
### `options.granularLoaderData` _(experimental)_
Type: `Boolean`
Default: `false`
By default, SMP measures loaders in groups. If truthy, this plugin will give per-loader timing information.
This flag is _experimental_. Some loaders will have inaccurate results:
- loaders using separate processes (e.g. `thread-loader`)
- loaders emitting file output (e.g. `file-loader`)
We will find solutions to these issues before removing the _(experimental)_ flag on this option.
## FAQ
### What does general output time mean?
This tends to be down to webpack reading in from the file-system, but in general it's anything outside of what SMP can actually measure.
### What does modules without loaders mean?
It means vanilla JS files, which webpack can handle out of the box.
## Contributing
Contributors are welcome! 😊
Please check out the [CONTRIBUTING.md](./CONTRIBUTING.md).
## Migrating
SMP follows [semver](https://semver.org/). If upgrading a major version, you can consult [the migration guide](./migration.md).
## License
[MIT](/LICENSE)
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Stephen Cook
💻 📖 📝 🎨 💬 👀
scarletsky
💻
牛さん
💻 🐛
Thomas Bentkowski
📖
Alan Agius
💻 🐛
Ximing
💻 🐛
Tan Li Hau
💻 🐛 ⚠️
Björn Brauer
💻 🐛
Suraj Patel
💻
Jm
💻 🐛 ⚠️
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!