Skip to content

README.md

Latest commit

 

History

History
86 lines (62 loc) · 2.02 KB

README.md

File metadata and controls

86 lines (62 loc) · 2.02 KB

@gasket/plugin-analyze

Gasket plugin for building analysis reports of webpack bundles using webpack-bundle-analyzer.

Installation

New apps

gasket create <app-name> --plugins @gasket/plugin-analyze

Existing apps

npm i @gasket/plugin-analyze

Modify plugins section of your gasket.config.js:

module.exports = {
  plugins: {
    add: [
+      '@gasket/plugin-analyze'
    ]
  }
}

Configuration

This plugin utilizes webpack-bundle-analyzer and as such, all of it's plugin options are available for tuning for both both browser and server analysis reports. Do so by setting the bundleAnalyzerConfig property in the gasket.config.js. The analyze plugin defaults analyzeMode to static, and outputs the reports to a reports dir at the root of the project.

Example

// gasket.config.js

module.exports = {
  bundleAnalyzerConfig: {
    browser: {
      defaultSizes: 'gzip'
    },
    server: {
      openAnalyzer: false
    }
  }
}

Commands

analyze command

The command gasket analyze will execute the build lifecycle.

Only when this command is run, will the plugin add webpack-bundle-analyzer to the webpack config. By default, generated reports are output to a reports dir at the root of the project.

If using a UI framework such as Next.js which runs webpack for for both browser and server-side rendering, two reports will be outputted:

  • reports/browser-bundles.html
  • reports/server-bundles.html

The browser report will be the most critical for analysis in order to make sure an app is bundled in a way that is most optimal for users to download.

License

MIT