Skip to content

Latest commit

 

History

History
154 lines (112 loc) · 3.65 KB

README.md

File metadata and controls

154 lines (112 loc) · 3.65 KB

@gasket/plugin-analyze

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

Installation

npm i @gasket/plugin-analyze

Update your gasket file plugin configuration:

// gasket.js

+ import pluginAnalyze from '@gasket/plugin-analyze';

export default makeGasket({
  plugins: [
+   pluginAnalyze
  ]
});

Configuration

  • bundleAnalyzerConfig - (object) Configuration options for the Webpack bundle analyzer. Define settings for both browser and server bundles.
    • browser - (object) Options specific to the client-side bundle analysis. See plugin options.
    • server - (object) Options specific to the server-side bundle analysis. See plugin options.

This plugin uses webpack-bundle-analyzer and as such, all of its plugin options are available for tuning both browser and server analysis reports. These options are defined in the bundleAnalyzerConfig object in your gasket.js.

By default, the analyzeMode is set to static, meaning the analysis reports are generated as HTML files, and the reports are output to a reports directory at the root of the project.

Example

// gasket.js

export default makeGasket({
  bundleAnalyzerConfig: {
    browser: {
      defaultSizes: 'gzip' // Analyze the gzipped sizes of the bundles
    },
    server: {
      openAnalyzer: false // Do not automatically open the report in the browser
    }
  }
});

Default Configuration

If no bundleAnalyzerConfig is provided, the plugin defaults to generating both browser and server reports in the reports directory:

  • Browser reports: reports/browser-bundles.html
  • Server reports: reports/server-bundles.html

These paths can be customized in bundleAnalyzerConfig under reportFilename for each type of bundle (browser and server).

NPM script

Environment Variable

The npm script analyze will execute the following:

ANALYZE=1 next build

When this script is run, the @gasket/plugin-analyze will add the webpack-bundle-analyzer to the webpack config.

Reports for both browser and server-side rendering will be generated, with the following output:

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

Only when process.env.ANALYZE is set will the analyzer plugin be added to Webpack, ensuring that the bundle analyzer is used specifically for this analysis task.

Example Usage

To run the analyzer:

npm run analyze

The browser report will be most critical for analyzing bundle size optimizations, ensuring that the app is optimized for download efficiency from the user's perspective.

Gasket Environment

An alternative way to configure and enable the bundle analyzer is to loading the plugin dynamically, and use a sub environment.

// gasket.js

+ import pluginDynamicPlugins from '@gasket/plugin-dynamic-plugins';

export default makeGasket({
  plugins: [
+   pluginDynamicPlugins
  ],
  dynamicPlugins: {
    'local.analyze': {
      plugins: [
        '@gasket/plugin-analyze'
      ]
    }
  }
});

In your package.json, update the analyze npm script

{
  "scripts": {
-    "analyze": "ANALYZE=1 next build"
+    "analyze": "GASKET_ENV=local.analyze next build"
  }
}

This can server as an optimization so that the plugin will only be loaded for the local.analyze environment, and will allow you to change @gasket/plugin-analyze to be a dev dependency.

License

MIT