AMDPlugin.js 7.2 KB

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