Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow selectively including polyfills #30

Merged
merged 14 commits into from
Jun 24, 2022
13 changes: 8 additions & 5 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { MergeExclusive } from "type-fest"
import { Compiler } from "webpack"

declare namespace NodePolyfillPlugin {
Expand Down Expand Up @@ -34,13 +35,15 @@ declare namespace NodePolyfillPlugin {
| "vm"
| "zlib"

export interface Options {
/**
By default, the modules that were polyfilled in Webpack 4 are mirrored over. However, if you don't want a module like console to be polyfilled you can specify alises to be skipped here.
*/
interface Include {
rjerue marked this conversation as resolved.
Show resolved Hide resolved
includeAliases?: readonly Alias[]
}

interface Exclude {
rjerue marked this conversation as resolved.
Show resolved Hide resolved
excludeAliases?: readonly Alias[]
includeAliases?: readonly Alias[]
}

export type Options = MergeExclusive<Include, Exclude>
rjerue marked this conversation as resolved.
Show resolved Hide resolved
}

declare class NodePolyfillPlugin {
Expand Down
22 changes: 14 additions & 8 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,27 @@
const { ProvidePlugin } = require("webpack")
const filterObject = require("filter-obj")

const filterObjectKeys = (object, keys, isInclude) => filterObject(object, key => keys.includes(key) === isInclude)
const filterObjectKeys = (includeAliases, excludeAliases) => {
rjerue marked this conversation as resolved.
Show resolved Hide resolved
rjerue marked this conversation as resolved.
Show resolved Hide resolved
const isInclude = includeAliases.length > 0
const keys = isInclude ? includeAliases : excludeAliases
return object => filterObject(object, key => keys.includes(key) === isInclude)
}

module.exports = class NodePolyfillPlugin {
constructor({ excludeAliases = [], includeAliases = [] } = {}) {
if (includeAliases.length > 0 && excludeAliases.length > 0) {
throw new Error("excludeAliases and includeAliases are mutually exclusive!")
constructor(options = {}) {
this.options = {
excludeAliases: [],
includeAliases: [],
...options
}

this.options = { excludeAliases, includeAliases }
if (this.options.includeAliases.length > 0 && this.options.excludeAliases.length > 0) {
throw new Error("excludeAliases and includeAliases are mutually exclusive!")
rjerue marked this conversation as resolved.
Show resolved Hide resolved
}
}

apply(compiler) {
const isInclude = this.options.includeAliases.length > 0
const keys = isInclude ? this.options.includeAliases : this.options.excludeAliases
const filterFunc = object => filterObjectKeys(object, keys, isInclude)
const filterFunc = filterObjectKeys(this.options.includeAliases, this.options.excludeAliases)
rjerue marked this conversation as resolved.
Show resolved Hide resolved

compiler.options.plugins.push(new ProvidePlugin(filterFunc({
Buffer: [require.resolve("buffer/"), "Buffer"],
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"string_decoder": "^1.3.0",
"timers-browserify": "^2.0.12",
"tty-browserify": "^0.0.1",
"type-fest": "^2.13.1",
"url": "^0.11.0",
"util": "^0.12.4",
"vm-browserify": "^1.1.2"
Expand Down
2 changes: 2 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ module.exports = {

Type: `object`

The `excludeAliases` and `includeAliases` key are mutally exclusive.
rjerue marked this conversation as resolved.
Show resolved Hide resolved

#### excludeAliases

By default, the modules that were polyfilled in Webpack 4 are mirrored over. However, if you don't want a module like `console` to be polyfilled you can specify alises to be skipped here.
Expand Down