提交学习笔记专用
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

121 lines
3.7 KiB

  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. ...(Array.isArray(definitions[name])
  58. ? definitions[name]
  59. : [definitions[name]])
  60. ];
  61. const splittedName = name.split(".");
  62. if (splittedName.length > 0) {
  63. for (const [i, _] of splittedName.slice(1).entries()) {
  64. const name = splittedName.slice(0, i + 1).join(".");
  65. parser.hooks.canRename.for(name).tap(PLUGIN_NAME, approve);
  66. }
  67. }
  68. parser.hooks.expression.for(name).tap(PLUGIN_NAME, (expr) => {
  69. const nameIdentifier = name.includes(".")
  70. ? `__webpack_provided_${name.replace(/\./g, "_dot_")}`
  71. : name;
  72. const dep = new ProvidedDependency(
  73. request[0],
  74. nameIdentifier,
  75. request.slice(1),
  76. /** @type {Range} */ (expr.range)
  77. );
  78. dep.loc = /** @type {DependencyLocation} */ (expr.loc);
  79. parser.state.module.addDependency(dep);
  80. return true;
  81. });
  82. parser.hooks.call.for(name).tap(PLUGIN_NAME, (expr) => {
  83. const nameIdentifier = name.includes(".")
  84. ? `__webpack_provided_${name.replace(/\./g, "_dot_")}`
  85. : name;
  86. const dep = new ProvidedDependency(
  87. request[0],
  88. nameIdentifier,
  89. request.slice(1),
  90. /** @type {Range} */ (expr.callee.range)
  91. );
  92. dep.loc = /** @type {DependencyLocation} */ (expr.callee.loc);
  93. parser.state.module.addDependency(dep);
  94. parser.walkExpressions(expr.arguments);
  95. return true;
  96. });
  97. }
  98. };
  99. normalModuleFactory.hooks.parser
  100. .for(JAVASCRIPT_MODULE_TYPE_AUTO)
  101. .tap(PLUGIN_NAME, handler);
  102. normalModuleFactory.hooks.parser
  103. .for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
  104. .tap(PLUGIN_NAME, handler);
  105. normalModuleFactory.hooks.parser
  106. .for(JAVASCRIPT_MODULE_TYPE_ESM)
  107. .tap(PLUGIN_NAME, handler);
  108. }
  109. );
  110. }
  111. }
  112. module.exports = ProvidePlugin;