unplugin-purge-polyfills

A tiny plugin to replace package imports with better native code.

This package is an unplugin which provides support for a wide range of bundlers.

At build time, it removes usage of these packages, in favour of directly using native replacements:

• is-number
• is-plain-object
• is-primitve
• is-regexp
• is-travis
• is-npm
• clone-regexp
• split-lines
• is-windows
• is-whitespace
• is-string
• is-odd
• is-even
• object.entries
• date
• array.of
• number.isnan
• array.prototype.findindex
• array.from
• object-is
• array-map
• is-nan
• function-bind
• regexp.prototype.flags
• array.prototype.find
• object-keys
• define-properties
• left-pad
• pad-left
• filter-array
• array-every
• index-of
• last-index-of
• abort-controller
• array-flatten
• array-includes
• has-own
• has-proto
• has-symbols
• object-assign

It is under active development.

Roadmap

• investigate tighter integration with https://github.com/SukkaW/nolyfill or https://github.com/es-tooling/module-replacements
• implement publish-on-demand infrastructure to apply this plugin to published packages

Usage

Install package:

# npm
npm install unplugin-purge-polyfills

import { purgePolyfills } from 'unplugin-purge-polyfills'

// rollup.config.js
export default {
  plugins: [
    purgePolyfills.rollup({ /* options */ }),
  ],
}

Configuration

By default this unplugin ships with a wide range of polyfills to get rid of, but you can disable these and add your own by providing a replacements object:

// rollup.config.js
export default {
  plugins: [
    purgePolyfills.rollup({
      replacements: {
        'is-string': false, /** do not provide this polyfill */
        /**
         * provide a custom polyfill for this import in your codebase
         * make sure this is correct for every usage
         */
        'node.extend': {
          default: '(obj1, obj2) => { ...obj2, ...obj1 }'
        }
      }
    }),
  ],
}

The following polyfills are not purged, so you might want to add your own code to do so:

• node.extend
• extend-shallow
• xtend
• defaults

Projects using or experimenting with unplugin-purge-polyfill

• nuxt/cli
• unjs/jiti

Credits

Thanks to https://github.com/es-tooling/module-replacements and https://github.com/esm-dev/esm.sh for polyfill data. ❤️

Inspiration from https://github.com/SukkaW/nolyfill. ❤️

💻 Development

• Clone this repository
• Enable Corepack using corepack enable
• Install dependencies using pnpm install
• Run interactive tests using pnpm dev

License

Made with ❤️

Published under MIT License.