RequireContextPlugin.js 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  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 { cachedSetProperty } = require("../util/cleverMerge");
  11. const ContextElementDependency = require("./ContextElementDependency");
  12. const RequireContextDependency = require("./RequireContextDependency");
  13. const RequireContextDependencyParserPlugin = require("./RequireContextDependencyParserPlugin");
  14. /** @typedef {import("../../declarations/WebpackOptions").JavascriptParserOptions} JavascriptParserOptions */
  15. /** @typedef {import("../../declarations/WebpackOptions").ResolveOptions} ResolveOptions */
  16. /** @typedef {import("../Compiler")} Compiler */
  17. /** @typedef {import("../javascript/JavascriptParser")} Parser */
  18. /** @type {ResolveOptions} */
  19. const EMPTY_RESOLVE_OPTIONS = {};
  20. const PLUGIN_NAME = "RequireContextPlugin";
  21. class RequireContextPlugin {
  22. /**
  23. * Applies the plugin by registering its hooks on the compiler.
  24. * @param {Compiler} compiler the compiler instance
  25. * @returns {void}
  26. */
  27. apply(compiler) {
  28. compiler.hooks.compilation.tap(
  29. PLUGIN_NAME,
  30. (compilation, { contextModuleFactory, normalModuleFactory }) => {
  31. compilation.dependencyFactories.set(
  32. RequireContextDependency,
  33. contextModuleFactory
  34. );
  35. compilation.dependencyTemplates.set(
  36. RequireContextDependency,
  37. new RequireContextDependency.Template()
  38. );
  39. compilation.dependencyFactories.set(
  40. ContextElementDependency,
  41. normalModuleFactory
  42. );
  43. /**
  44. * Handles the hook callback for this code path.
  45. * @param {Parser} parser parser parser
  46. * @param {JavascriptParserOptions} parserOptions parserOptions
  47. * @returns {void}
  48. */
  49. const handler = (parser, parserOptions) => {
  50. if (
  51. parserOptions.requireContext !== undefined &&
  52. !parserOptions.requireContext
  53. ) {
  54. return;
  55. }
  56. new RequireContextDependencyParserPlugin().apply(parser);
  57. };
  58. normalModuleFactory.hooks.parser
  59. .for(JAVASCRIPT_MODULE_TYPE_AUTO)
  60. .tap(PLUGIN_NAME, handler);
  61. normalModuleFactory.hooks.parser
  62. .for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
  63. .tap(PLUGIN_NAME, handler);
  64. contextModuleFactory.hooks.alternativeRequests.tap(
  65. PLUGIN_NAME,
  66. (items, options) => {
  67. if (items.length === 0) return items;
  68. const finalResolveOptions = compiler.resolverFactory.get(
  69. "normal",
  70. cachedSetProperty(
  71. options.resolveOptions || EMPTY_RESOLVE_OPTIONS,
  72. "dependencyType",
  73. /** @type {string} */
  74. (options.category)
  75. )
  76. ).options;
  77. /** @type {{ context: string, request: string }[]} */
  78. let newItems;
  79. if (!finalResolveOptions.fullySpecified) {
  80. newItems = [];
  81. for (const item of items) {
  82. const { request, context } = item;
  83. for (const ext of finalResolveOptions.extensions) {
  84. if (request.endsWith(ext)) {
  85. newItems.push({
  86. context,
  87. request: request.slice(0, -ext.length)
  88. });
  89. }
  90. }
  91. if (!finalResolveOptions.enforceExtension) {
  92. newItems.push(item);
  93. }
  94. }
  95. items = newItems;
  96. newItems = [];
  97. for (const obj of items) {
  98. const { request, context } = obj;
  99. for (const mainFile of finalResolveOptions.mainFiles) {
  100. if (request.endsWith(`/${mainFile}`)) {
  101. newItems.push({
  102. context,
  103. request: request.slice(0, -mainFile.length)
  104. });
  105. newItems.push({
  106. context,
  107. request: request.slice(0, -mainFile.length - 1)
  108. });
  109. }
  110. }
  111. newItems.push(obj);
  112. }
  113. items = newItems;
  114. }
  115. newItems = [];
  116. for (const item of items) {
  117. let hideOriginal = false;
  118. for (const modulesItems of finalResolveOptions.modules) {
  119. if (Array.isArray(modulesItems)) {
  120. for (const dir of modulesItems) {
  121. if (item.request.startsWith(`./${dir}/`)) {
  122. newItems.push({
  123. context: item.context,
  124. request: item.request.slice(dir.length + 3)
  125. });
  126. hideOriginal = true;
  127. }
  128. }
  129. } else {
  130. const dir = modulesItems.replace(/\\/g, "/");
  131. const fullPath =
  132. item.context.replace(/\\/g, "/") + item.request.slice(1);
  133. if (fullPath.startsWith(dir)) {
  134. newItems.push({
  135. context: item.context,
  136. request: fullPath.slice(dir.length + 1)
  137. });
  138. }
  139. }
  140. }
  141. if (!hideOriginal) {
  142. newItems.push(item);
  143. }
  144. }
  145. return newItems;
  146. }
  147. );
  148. }
  149. );
  150. }
  151. }
  152. module.exports = RequireContextPlugin;