@xfe-team/webpack-build-report-enhance NPM

@xfe-team/webpack-build-report-enhance

Installation

NPM

npm i @xfe-team/webpack-build-report-enhance --save-dev

Example

webpack.config.js

// Import the plugin
const BuildReportPlugin = require('@xfe-team/webpack-build-report-enhance')

// Let's say you build a library of React components. you build them one by one
const components = fs.readdirSync(`${SRC_DIR}/components/`)
const entries = {}

components.forEach(component => {
  const name = component.split('.')[0]
  entries[name] = `${SRC_DIR}/components/${name}`
})

// Add the plugin to your webpack config
const config = {
  entry: entries,
  plugins: [
    // other plugins ...,
    new BuildReportPlugin({
      assets: true,
      output: `${SRC_DIR}/doc/build-report.md`,
      ...
    })
  ]
}

// ...

module.exports = config

Configuration options

Option	Type	Default value	Description
append	bool	false	Appends the report to an existing `.md` file, based on the `output` option
assets	bool	true	Adds the assets stats to the final report
output	string	'build-report.md'	Tell the plugin where you want your report to be saved. Must be an `.md` file !
saveStats	bool	false	Saves the complete build stats in `.build-stats.json`, and allow your report to show comparisons to the last build