RequireContextPlugin.js 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  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. * Apply the plugin
  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. * @param {Parser} parser parser parser
  45. * @param {JavascriptParserOptions} parserOptions parserOptions
  46. * @returns {void}
  47. */
  48. const handler = (parser, parserOptions) => {
  49. if (
  50. parserOptions.requireContext !== undefined &&
  51. !parserOptions.requireContext
  52. ) {
  53. return;
  54. }
  55. new RequireContextDependencyParserPlugin().apply(parser);
  56. };
  57. normalModuleFactory.hooks.parser
  58. .for(JAVASCRIPT_MODULE_TYPE_AUTO)
  59. .tap(PLUGIN_NAME, handler);
  60. normalModuleFactory.hooks.parser
  61. .for(JAVASCRIPT_MODULE_TYPE_DYNAMIC)
  62. .tap(PLUGIN_NAME, handler);
  63. contextModuleFactory.hooks.alternativeRequests.tap(
  64. PLUGIN_NAME,
  65. (items, options) => {
  66. if (items.length === 0) return items;
  67. const finalResolveOptions = compiler.resolverFactory.get(
  68. "normal",
  69. cachedSetProperty(
  70. options.resolveOptions || EMPTY_RESOLVE_OPTIONS,
  71. "dependencyType",
  72. /** @type {string} */
  73. (options.category)
  74. )
  75. ).options;
  76. let newItems;
  77. if (!finalResolveOptions.fullySpecified) {
  78. newItems = [];
  79. for (const item of items) {
  80. const { request, context } = item;
  81. for (const ext of finalResolveOptions.extensions) {
  82. if (request.endsWith(ext)) {
  83. newItems.push({
  84. context,
  85. request: request.slice(0, -ext.length)
  86. });
  87. }
  88. }
  89. if (!finalResolveOptions.enforceExtension) {
  90. newItems.push(item);
  91. }
  92. }
  93. items = newItems;
  94. newItems = [];
  95. for (const obj of items) {
  96. const { request, context } = obj;
  97. for (const mainFile of finalResolveOptions.mainFiles) {
  98. if (request.endsWith(`/${mainFile}`)) {
  99. newItems.push({
  100. context,
  101. request: request.slice(0, -mainFile.length)
  102. });
  103. newItems.push({
  104. context,
  105. request: request.slice(0, -mainFile.length - 1)
  106. });
  107. }
  108. }
  109. newItems.push(obj);
  110. }
  111. items = newItems;
  112. }
  113. newItems = [];
  114. for (const item of items) {
  115. let hideOriginal = false;
  116. for (const modulesItems of finalResolveOptions.modules) {
  117. if (Array.isArray(modulesItems)) {
  118. for (const dir of modulesItems) {
  119. if (item.request.startsWith(`./${dir}/`)) {
  120. newItems.push({
  121. context: item.context,
  122. request: item.request.slice(dir.length + 3)
  123. });
  124. hideOriginal = true;
  125. }
  126. }
  127. } else {
  128. const dir = modulesItems.replace(/\\/g, "/");
  129. const fullPath =
  130. item.context.replace(/\\/g, "/") + item.request.slice(1);
  131. if (fullPath.startsWith(dir)) {
  132. newItems.push({
  133. context: item.context,
  134. request: fullPath.slice(dir.length + 1)
  135. });
  136. }
  137. }
  138. }
  139. if (!hideOriginal) {
  140. newItems.push(item);
  141. }
  142. }
  143. return newItems;
  144. }
  145. );
  146. }
  147. );
  148. }
  149. }
  150. module.exports = RequireContextPlugin;