@rushstack/webpack-preserve-dynamic-require-plugin 0.9.0

package/README.md

@@ -0,0 +1,11 @@
+# @rushstack/webpack-preserve-dynamic-require-plugin
+
+## Overview
+
+This Webpack plugin instructs webpack to leave dynamic usage of `require` as-is in the bundled code. For example, if your code contains:
+```js
+function requireSomeUserThing(path) {
+  return require(path);
+}
+```
+The emitted bundle will preserve the call to `require(path)` instead of trying to process it.

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.23.0"
+    }
+  ]
+}

package/dist/webpack-preserve-dynamic-require-plugin.d.ts

@@ -0,0 +1,10 @@
+import type * as webpack from 'webpack';
+
+/**
+ * @public
+ */
+export declare class PreserveDynamicRequireWebpackPlugin {
+    apply(compiler: webpack.Compiler): void;
+}
+
+export { }

package/lib/index.d.ts

@@ -0,0 +1,8 @@
+import type * as webpack from 'webpack';
+/**
+ * @public
+ */
+export declare class PreserveDynamicRequireWebpackPlugin {
+    apply(compiler: webpack.Compiler): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,OAAO,MAAM,SAAS,CAAC;AAIxC;;GAEG;AACH,qBAAa,mCAAmC;IACvC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI;CAwB/C"}

package/lib/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PreserveDynamicRequireWebpackPlugin = void 0;
+const PLUGIN_NAME = 'PreserveDynamicRequireWebpackPlugin';
+/**
+ * @public
+ */
+class PreserveDynamicRequireWebpackPlugin {
+    apply(compiler) {
+        compiler.hooks.thisCompilation.tap(PLUGIN_NAME, (compilation) => {
+            function processDependencies(block) {
+                const { dependencies } = block;
+                for (let i = dependencies.length - 1; i >= 0; i--) {
+                    const dep = dependencies[i];
+                    // Disable processing of dynamic require
+                    if (dep.constructor.name === 'CommonJsRequireContextDependency') {
+                        dependencies.splice(i, 1);
+                    }
+                }
+                for (const child of block.blocks) {
+                    processDependencies(child);
+                }
+            }
+            compilation.hooks.succeedModule.tap(PLUGIN_NAME, (mod) => {
+                processDependencies(mod);
+            });
+        });
+    }
+}
+exports.PreserveDynamicRequireWebpackPlugin = PreserveDynamicRequireWebpackPlugin;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,MAAM,WAAW,GAA0C,qCAAqC,CAAC;AAEjG;;GAEG;AACH,MAAa,mCAAmC;IACvC,KAAK,CAAC,QAA0B;QACrC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,WAAgC,EAAE,EAAE;YACnF,SAAS,mBAAmB,CAC1B,KAAsE;gBAEtE,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,CAAC;gBAC/B,KAAK,IAAI,CAAC,GAAW,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;oBACzD,MAAM,GAAG,GAAuB,YAAY,CAAC,CAAC,CAAC,CAAC;oBAChD,wCAAwC;oBACxC,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,KAAK,kCAAkC,EAAE;wBAC/D,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;qBAC3B;iBACF;gBAED,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE;oBAChC,mBAAmB,CAAC,KAAK,CAAC,CAAC;iBAC5B;YACH,CAAC;YAED,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAmB,EAAE,EAAE;gBACvE,mBAAmB,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAzBD,kFAyBC","sourcesContent":["import type * as webpack from 'webpack';\n\nconst PLUGIN_NAME: 'PreserveDynamicRequireWebpackPlugin' = 'PreserveDynamicRequireWebpackPlugin';\n\n/**\n * @public\n */\nexport class PreserveDynamicRequireWebpackPlugin {\n  public apply(compiler: webpack.Compiler): void {\n    compiler.hooks.thisCompilation.tap(PLUGIN_NAME, (compilation: webpack.Compilation) => {\n      function processDependencies(\n        block: Pick<webpack.AsyncDependenciesBlock, 'dependencies' | 'blocks'>\n      ): void {\n        const { dependencies } = block;\n        for (let i: number = dependencies.length - 1; i >= 0; i--) {\n          const dep: webpack.Dependency = dependencies[i];\n          // Disable processing of dynamic require\n          if (dep.constructor.name === 'CommonJsRequireContextDependency') {\n            dependencies.splice(i, 1);\n          }\n        }\n\n        for (const child of block.blocks) {\n          processDependencies(child);\n        }\n      }\n\n      compilation.hooks.succeedModule.tap(PLUGIN_NAME, (mod: webpack.Module) => {\n        processDependencies(mod);\n      });\n    });\n  }\n}\n"]}

package/lib/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/lib/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/lib/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;;;;AAAA,IAAI,CAAC,eAAe,EAAE,CAAC;AACvB,sDAA8B;AAE9B,mCAA8D;AAE9D,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AAErB,QAAQ,CAAC,2CAAmC,CAAC,IAAI,EAAE,GAAG,EAAE;IACtD,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,OAAO,GAAwB,IAAI,GAAG,EAAE,CAAC;QAC/C,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACjD,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,iCAAiC,CAAC,CAAC;QAE3D,MAAM,QAAQ,GAAqB,IAAA,iBAAO,EAAC;YACzC,KAAK,EAAE;gBACL,IAAI,EAAE,UAAU;aACjB;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE,WAAW;aACtB;YACD,OAAO,EAAE,GAAG;YACZ,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,CAAC,IAAI,2CAAmC,EAAE,CAAC;SACrD,CAAC,CAAC;QAEH,MAAM,OAAO,GAAoC;YAC/C,QAAQ,CAAC,IAAY,EAAE,EAAuE;gBAC5F,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,CAAC,IAAY,EAAE,EAAuE;gBAC3F,EAAE,CACA,SAAS,EACT,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAC1D,CAAC;YACJ,CAAC;YACD,QAAQ,CAAC,IAAY,EAAE,EAAoE;gBACzF,EAAE,EAAE,CAAC;YACP,CAAC;YACD,IAAI,CAAC,IAAY,EAAE,EAAyD;gBAC1E,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;oBACrB,OAAO,EAAE,CAAC,SAAS,EAAE;wBACnB,MAAM;4BACJ,OAAO,IAAI,CAAC;wBACd,CAAC;wBACD,WAAW;4BACT,OAAO,KAAK,CAAC;wBACf,CAAC;qBACF,CAAC,CAAC;iBACJ;qBAAM,IAAI,IAAI,KAAK,GAAG,EAAE;oBACvB,OAAO,EAAE,CAAC,SAAS,EAAE;wBACnB,MAAM;4BACJ,OAAO,KAAK,CAAC;wBACf,CAAC;wBACD,WAAW;4BACT,OAAO,IAAI,CAAC;wBACd,CAAC;qBACF,CAAC,CAAC;iBACJ;gBACD,EAAE,CAAC,IAAI,KAAK,CAAC,4BAA4B,IAAI,EAAE,CAAC,CAAC,CAAC;YACpD,CAAC;SAC4C,CAAC;QAEhD,MAAM,OAAO,GAAwB,IAAI,GAAG,EAAE,CAAC;QAE/C,MAAM,QAAQ,GAAqC;YACjD,KAAK,CAAC,IAAY,EAAE,EAAyC;gBAC3D,EAAE,EAAE,CAAC;YACP,CAAC;YACD,IAAI,CAAC,IAAY,EAAE,EAAyC;gBAC1D,MAAM,GAAG,GAA0B,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;gBAC7D,GAAG,CAAC,IAAI,GAAG,QAAQ,CAAC;gBACpB,EAAE,CAAC,GAAG,CAAC,CAAC;YACV,CAAC;YACD,SAAS,CAAC,IAAY,EAAE,OAAe,EAAE,EAAyC;gBAChF,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC5C,EAAE,EAAE,CAAC;YACP,CAAC;SAC6C,CAAC;QAEjD,QAAQ,CAAC,eAAe,GAAG,OAAO,CAAC;QACnC,QAAQ,CAAC,gBAAgB,GAAG,QAAQ,CAAC;QAErC,MAAM,IAAI,OAAO,CAAO,CAAC,OAAmB,EAAE,MAA4B,EAAE,EAAE,CAC5E,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAkB,EAAE,EAAE;YAClC,IAAI,GAAG,EAAE;gBACP,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;aACpB;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CACH,CAAC;QAEF,MAAM,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,CAAC;IACpC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["jest.disableAutomock();\nimport webpack from 'webpack';\n\nimport { PreserveDynamicRequireWebpackPlugin } from './index';\n\njest.setTimeout(1e9);\n\ndescribe(PreserveDynamicRequireWebpackPlugin.name, () => {\n  it('Preserves dynamic require usage', async () => {\n    const sources: Map<string, string> = new Map();\n    sources.set('/package.json', JSON.stringify({}));\n    sources.set('/file.js', 'require(process.env.SOME_PATH);');\n\n    const compiler: webpack.Compiler = webpack({\n      entry: {\n        main: '/file.js'\n      },\n      output: {\n        path: '/release',\n        filename: '[name].js'\n      },\n      context: '/',\n      mode: 'none',\n      plugins: [new PreserveDynamicRequireWebpackPlugin()]\n    });\n\n    const inputFs: typeof compiler.inputFileSystem = {\n      readFile(path: string, cb: (err?: NodeJS.ErrnoException | undefined, content?: string) => void): void {\n        cb(undefined, sources.get(path));\n      },\n      readdir(path: string, cb: (err?: NodeJS.ErrnoException | undefined, files?: string[]) => void): void {\n        cb(\n          undefined,\n          Array.from(sources.keys(), (key: string) => key.slice(1))\n        );\n      },\n      readlink(path: string, cb: (err?: NodeJS.ErrnoException | undefined, dest?: string) => void): void {\n        cb();\n      },\n      stat(path: string, cb: (err?: NodeJS.ErrnoException, stat?: unknown) => void): void {\n        if (sources.has(path)) {\n          return cb(undefined, {\n            isFile() {\n              return true;\n            },\n            isDirectory() {\n              return false;\n            }\n          });\n        } else if (path === '/') {\n          return cb(undefined, {\n            isFile() {\n              return false;\n            },\n            isDirectory() {\n              return true;\n            }\n          });\n        }\n        cb(new Error(`Unexpected stat call for ${path}`));\n      }\n    } as unknown as typeof compiler.inputFileSystem;\n\n    const results: Map<string, string> = new Map();\n\n    const outputFs: typeof compiler.outputFileSystem = {\n      mkdir(path: string, cb: (err?: NodeJS.ErrnoException) => void): void {\n        cb();\n      },\n      stat(path: string, cb: (err?: NodeJS.ErrnoException) => void): void {\n        const err: NodeJS.ErrnoException = new Error(`No such file`);\n        err.code = 'ENOENT';\n        cb(err);\n      },\n      writeFile(path: string, content: Buffer, cb: (err?: NodeJS.ErrnoException) => void): void {\n        results.set(path, content.toString('utf8'));\n        cb();\n      }\n    } as unknown as typeof compiler.outputFileSystem;\n\n    compiler.inputFileSystem = inputFs;\n    compiler.outputFileSystem = outputFs;\n\n    await new Promise<void>((resolve: () => void, reject: (err: Error) => void) =>\n      compiler.run((err?: Error | null) => {\n        if (err) {\n          return reject(err);\n        }\n        resolve();\n      })\n    );\n\n    expect(results).toMatchSnapshot();\n  });\n});\n"]}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@rushstack/webpack-preserve-dynamic-require-plugin",
+  "version": "0.9.0",
+  "description": "This plugin tells webpack to leave dynamic calls to \"require\" as-is instead of trying to bundle them.",
+  "main": "lib/index.js",
+  "typings": "dist/webpack-preserve-dynamic-require-plugin.d.ts",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/rushstack.git",
+    "directory": "webpack/preserve-dynamic-require-plugin"
+  },
+  "engines": {
+    "node": ">=10.17.1"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@rushstack/eslint-config": "2.6.0",
+    "@rushstack/heft": "0.45.0",
+    "@rushstack/heft-node-rig": "1.9.1",
+    "@types/heft-jest": "1.0.1",
+    "@types/node": "12.20.24",
+    "webpack": "~5.68.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "heft build --clean",
+    "_phase:build": "heft build --clean",
+    "_phase:test": "heft test --no-build"
+  },
+  "readme": "# @rushstack/webpack-preserve-dynamic-require-plugin\n\n## Overview\n\nThis Webpack plugin instructs webpack to leave dynamic usage of `require` as-is in the bundled code. For example, if your code contains:\n```js\nfunction requireSomeUserThing(path) {\n  return require(path);\n}\n```\nThe emitted bundle will preserve the call to `require(path)` instead of trying to process it.\n"
+}