https://github.com/vigneshshanmugam/perf-hints-plugin

Provide performance hints in webpack output
https://github.com/vigneshshanmugam/perf-hints-plugin

perf-hints performance webpack-plugin

Last synced: 30 days ago
JSON representation

Provide performance hints in webpack output

• Host: GitHub
• URL: https://github.com/vigneshshanmugam/perf-hints-plugin
• Owner: vigneshshanmugam
• License: mit
• Created: 2016-10-31T20:30:19.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-01T18:13:29.000Z (almost 8 years ago)
• Last Synced: 2024-10-06T06:06:42.746Z (about 1 month ago)
• Topics: perf-hints, performance, webpack-plugin
• Language: JavaScript
• Homepage:
• Size: 1.25 MB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# perf-hints-plugin

DEPRECATED ❌❌ - Please use the [webpack performance feature](https://webpack.js.org/configuration/performance/)

Webpack plugin that provides hints for Performance.

Attempt at providing warnings and errors while bundling JS/CSS in Webpack. Inspired from this [RFC](https://github.com/webpack/webpack/issues/3216).

### Features

+ Monolithic bundle size warnings.

![monolith](https://github.com/vigneshshanmugam/perf-hints-plugin/blob/master/images/monolith.png)

+ Code splitted bundles exceed given max size.

![code-split](https://github.com/vigneshshanmugam/perf-hints-plugin/blob/master/images/code-split.png)

## Install

```sh

npm i --save-dev perf-hints-plugin

```

```sh

yarn add -D perf-hints-plugin

```

## Usage

```js

// webpack.config.js

const PerfHintsPlugin = require("perf-hints-plugin");

module.exports = {

  entry: //...,

  output: //...,

  plugins: [

    new PerfHintsPlugin({

        hints: true,

        maxBundleSize: 200 // kB

    })

  ]

}

```

### Options

+ `hints` - Flag to Enable/Disable hints in the console. Default is `false`

+ `maxBundleSize` - for setting the performance budget. Expressed in kiloBytes. Default value is `250kB`