Skip to content

Financial-Times/disable-tree-shaking-for-chunk-plugin

main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Disable Tree Shaking For Chunk Plugin

GitHub license Build Status npm version

This plugin for Webpack 5 can disable tree shaking for all modules contained in specified chunks. It is intended to help improve long-term caching and code reuse between project installations and builds.

Installation

This is a Node.js module available through the npm registry. Node 8 and Webpack 4.38 or higher are required.

Installation is done using the npm install command:

$ npm install --save-dev disable-tree-shaking-for-chunk-plugin

Once installed the plugin can be added to your Webpack plugins configuration:

const DisableTreeShakingForChunk = require('disable-tree-shaking-for-chunk-plugin')

module.exports = {
  //...
  plugins: [
    new DisableTreeShakingForChunk({
      test: 'chunk-name'
    })
  ]
}

Options

test (string, RegExp, Function, Array, Set)

Matches the chunk name. It may be a string matched with strict equality, a regular expression for more complex string matching, a function which will receive the chunk name as an argument and should return a boolean, or an array or set of strings.

Example

Below demonstrates part of a Webpack configuration file which sets up code splitting for a project. It has one cache group defined which will create a separate chunk for each package defined in the array.

const DisableTreeShakingForChunk = require('disable-tree-shaking-for-chunk-plugin')

const commonLibraries = ['react', 'redux', 'regenerator-runtime']

module.exports = {
  optimization: {
    splitChunks: {
      cacheGroups: {
        commonLibraries: {
          test(module) {
            const packageName = getPackageName(module.context)
            return packageName ? commonLibraries.includes(packageName) : false
          },
          name(module) {
            return getPackageName(module.context)
          }
        }
      }
    }
  },
  plugins: [
    new DisableTreeShakingForChunk({
      test: commonLibraries
    })
  ]
}

Motivation

By default when running Webpack in production mode it will try to track the properties exported by JavaScript modules and flag when the module is imported and which of those properties is used. It's this clever tracking of "used exports" that enables tree shaking by "pruning" any unused properties. Usually, this is a useful feature as it enables us to ship less code to our users but for cases where we'd like our compiled code to be cached for a long time or be reused by separate applications we need to disable it because how the module may be used over time and by different apps is unknown.

Prior Art

This plugin is based upon Webpack's internal FlagInitialModulesAsUsedPlugin by Tobias Koppers.

Development

This project uses Prettier for automatic code formatting and is tested with Jasmine.

License

This package is MIT licensed.

About

🌲 A Webpack plugin to disable tree shaking for all JS modules in the specified chunks.

Resources

License

Stars

Watchers

Forks

Packages

No packages published