https://github.com/hijiangtao/build-time-analysis-webpack-plugin

A webpack plugin that output the build time file by file as a JSON format with filters
https://github.com/hijiangtao/build-time-analysis-webpack-plugin

Last synced: 5 months ago
JSON representation

A webpack plugin that output the build time file by file as a JSON format with filters

• Host: GitHub
• URL: https://github.com/hijiangtao/build-time-analysis-webpack-plugin
• Owner: hijiangtao
• License: mit
• Created: 2019-12-01T06:17:33.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-12-05T02:01:22.000Z (almost 6 years ago)
• Last Synced: 2025-04-22T12:08:00.639Z (6 months ago)
• Language: JavaScript
• Size: 5.86 KB
• Stars: 11
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# build-time-analysis-webpack-plugin

A webpack plugin that output the build time file by file as a JSON format with filters

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/c913db53b5a3470f840f5329ea2f54d4)](https://www.codacy.com/app/hijiangtao/build-time-analysis-webpack-plugin?utm_source=github.com&utm_medium=referral&utm_content=hijiangtao/build-time-analysis-webpack-plugin&utm_campaign=badger)

[![npm](https://img.shields.io/npm/v/build-time-analysis-webpack-plugin.svg)](https://www.npmjs.com/package/build-time-analysis-webpack-plugin)

[![Github All Releases](https://img.shields.io/github/downloads/hijiangtao/build-time-analysis-webpack-plugin/total.svg)](https://github.com/hijiangtao/build-time-analysis-webpack-plugin/releases)

[![npm](https://img.shields.io/npm/dt/build-time-analysis-webpack-plugin.svg)](https://www.npmjs.com/package/build-time-analysis-webpack-plugin)

[![GitHub contributors](https://img.shields.io/github/contributors/hijiangtao/build-time-analysis-webpack-plugin.svg)]() 

[![GitHub issues](https://img.shields.io/github/issues/hijiangtao/build-time-analysis-webpack-plugin.svg)](https://github.com/hijiangtao/build-time-analysis-webpack-plugin/issues) 

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hijiangtao/build-time-analysis-webpack-plugin/pulls) 

[![license](https://img.shields.io/github/license/hijiangtao/build-time-analysis-webpack-plugin.svg)](https://github.com/hijiangtao/build-time-analysis-webpack-plugin/blob/master/LICENSE) 

[![NPM](https://nodei.co/npm/build-time-analysis-webpack-plugin.png)](https://nodei.co/npm/build-time-analysis-webpack-plugin/)

## How to write a webpack plugin (Chinese)

* Blog 

* Zhihu 

## USAGE

Install the plugin via `npm` or `yarn`:

```shell

npm install --save-dev build-time-analysis-webpack-plugin

// or 

yarn add build-time-analysis-webpack-plugin --dev

```

Then require it in your `webpack.config.js`:

```javascript

const ModuleBuildTimeCalWebpackPlugin = require('build-time-analysis-webpack-plugin');

module.exports = {

  plugins: [

    new ModuleBuildTimeCalWebpackPlugin({

     filename: 'modules.json',

     includeNodeModules: false,

     callback: () => {},

   }),

  ]

};

```

Then you can pack your codes via commands such as `npm run build`, plugin's result will be output to `modules.json` file by default (however, you can customize it via `options` that passed to plugin constructor). The output JSON format is something like this:

```json

{

  'src/index.js': {

    name: 'src/index.js',

    start: 1,

    end: 4,

    time: 3,

    loaders: [ ... ]

  },

  ...

}

```

## API

### filename [String, optional]

A string with file extension, The filename that you want plugin output the result to, default to `modules.json`.

### includeNodeModules [Boolean, optional]

Whether to include the build time result of files inside `node_modules`, default to `false`.

### callback [Function, optional] 

The callback handler you want plugin called after resolve all process (correspondind lifecycle should be `compilation.hooks.finishModules`), default to `() => {}`.

## CONTACT

@hijiangtao

## LICENSE

MIT