CommonJsPlugin.js 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const RuntimeGlobals = require("../RuntimeGlobals");
  7. const RuntimeModule = require("../RuntimeModule");
  8. const SelfModuleFactory = require("../SelfModuleFactory");
  9. const Template = require("../Template");
  10. const CommonJsExportsDependency = require("./CommonJsExportsDependency");
  11. const CommonJsFullRequireDependency = require("./CommonJsFullRequireDependency");
  12. const CommonJsRequireContextDependency = require("./CommonJsRequireContextDependency");
  13. const CommonJsRequireDependency = require("./CommonJsRequireDependency");
  14. const CommonJsSelfReferenceDependency = require("./CommonJsSelfReferenceDependency");
  15. const ModuleDecoratorDependency = require("./ModuleDecoratorDependency");
  16. const RequireHeaderDependency = require("./RequireHeaderDependency");
  17. const RequireResolveContextDependency = require("./RequireResolveContextDependency");
  18. const RequireResolveDependency = require("./RequireResolveDependency");
  19. const RequireResolveHeaderDependency = require("./RequireResolveHeaderDependency");
  20. const RuntimeRequirementsDependency = require("./RuntimeRequirementsDependency");
  21. const CommonJsExportsParserPlugin = require("./CommonJsExportsParserPlugin");
  22. const CommonJsImportsParserPlugin = require("./CommonJsImportsParserPlugin");
  23. const {
  24. JAVASCRIPT_MODULE_TYPE_AUTO,
  25. JAVASCRIPT_MODULE_TYPE_DYNAMIC
  26. } = require("../ModuleTypeConstants");
  27. const {
  28. evaluateToIdentifier,
  29. toConstantDependency
  30. } = require("../javascript/JavascriptParserHelpers");
  31. const CommonJsExportRequireDependency = require("./CommonJsExportRequireDependency");
  32. const PLUGIN_NAME = "CommonJsPlugin";
  33. class CommonJsPlugin {
  34. apply(compiler) {
  35. compiler.hooks.compilation.tap(
  36. PLUGIN_NAME,
  37. (compilation, { contextModuleFactory, normalModuleFactory }) => {
  38. compilation.dependencyFactories.set(
  39. CommonJsRequireDependency,
  40. normalModuleFactory
  41. );
  42. compilation.dependencyTemplates.set(
  43. CommonJsRequireDependency,
  44. new CommonJsRequireDependency.Template()
  45. );
  46. compilation.dependencyFactories.set(
  47. CommonJsFullRequireDependency,
  48. normalModuleFactory
  49. );
  50. compilation.dependencyTemplates.set(
  51. CommonJsFullRequireDependency,
  52. new CommonJsFullRequireDependency.Template()
  53. );
  54. compilation.dependencyFactories.set(
  55. CommonJsRequireContextDependency,
  56. contextModuleFactory
  57. );
  58. compilation.dependencyTemplates.set(
  59. CommonJsRequireContextDependency,
  60. new CommonJsRequireContextDependency.Template()
  61. );
  62. compilation.dependencyFactories.set(
  63. RequireResolveDependency,
  64. normalModuleFactory
  65. );
  66. compilation.dependencyTemplates.set(
  67. RequireResolveDependency,
  68. new RequireResolveDependency.Template()
  69. );
  70. compilation.dependencyFactories.set(
  71. RequireResolveContextDependency,
  72. contextModuleFactory
  73. );
  74. compilation.dependencyTemplates.set(
  75. RequireResolveContextDependency,
  76. new RequireResolveContextDependency.Template()
  77. );
  78. compilation.dependencyTemplates.set(
  79. RequireResolveHeaderDependency,
  80. new RequireResolveHeaderDependency.Template()
  81. );
  82. compilation.dependencyTemplates.set(
  83. RequireHeaderDependency,
  84. new RequireHeaderDependency.Template()
  85. );
  86. compilation.dependencyTemplates.set(
  87. CommonJsExportsDependency,
  88. new CommonJsExportsDependency.Template()
  89. );
  90. compilation.dependencyFactories.set(
  91. CommonJsExportRequireDependency,
  92. normalModuleFactory
  93. );
  94. compilation.dependencyTemplates.set(
  95. CommonJsExportRequireDependency,
  96. new CommonJsExportRequireDependency.Template()
  97. );
  98. const selfFactory = new SelfModuleFactory(compilation.moduleGraph);
  99. compilation.dependencyFactories.set(
  100. CommonJsSelfReferenceDependency,
  101. selfFactory
  102. );
  103. compilation.dependencyTemplates.set(
  104. CommonJsSelfReferenceDependency,
  105. new CommonJsSelfReferenceDependency.Template()
  106. );
  107. compilation.dependencyFactories.set(
  108. ModuleDecoratorDependency,
  109. selfFactory
  110. );
  111. compilation.dependencyTemplates.set(
  112. ModuleDecoratorDependency,
  113. new ModuleDecoratorDependency.Template()
  114. );
  115. compilation.hooks.runtimeRequirementInModule
  116. .for(RuntimeGlobals.harmonyModuleDecorator)
  117. .tap(PLUGIN_NAME, (module, set) => {
  118. set.add(RuntimeGlobals.module);
  119. set.add(RuntimeGlobals.requireScope);
  120. });
  121. compilation.hooks.runtimeRequirementInModule
  122. .for(RuntimeGlobals.nodeModuleDecorator)
  123. .tap(PLUGIN_NAME, (module, set) => {
  124. set.add(RuntimeGlobals.module);
  125. set.add(RuntimeGlobals.requireScope);
  126. });
  127. compilation.hooks.runtimeRequirementInTree
  128. .for(RuntimeGlobals.harmonyModuleDecorator)
  129. .tap(PLUGIN_NAME, (chunk, set) => {
  130. compilation.addRuntimeModule(
  131. chunk,
  132. new HarmonyModuleDecoratorRuntimeModule()
  133. );
  134. });
  135. compilation.hooks.runtimeRequirementInTree
  136. .for(RuntimeGlobals.nodeModuleDecorator)
  137. .tap(PLUGIN_NAME, (chunk, set) => {
  138. compilation.addRuntimeModule(
  139. chunk,
  140. new NodeModuleDecoratorRuntimeModule()
  141. );
  142. });
  143. const handler = (parser, parserOptions) => {
  144. if (parserOptions.commonjs !== undefined && !parserOptions.commonjs)
  145. return;
  146. parser.hooks.typeof
  147. .for("module")
  148. .tap(
  149. PLUGIN_NAME,
  150. toConstantDependency(parser, JSON.stringify("object"))
  151. );
  152. parser.hooks.expression
  153. .for("require.main")
  154. .tap(
  155. PLUGIN_NAME,
  156. toConstantDependency(
  157. parser,
  158. `${RuntimeGlobals.moduleCache}[${RuntimeGlobals.entryModuleId}]`,
  159. [RuntimeGlobals.moduleCache, RuntimeGlobals.entryModuleId]
  160. )
  161. );
  162. parser.hooks.expression
  163. .for("module.loaded")
  164. .tap(PLUGIN_NAME, expr => {
  165. parser.state.module.buildInfo.moduleConcatenationBailout =
  166. "module.loaded";
  167. const dep = new RuntimeRequirementsDependency([
  168. RuntimeGlobals.moduleLoaded
  169. ]);
  170. dep.loc = expr.loc;
  171. parser.state.module.addPresentationalDependency(dep);
  172. return true;
  173. });
  174. parser.hooks.expression.for("module.id").tap(PLUGIN_NAME, expr => {
  175. parser.state.module.buildInfo.moduleConcatenationBailout =
  176. "module.id";
  177. const dep = new RuntimeRequirementsDependency([
  178. RuntimeGlobals.moduleId
  179. ]);
  180. dep.loc = expr.loc;
  181. parser.state.module.addPresentationalDependency(dep);
  182. return true;
  183. });
  184. parser.hooks.evaluateIdentifier.for("module.hot").tap(
  185. PLUGIN_NAME,
  186. evaluateToIdentifier("module.hot", "module", () => ["hot"], null)
  187. );
  188. new CommonJsImportsParserPlugin(parserOptions).apply(parser);
  189. new CommonJsExportsParserPlugin(compilation.moduleGraph).apply(
  190. parser
  191. );
  192. };
  193. normalModuleFactory.hooks.parser
  194. .for(JAVASCRIPT_MODULE_TYPE_AUTO)
  195. .tap(PLUGIN_NAME, handler);
  196. normalModuleFactory.hooks.parser
  197. .for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
  198. .tap(PLUGIN_NAME, handler);
  199. }
  200. );
  201. }
  202. }
  203. class HarmonyModuleDecoratorRuntimeModule extends RuntimeModule {
  204. constructor() {
  205. super("harmony module decorator");
  206. }
  207. /**
  208. * @returns {string} runtime code
  209. */
  210. generate() {
  211. const { runtimeTemplate } = this.compilation;
  212. return Template.asString([
  213. `${
  214. RuntimeGlobals.harmonyModuleDecorator
  215. } = ${runtimeTemplate.basicFunction("module", [
  216. "module = Object.create(module);",
  217. "if (!module.children) module.children = [];",
  218. "Object.defineProperty(module, 'exports', {",
  219. Template.indent([
  220. "enumerable: true,",
  221. `set: ${runtimeTemplate.basicFunction("", [
  222. "throw new Error('ES Modules may not assign module.exports or exports.*, Use ESM export syntax, instead: ' + module.id);"
  223. ])}`
  224. ]),
  225. "});",
  226. "return module;"
  227. ])};`
  228. ]);
  229. }
  230. }
  231. class NodeModuleDecoratorRuntimeModule extends RuntimeModule {
  232. constructor() {
  233. super("node module decorator");
  234. }
  235. /**
  236. * @returns {string} runtime code
  237. */
  238. generate() {
  239. const { runtimeTemplate } = this.compilation;
  240. return Template.asString([
  241. `${RuntimeGlobals.nodeModuleDecorator} = ${runtimeTemplate.basicFunction(
  242. "module",
  243. [
  244. "module.paths = [];",
  245. "if (!module.children) module.children = [];",
  246. "return module;"
  247. ]
  248. )};`
  249. ]);
  250. }
  251. }
  252. module.exports = CommonJsPlugin;