ProvidePlugin.js 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const {
  7. JAVASCRIPT_MODULE_TYPE_AUTO,
  8. JAVASCRIPT_MODULE_TYPE_DYNAMIC,
  9. JAVASCRIPT_MODULE_TYPE_ESM
  10. } = require("./ModuleTypeConstants");
  11. const ConstDependency = require("./dependencies/ConstDependency");
  12. const ProvidedDependency = require("./dependencies/ProvidedDependency");
  13. const { approve } = require("./javascript/JavascriptParserHelpers");
  14. /** @import { JavascriptParserOptions } from "../declarations/WebpackOptions" */
  15. /** @import Compiler from "./Compiler" */
  16. /** @import JavascriptParser, { Range } from "./javascript/JavascriptParser" */
  17. const PLUGIN_NAME = "ProvidePlugin";
  18. class ProvidePlugin {
  19. /**
  20. * Creates an instance of ProvidePlugin.
  21. * @param {Record<string, string | string[]>} definitions the provided identifiers
  22. */
  23. constructor(definitions) {
  24. /** @type {Record<string, string | string[]>} */
  25. this.definitions = definitions;
  26. }
  27. /**
  28. * Applies the plugin by registering its hooks on the compiler.
  29. * @param {Compiler} compiler the compiler instance
  30. * @returns {void}
  31. */
  32. apply(compiler) {
  33. const definitions = this.definitions;
  34. compiler.hooks.compilation.tap(
  35. PLUGIN_NAME,
  36. (compilation, { normalModuleFactory }) => {
  37. compilation.dependencyTemplates.set(
  38. ConstDependency,
  39. new ConstDependency.Template()
  40. );
  41. compilation.dependencyFactories.set(
  42. ProvidedDependency,
  43. normalModuleFactory
  44. );
  45. compilation.dependencyTemplates.set(
  46. ProvidedDependency,
  47. new ProvidedDependency.Template()
  48. );
  49. /**
  50. * Handles the hook callback for this code path.
  51. * @param {JavascriptParser} parser the parser
  52. * @param {JavascriptParserOptions} parserOptions options
  53. * @returns {void}
  54. */
  55. const handler = (parser, parserOptions) => {
  56. for (const name of Object.keys(definitions)) {
  57. const request = [
  58. ...(Array.isArray(definitions[name])
  59. ? definitions[name]
  60. : [definitions[name]])
  61. ];
  62. const splittedName = name.split(".");
  63. if (splittedName.length > 0) {
  64. for (const [i, _] of splittedName.slice(1).entries()) {
  65. const name = splittedName.slice(0, i + 1).join(".");
  66. parser.hooks.canRename.for(name).tap(PLUGIN_NAME, approve);
  67. }
  68. }
  69. parser.hooks.expression.for(name).tap(PLUGIN_NAME, (expr) => {
  70. const nameIdentifier = name.includes(".")
  71. ? `__webpack_provided_${name.replace(/\./g, "_dot_")}`
  72. : name;
  73. const dep = new ProvidedDependency(
  74. request[0],
  75. nameIdentifier,
  76. request.slice(1),
  77. /** @type {Range} */ (expr.range)
  78. );
  79. dep.loc = parser.getLocation(expr);
  80. parser.state.module.addDependency(dep);
  81. return true;
  82. });
  83. parser.hooks.call.for(name).tap(PLUGIN_NAME, (expr) => {
  84. const nameIdentifier = name.includes(".")
  85. ? `__webpack_provided_${name.replace(/\./g, "_dot_")}`
  86. : name;
  87. const dep = new ProvidedDependency(
  88. request[0],
  89. nameIdentifier,
  90. request.slice(1),
  91. /** @type {Range} */ (expr.callee.range)
  92. );
  93. dep.loc = parser.getLocation(expr.callee);
  94. parser.state.module.addDependency(dep);
  95. parser.walkExpressions(expr.arguments);
  96. return true;
  97. });
  98. }
  99. };
  100. normalModuleFactory.hooks.parser
  101. .for(JAVASCRIPT_MODULE_TYPE_AUTO)
  102. .tap(PLUGIN_NAME, handler);
  103. normalModuleFactory.hooks.parser
  104. .for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
  105. .tap(PLUGIN_NAME, handler);
  106. normalModuleFactory.hooks.parser
  107. .for(JAVASCRIPT_MODULE_TYPE_ESM)
  108. .tap(PLUGIN_NAME, handler);
  109. }
  110. );
  111. }
  112. }
  113. module.exports = ProvidePlugin;