ProvidePlugin.js 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  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("./Compiler")} Compiler */
  15. const PLUGIN_NAME = "ProvidePlugin";
  16. class ProvidePlugin {
  17. /**
  18. * @param {Record<string, string | string[]>} definitions the provided identifiers
  19. */
  20. constructor(definitions) {
  21. this.definitions = definitions;
  22. }
  23. /**
  24. * Apply the plugin
  25. * @param {Compiler} compiler the compiler instance
  26. * @returns {void}
  27. */
  28. apply(compiler) {
  29. const definitions = this.definitions;
  30. compiler.hooks.compilation.tap(
  31. PLUGIN_NAME,
  32. (compilation, { normalModuleFactory }) => {
  33. compilation.dependencyTemplates.set(
  34. ConstDependency,
  35. new ConstDependency.Template()
  36. );
  37. compilation.dependencyFactories.set(
  38. ProvidedDependency,
  39. normalModuleFactory
  40. );
  41. compilation.dependencyTemplates.set(
  42. ProvidedDependency,
  43. new ProvidedDependency.Template()
  44. );
  45. const handler = (parser, parserOptions) => {
  46. Object.keys(definitions).forEach(name => {
  47. const request = [].concat(definitions[name]);
  48. const splittedName = name.split(".");
  49. if (splittedName.length > 0) {
  50. splittedName.slice(1).forEach((_, i) => {
  51. const name = splittedName.slice(0, i + 1).join(".");
  52. parser.hooks.canRename.for(name).tap(PLUGIN_NAME, approve);
  53. });
  54. }
  55. parser.hooks.expression.for(name).tap(PLUGIN_NAME, expr => {
  56. const nameIdentifier = name.includes(".")
  57. ? `__webpack_provided_${name.replace(/\./g, "_dot_")}`
  58. : name;
  59. const dep = new ProvidedDependency(
  60. request[0],
  61. nameIdentifier,
  62. request.slice(1),
  63. expr.range
  64. );
  65. dep.loc = expr.loc;
  66. parser.state.module.addDependency(dep);
  67. return true;
  68. });
  69. parser.hooks.call.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. expr.callee.range
  78. );
  79. dep.loc = expr.callee.loc;
  80. parser.state.module.addDependency(dep);
  81. parser.walkExpressions(expr.arguments);
  82. return true;
  83. });
  84. });
  85. };
  86. normalModuleFactory.hooks.parser
  87. .for(JAVASCRIPT_MODULE_TYPE_AUTO)
  88. .tap(PLUGIN_NAME, handler);
  89. normalModuleFactory.hooks.parser
  90. .for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
  91. .tap(PLUGIN_NAME, handler);
  92. normalModuleFactory.hooks.parser
  93. .for(JAVASCRIPT_MODULE_TYPE_ESM)
  94. .tap(PLUGIN_NAME, handler);
  95. }
  96. );
  97. }
  98. }
  99. module.exports = ProvidePlugin;