AMDPlugin.js 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  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. } = require("../ModuleTypeConstants");
  10. const RuntimeGlobals = require("../RuntimeGlobals");
  11. const {
  12. approve,
  13. evaluateToIdentifier,
  14. evaluateToString,
  15. toConstantDependency
  16. } = require("../javascript/JavascriptParserHelpers");
  17. const AMDDefineDependency = require("./AMDDefineDependency");
  18. const AMDDefineDependencyParserPlugin = require("./AMDDefineDependencyParserPlugin");
  19. const AMDRequireArrayDependency = require("./AMDRequireArrayDependency");
  20. const AMDRequireContextDependency = require("./AMDRequireContextDependency");
  21. const AMDRequireDependenciesBlockParserPlugin = require("./AMDRequireDependenciesBlockParserPlugin");
  22. const AMDRequireDependency = require("./AMDRequireDependency");
  23. const AMDRequireItemDependency = require("./AMDRequireItemDependency");
  24. const {
  25. AMDDefineRuntimeModule,
  26. AMDOptionsRuntimeModule
  27. } = require("./AMDRuntimeModules");
  28. const ConstDependency = require("./ConstDependency");
  29. const LocalModuleDependency = require("./LocalModuleDependency");
  30. const UnsupportedDependency = require("./UnsupportedDependency");
  31. /** @typedef {import("../../declarations/WebpackOptions").JavascriptParserOptions} JavascriptParserOptions */
  32. /** @typedef {import("../../declarations/WebpackOptions").ModuleOptionsNormalized} ModuleOptions */
  33. /** @typedef {import("../Compiler")} Compiler */
  34. /** @typedef {import("../javascript/JavascriptParser")} Parser */
  35. const PLUGIN_NAME = "AMDPlugin";
  36. class AMDPlugin {
  37. /**
  38. * @param {Record<string, any>} amdOptions the AMD options
  39. */
  40. constructor(amdOptions) {
  41. this.amdOptions = amdOptions;
  42. }
  43. /**
  44. * Apply the plugin
  45. * @param {Compiler} compiler the compiler instance
  46. * @returns {void}
  47. */
  48. apply(compiler) {
  49. const amdOptions = this.amdOptions;
  50. compiler.hooks.compilation.tap(
  51. PLUGIN_NAME,
  52. (compilation, { contextModuleFactory, normalModuleFactory }) => {
  53. compilation.dependencyTemplates.set(
  54. AMDRequireDependency,
  55. new AMDRequireDependency.Template()
  56. );
  57. compilation.dependencyFactories.set(
  58. AMDRequireItemDependency,
  59. normalModuleFactory
  60. );
  61. compilation.dependencyTemplates.set(
  62. AMDRequireItemDependency,
  63. new AMDRequireItemDependency.Template()
  64. );
  65. compilation.dependencyTemplates.set(
  66. AMDRequireArrayDependency,
  67. new AMDRequireArrayDependency.Template()
  68. );
  69. compilation.dependencyFactories.set(
  70. AMDRequireContextDependency,
  71. contextModuleFactory
  72. );
  73. compilation.dependencyTemplates.set(
  74. AMDRequireContextDependency,
  75. new AMDRequireContextDependency.Template()
  76. );
  77. compilation.dependencyTemplates.set(
  78. AMDDefineDependency,
  79. new AMDDefineDependency.Template()
  80. );
  81. compilation.dependencyTemplates.set(
  82. UnsupportedDependency,
  83. new UnsupportedDependency.Template()
  84. );
  85. compilation.dependencyTemplates.set(
  86. LocalModuleDependency,
  87. new LocalModuleDependency.Template()
  88. );
  89. compilation.hooks.runtimeRequirementInModule
  90. .for(RuntimeGlobals.amdDefine)
  91. .tap(PLUGIN_NAME, (module, set) => {
  92. set.add(RuntimeGlobals.require);
  93. });
  94. compilation.hooks.runtimeRequirementInModule
  95. .for(RuntimeGlobals.amdOptions)
  96. .tap(PLUGIN_NAME, (module, set) => {
  97. set.add(RuntimeGlobals.requireScope);
  98. });
  99. compilation.hooks.runtimeRequirementInTree
  100. .for(RuntimeGlobals.amdDefine)
  101. .tap(PLUGIN_NAME, (chunk, set) => {
  102. compilation.addRuntimeModule(chunk, new AMDDefineRuntimeModule());
  103. });
  104. compilation.hooks.runtimeRequirementInTree
  105. .for(RuntimeGlobals.amdOptions)
  106. .tap(PLUGIN_NAME, (chunk, set) => {
  107. compilation.addRuntimeModule(
  108. chunk,
  109. new AMDOptionsRuntimeModule(amdOptions)
  110. );
  111. });
  112. /**
  113. * @param {Parser} parser parser parser
  114. * @param {JavascriptParserOptions} parserOptions parserOptions
  115. * @returns {void}
  116. */
  117. const handler = (parser, parserOptions) => {
  118. if (parserOptions.amd !== undefined && !parserOptions.amd) return;
  119. const tapOptionsHooks = (optionExpr, rootName, getMembers) => {
  120. parser.hooks.expression
  121. .for(optionExpr)
  122. .tap(
  123. PLUGIN_NAME,
  124. toConstantDependency(parser, RuntimeGlobals.amdOptions, [
  125. RuntimeGlobals.amdOptions
  126. ])
  127. );
  128. parser.hooks.evaluateIdentifier
  129. .for(optionExpr)
  130. .tap(
  131. PLUGIN_NAME,
  132. evaluateToIdentifier(optionExpr, rootName, getMembers, true)
  133. );
  134. parser.hooks.evaluateTypeof
  135. .for(optionExpr)
  136. .tap(PLUGIN_NAME, evaluateToString("object"));
  137. parser.hooks.typeof
  138. .for(optionExpr)
  139. .tap(
  140. PLUGIN_NAME,
  141. toConstantDependency(parser, JSON.stringify("object"))
  142. );
  143. };
  144. new AMDRequireDependenciesBlockParserPlugin(parserOptions).apply(
  145. parser
  146. );
  147. new AMDDefineDependencyParserPlugin(parserOptions).apply(parser);
  148. tapOptionsHooks("define.amd", "define", () => "amd");
  149. tapOptionsHooks("require.amd", "require", () => ["amd"]);
  150. tapOptionsHooks(
  151. "__webpack_amd_options__",
  152. "__webpack_amd_options__",
  153. () => []
  154. );
  155. parser.hooks.expression.for("define").tap(PLUGIN_NAME, expr => {
  156. const dep = new ConstDependency(
  157. RuntimeGlobals.amdDefine,
  158. expr.range,
  159. [RuntimeGlobals.amdDefine]
  160. );
  161. dep.loc = expr.loc;
  162. parser.state.module.addPresentationalDependency(dep);
  163. return true;
  164. });
  165. parser.hooks.typeof
  166. .for("define")
  167. .tap(
  168. PLUGIN_NAME,
  169. toConstantDependency(parser, JSON.stringify("function"))
  170. );
  171. parser.hooks.evaluateTypeof
  172. .for("define")
  173. .tap(PLUGIN_NAME, evaluateToString("function"));
  174. parser.hooks.canRename.for("define").tap(PLUGIN_NAME, approve);
  175. parser.hooks.rename.for("define").tap(PLUGIN_NAME, expr => {
  176. const dep = new ConstDependency(
  177. RuntimeGlobals.amdDefine,
  178. expr.range,
  179. [RuntimeGlobals.amdDefine]
  180. );
  181. dep.loc = expr.loc;
  182. parser.state.module.addPresentationalDependency(dep);
  183. return false;
  184. });
  185. parser.hooks.typeof
  186. .for("require")
  187. .tap(
  188. PLUGIN_NAME,
  189. toConstantDependency(parser, JSON.stringify("function"))
  190. );
  191. parser.hooks.evaluateTypeof
  192. .for("require")
  193. .tap(PLUGIN_NAME, evaluateToString("function"));
  194. };
  195. normalModuleFactory.hooks.parser
  196. .for(JAVASCRIPT_MODULE_TYPE_AUTO)
  197. .tap(PLUGIN_NAME, handler);
  198. normalModuleFactory.hooks.parser
  199. .for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
  200. .tap(PLUGIN_NAME, handler);
  201. }
  202. );
  203. }
  204. }
  205. module.exports = AMDPlugin;