Giter VIP home page Giter VIP logo

build-profiler-webpack-plugin's Introduction

build-profiler-webpack-plugin

Overview

A Webpack plugin for getting useful statistics and feedback of your build with threshold and failure options. The advantage being that this plugin will profile your build so that you can be alerted to issues / mistakes in a Webpack configuration like:

  • The build being too big
  • The build being too small
  • Statistics of the build's composition (percantage of JS / CSS / images, etc)
  • Other options TBD

Install

npm install webpack-build-profiler --save-dev

Usage

If you have a production config, include this plugin there

plugins: [
  
  new BuildProfilerPlugin({
    //your options here
  }),

Sample output

== Build Composition ==
JavaScript: 0.8MB
CSS: 0.2MB
Images: 0.5MB

== Build Profile ==
Speed Treshold: 2m
Size Threshold: 1MB - 2MB

Total Bundle Size: 1.5MB
Total Time To Build: 1.56 minutes

== Final Status == 
Success (all metrics within threshold)

Options

{
  timeTreshold:  120,  //# of seconds
  buildSizeTreshold:  {  //in MB
    min:  1,
    max:  2
  },
  buildCompositionTreshold: {  //in MB
    javascript: 1,
    css: 1,
    image: 1
  }
}

LICENSE

Copyright 2017 Owen Buckley

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

build-profiler-webpack-plugin's People

Contributors

thescientist13 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

build-profiler-webpack-plugin's Issues

create a POC implementation / fixture demonstrating integration with Webpack

About Webpack Plugins
https://webpack.github.io/docs/plugins.html

Here is a guide from Webpack about how to create plugins
https://webpack.github.io/docs/how-to-write-a-plugin.html

In particular for this package, it seems the compilation object is what we are interested in

A compilation object represents a single build of versioned assets. ... A compilation surfaces information about the present state of module resources, compiled assets, changed files, and watched dependencies.

Additional resources

Looks like there are two components to testing Webpack Plugins

  1. Testing the class / plugin itself
  2. Testing cases (actually using fixtures and integrating within webpack configurations)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.