ProvidePlugin.js 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  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. /** @typedef {import("../declarations/WebpackOptions").JavascriptParserOptions} JavascriptParserOptions */
  15. /** @typedef {import("./Compiler")} Compiler */
  16. /** @typedef {import("./Dependency").DependencyLocation} DependencyLocation */
  17. /** @typedef {import("./javascript/JavascriptParser")} JavascriptParser */
  18. /** @typedef {import("./javascript/JavascriptParser").Range} Range */
  19. const PLUGIN_NAME = "ProvidePlugin";
  20. class ProvidePlugin {
  21. /**
  22. * @param {Record<string, string | string[]>} definitions the provided identifiers
  23. */
  24. constructor(definitions) {
  25. this.definitions = definitions;
  26. }
  27. /**
  28. * Apply the plugin
  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. * @param {JavascriptParser} parser the parser
  51. * @param {JavascriptParserOptions} parserOptions options
  52. * @returns {void}
  53. */
  54. const handler = (parser, parserOptions) => {
  55. for (const name of Object.keys(definitions)) {
  56. const request =
  57. /** @type {string[]} */
  58. ([
  59. ...(Array.isArray(definitions[name])
  60. ? definitions[name]
  61. : [definitions[name]])
  62. ]);
  63. const splittedName = name.split(".");
  64. if (splittedName.length > 0) {
  65. for (const [i, _] of splittedName.slice(1).entries()) {
  66. const name = splittedName.slice(0, i + 1).join(".");
  67. parser.hooks.canRename.for(name).tap(PLUGIN_NAME, approve);
  68. }
  69. }
  70. parser.hooks.expression.for(name).tap(PLUGIN_NAME, expr => {
  71. const nameIdentifier = name.includes(".")
  72. ? `__webpack_provided_${name.replace(/\./g, "_dot_")}`
  73. : name;
  74. const dep = new ProvidedDependency(
  75. request[0],
  76. nameIdentifier,
  77. request.slice(1),
  78. /** @type {Range} */ (expr.range)
  79. );
  80. dep.loc = /** @type {DependencyLocation} */ (expr.loc);
  81. parser.state.module.addDependency(dep);
  82. return true;
  83. });
  84. parser.hooks.call.for(name).tap(PLUGIN_NAME, expr => {
  85. const nameIdentifier = name.includes(".")
  86. ? `__webpack_provided_${name.replace(/\./g, "_dot_")}`
  87. : name;
  88. const dep = new ProvidedDependency(
  89. request[0],
  90. nameIdentifier,
  91. request.slice(1),
  92. /** @type {Range} */ (expr.callee.range)
  93. );
  94. dep.loc = /** @type {DependencyLocation} */ (expr.callee.loc);
  95. parser.state.module.addDependency(dep);
  96. parser.walkExpressions(expr.arguments);
  97. return true;
  98. });
  99. }
  100. };
  101. normalModuleFactory.hooks.parser
  102. .for(JAVASCRIPT_MODULE_TYPE_AUTO)
  103. .tap(PLUGIN_NAME, handler);
  104. normalModuleFactory.hooks.parser
  105. .for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
  106. .tap(PLUGIN_NAME, handler);
  107. normalModuleFactory.hooks.parser
  108. .for(JAVASCRIPT_MODULE_TYPE_ESM)
  109. .tap(PLUGIN_NAME, handler);
  110. }
  111. );
  112. }
  113. }
  114. module.exports = ProvidePlugin;