AssetModulesPlugin.js 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Yuta Hiroto @hiroppy
  4. */
  5. "use strict";
  6. const { cleverMerge } = require("../util/cleverMerge");
  7. const { compareModulesByIdentifier } = require("../util/comparators");
  8. const createSchemaValidation = require("../util/create-schema-validation");
  9. const memoize = require("../util/memoize");
  10. /** @typedef {import("webpack-sources").Source} Source */
  11. /** @typedef {import("../Chunk")} Chunk */
  12. /** @typedef {import("../Compiler")} Compiler */
  13. /** @typedef {import("../Module")} Module */
  14. const getSchema = name => {
  15. const { definitions } = require("../../schemas/WebpackOptions.json");
  16. return {
  17. definitions,
  18. oneOf: [{ $ref: `#/definitions/${name}` }]
  19. };
  20. };
  21. const generatorValidationOptions = {
  22. name: "Asset Modules Plugin",
  23. baseDataPath: "generator"
  24. };
  25. const validateGeneratorOptions = {
  26. asset: createSchemaValidation(
  27. require("../../schemas/plugins/asset/AssetGeneratorOptions.check.js"),
  28. () => getSchema("AssetGeneratorOptions"),
  29. generatorValidationOptions
  30. ),
  31. "asset/resource": createSchemaValidation(
  32. require("../../schemas/plugins/asset/AssetResourceGeneratorOptions.check.js"),
  33. () => getSchema("AssetResourceGeneratorOptions"),
  34. generatorValidationOptions
  35. ),
  36. "asset/inline": createSchemaValidation(
  37. require("../../schemas/plugins/asset/AssetInlineGeneratorOptions.check.js"),
  38. () => getSchema("AssetInlineGeneratorOptions"),
  39. generatorValidationOptions
  40. )
  41. };
  42. const validateParserOptions = createSchemaValidation(
  43. require("../../schemas/plugins/asset/AssetParserOptions.check.js"),
  44. () => getSchema("AssetParserOptions"),
  45. {
  46. name: "Asset Modules Plugin",
  47. baseDataPath: "parser"
  48. }
  49. );
  50. const getAssetGenerator = memoize(() => require("./AssetGenerator"));
  51. const getAssetParser = memoize(() => require("./AssetParser"));
  52. const getAssetSourceParser = memoize(() => require("./AssetSourceParser"));
  53. const getAssetSourceGenerator = memoize(() =>
  54. require("./AssetSourceGenerator")
  55. );
  56. const type = "asset";
  57. const plugin = "AssetModulesPlugin";
  58. class AssetModulesPlugin {
  59. /**
  60. * Apply the plugin
  61. * @param {Compiler} compiler the compiler instance
  62. * @returns {void}
  63. */
  64. apply(compiler) {
  65. compiler.hooks.compilation.tap(
  66. plugin,
  67. (compilation, { normalModuleFactory }) => {
  68. normalModuleFactory.hooks.createParser
  69. .for("asset")
  70. .tap(plugin, parserOptions => {
  71. validateParserOptions(parserOptions);
  72. parserOptions = cleverMerge(
  73. compiler.options.module.parser.asset,
  74. parserOptions
  75. );
  76. let dataUrlCondition = parserOptions.dataUrlCondition;
  77. if (!dataUrlCondition || typeof dataUrlCondition === "object") {
  78. dataUrlCondition = {
  79. maxSize: 8096,
  80. ...dataUrlCondition
  81. };
  82. }
  83. const AssetParser = getAssetParser();
  84. return new AssetParser(dataUrlCondition);
  85. });
  86. normalModuleFactory.hooks.createParser
  87. .for("asset/inline")
  88. .tap(plugin, parserOptions => {
  89. const AssetParser = getAssetParser();
  90. return new AssetParser(true);
  91. });
  92. normalModuleFactory.hooks.createParser
  93. .for("asset/resource")
  94. .tap(plugin, parserOptions => {
  95. const AssetParser = getAssetParser();
  96. return new AssetParser(false);
  97. });
  98. normalModuleFactory.hooks.createParser
  99. .for("asset/source")
  100. .tap(plugin, parserOptions => {
  101. const AssetSourceParser = getAssetSourceParser();
  102. return new AssetSourceParser();
  103. });
  104. for (const type of ["asset", "asset/inline", "asset/resource"]) {
  105. normalModuleFactory.hooks.createGenerator
  106. .for(type)
  107. .tap(plugin, generatorOptions => {
  108. validateGeneratorOptions[type](generatorOptions);
  109. let dataUrl = undefined;
  110. if (type !== "asset/resource") {
  111. dataUrl = generatorOptions.dataUrl;
  112. if (!dataUrl || typeof dataUrl === "object") {
  113. dataUrl = {
  114. encoding: undefined,
  115. mimetype: undefined,
  116. ...dataUrl
  117. };
  118. }
  119. }
  120. let filename = undefined;
  121. let publicPath = undefined;
  122. let outputPath = undefined;
  123. if (type !== "asset/inline") {
  124. filename = generatorOptions.filename;
  125. publicPath = generatorOptions.publicPath;
  126. outputPath = generatorOptions.outputPath;
  127. }
  128. const AssetGenerator = getAssetGenerator();
  129. return new AssetGenerator(
  130. dataUrl,
  131. filename,
  132. publicPath,
  133. outputPath,
  134. generatorOptions.emit !== false
  135. );
  136. });
  137. }
  138. normalModuleFactory.hooks.createGenerator
  139. .for("asset/source")
  140. .tap(plugin, () => {
  141. const AssetSourceGenerator = getAssetSourceGenerator();
  142. return new AssetSourceGenerator();
  143. });
  144. compilation.hooks.renderManifest.tap(plugin, (result, options) => {
  145. const { chunkGraph } = compilation;
  146. const { chunk, codeGenerationResults } = options;
  147. const modules = chunkGraph.getOrderedChunkModulesIterableBySourceType(
  148. chunk,
  149. "asset",
  150. compareModulesByIdentifier
  151. );
  152. if (modules) {
  153. for (const module of modules) {
  154. try {
  155. const codeGenResult = codeGenerationResults.get(
  156. module,
  157. chunk.runtime
  158. );
  159. result.push({
  160. render: () => codeGenResult.sources.get(type),
  161. filename:
  162. module.buildInfo.filename ||
  163. codeGenResult.data.get("filename"),
  164. info:
  165. module.buildInfo.assetInfo ||
  166. codeGenResult.data.get("assetInfo"),
  167. auxiliary: true,
  168. identifier: `assetModule${chunkGraph.getModuleId(module)}`,
  169. hash:
  170. module.buildInfo.fullContentHash ||
  171. codeGenResult.data.get("fullContentHash")
  172. });
  173. } catch (e) {
  174. e.message += `\nduring rendering of asset ${module.identifier()}`;
  175. throw e;
  176. }
  177. }
  178. }
  179. return result;
  180. });
  181. compilation.hooks.prepareModuleExecution.tap(
  182. "AssetModulesPlugin",
  183. (options, context) => {
  184. const { codeGenerationResult } = options;
  185. const source = codeGenerationResult.sources.get("asset");
  186. if (source === undefined) return;
  187. context.assets.set(codeGenerationResult.data.get("filename"), {
  188. source,
  189. info: codeGenerationResult.data.get("assetInfo")
  190. });
  191. }
  192. );
  193. }
  194. );
  195. }
  196. }
  197. module.exports = AssetModulesPlugin;