CssModulesPlugin.js 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const { SyncHook, SyncWaterfallHook } = require("tapable");
  7. const {
  8. CachedSource,
  9. ConcatSource,
  10. PrefixSource,
  11. RawSource,
  12. ReplaceSource
  13. } = require("webpack-sources");
  14. const Compilation = require("../Compilation");
  15. const CssModule = require("../CssModule");
  16. const { tryRunOrWebpackError } = require("../HookWebpackError");
  17. const HotUpdateChunk = require("../HotUpdateChunk");
  18. const { CSS_IMPORT_TYPE, CSS_TYPE } = require("../ModuleSourceTypeConstants");
  19. const {
  20. CSS_MODULE_TYPE,
  21. CSS_MODULE_TYPE_AUTO,
  22. CSS_MODULE_TYPE_GLOBAL,
  23. CSS_MODULE_TYPE_MODULE
  24. } = require("../ModuleTypeConstants");
  25. const NormalModule = require("../NormalModule");
  26. const RuntimeGlobals = require("../RuntimeGlobals");
  27. const Template = require("../Template");
  28. const WebpackError = require("../WebpackError");
  29. const CssIcssExportDependency = require("../dependencies/CssIcssExportDependency");
  30. const CssIcssImportDependency = require("../dependencies/CssIcssImportDependency");
  31. const CssIcssSymbolDependency = require("../dependencies/CssIcssSymbolDependency");
  32. const CssImportDependency = require("../dependencies/CssImportDependency");
  33. const CssUrlDependency = require("../dependencies/CssUrlDependency");
  34. const StaticExportsDependency = require("../dependencies/StaticExportsDependency");
  35. const JavascriptModulesPlugin = require("../javascript/JavascriptModulesPlugin");
  36. const { compareModulesByIdOrIdentifier } = require("../util/comparators");
  37. const createSchemaValidation = require("../util/create-schema-validation");
  38. const createHash = require("../util/createHash");
  39. const { getUndoPath } = require("../util/identifier");
  40. const memoize = require("../util/memoize");
  41. const nonNumericOnlyHash = require("../util/nonNumericOnlyHash");
  42. const removeBOM = require("../util/removeBOM");
  43. const CssGenerator = require("./CssGenerator");
  44. const CssMergeStyleSheetsRuntimeModule = require("./CssMergeStyleSheetsRuntimeModule");
  45. const CssParser = require("./CssParser");
  46. /** @typedef {import("webpack-sources").Source} Source */
  47. /** @typedef {import("../config/defaults").OutputNormalizedWithDefaults} OutputOptions */
  48. /** @typedef {import("../Chunk")} Chunk */
  49. /** @typedef {import("../ChunkGraph")} ChunkGraph */
  50. /** @typedef {import("../CodeGenerationResults")} CodeGenerationResults */
  51. /** @typedef {import("../Compilation").ChunkHashContext} ChunkHashContext */
  52. /** @typedef {import("../Compiler")} Compiler */
  53. /** @typedef {import("../CssModule").Inheritance} Inheritance */
  54. /** @typedef {import("../CssModule").CSSModuleCreateData} CSSModuleCreateData */
  55. /** @typedef {import("../Module")} Module */
  56. /** @typedef {import("../Module").BuildInfo} BuildInfo */
  57. /** @typedef {import("../Module").RuntimeRequirements} RuntimeRequirements */
  58. /** @typedef {import("../Template").RuntimeTemplate} RuntimeTemplate */
  59. /** @typedef {import("../TemplatedPathPlugin").TemplatePath} TemplatePath */
  60. /** @typedef {import("../util/Hash")} Hash */
  61. /** @typedef {import("../Module").BuildMeta} BuildMeta */
  62. /**
  63. * @typedef {object} RenderContext
  64. * @property {Chunk} chunk the chunk
  65. * @property {ChunkGraph} chunkGraph the chunk graph
  66. * @property {CodeGenerationResults} codeGenerationResults results of code generation
  67. * @property {RuntimeTemplate} runtimeTemplate the runtime template
  68. * @property {string} uniqueName the unique name
  69. * @property {string} undoPath undo path to css file
  70. * @property {CssModule[]} modules modules
  71. */
  72. /**
  73. * @typedef {object} ChunkRenderContext
  74. * @property {Chunk=} chunk the chunk
  75. * @property {ChunkGraph=} chunkGraph the chunk graph
  76. * @property {CodeGenerationResults=} codeGenerationResults results of code generation
  77. * @property {RuntimeTemplate} runtimeTemplate the runtime template
  78. * @property {string} undoPath undo path to css file
  79. * @property {WeakMap<Source, ModuleFactoryCacheEntry>} moduleFactoryCache moduleFactoryCache
  80. * @property {Source} moduleSourceContent content
  81. */
  82. /**
  83. * @typedef {object} CompilationHooks
  84. * @property {SyncWaterfallHook<[Source, Module, ChunkRenderContext]>} renderModulePackage
  85. * @property {SyncHook<[Chunk, Hash, ChunkHashContext]>} chunkHash
  86. */
  87. /**
  88. * @typedef {object} ModuleFactoryCacheEntry
  89. * @property {string} undoPath - The undo path to the CSS file
  90. * @property {Inheritance} inheritance - The inheritance chain
  91. * @property {CachedSource} source - The cached source
  92. */
  93. const getCssLoadingRuntimeModule = memoize(() =>
  94. require("./CssLoadingRuntimeModule")
  95. );
  96. /**
  97. * @param {string} name name
  98. * @returns {{ oneOf: [{ $ref: string }], definitions: import("../../schemas/WebpackOptions.json")["definitions"] }} schema
  99. */
  100. const getSchema = (name) => {
  101. const { definitions } = require("../../schemas/WebpackOptions.json");
  102. return {
  103. definitions,
  104. oneOf: [{ $ref: `#/definitions/${name}` }]
  105. };
  106. };
  107. const generatorValidationOptions = {
  108. name: "Css Modules Plugin",
  109. baseDataPath: "generator"
  110. };
  111. const validateGeneratorOptions = {
  112. css: createSchemaValidation(
  113. require("../../schemas/plugins/css/CssGeneratorOptions.check"),
  114. () => getSchema("CssGeneratorOptions"),
  115. generatorValidationOptions
  116. ),
  117. "css/auto": createSchemaValidation(
  118. require("../../schemas/plugins/css/CssModuleGeneratorOptions.check"),
  119. () => getSchema("CssModuleGeneratorOptions"),
  120. generatorValidationOptions
  121. ),
  122. "css/module": createSchemaValidation(
  123. require("../../schemas/plugins/css/CssModuleGeneratorOptions.check"),
  124. () => getSchema("CssModuleGeneratorOptions"),
  125. generatorValidationOptions
  126. ),
  127. "css/global": createSchemaValidation(
  128. require("../../schemas/plugins/css/CssModuleGeneratorOptions.check"),
  129. () => getSchema("CssModuleGeneratorOptions"),
  130. generatorValidationOptions
  131. )
  132. };
  133. const parserValidationOptions = {
  134. name: "Css Modules Plugin",
  135. baseDataPath: "parser"
  136. };
  137. const validateParserOptions = {
  138. css: createSchemaValidation(
  139. require("../../schemas/plugins/css/CssParserOptions.check"),
  140. () => getSchema("CssParserOptions"),
  141. parserValidationOptions
  142. ),
  143. "css/auto": createSchemaValidation(
  144. require("../../schemas/plugins/css/CssModuleParserOptions.check"),
  145. () => getSchema("CssModuleParserOptions"),
  146. parserValidationOptions
  147. ),
  148. "css/module": createSchemaValidation(
  149. require("../../schemas/plugins/css/CssModuleParserOptions.check"),
  150. () => getSchema("CssModuleParserOptions"),
  151. parserValidationOptions
  152. ),
  153. "css/global": createSchemaValidation(
  154. require("../../schemas/plugins/css/CssModuleParserOptions.check"),
  155. () => getSchema("CssModuleParserOptions"),
  156. parserValidationOptions
  157. )
  158. };
  159. /** @type {WeakMap<Compilation, CompilationHooks>} */
  160. const compilationHooksMap = new WeakMap();
  161. const PLUGIN_NAME = "CssModulesPlugin";
  162. class CssModulesPlugin {
  163. /**
  164. * @param {Compilation} compilation the compilation
  165. * @returns {CompilationHooks} the attached hooks
  166. */
  167. static getCompilationHooks(compilation) {
  168. if (!(compilation instanceof Compilation)) {
  169. throw new TypeError(
  170. "The 'compilation' argument must be an instance of Compilation"
  171. );
  172. }
  173. let hooks = compilationHooksMap.get(compilation);
  174. if (hooks === undefined) {
  175. hooks = {
  176. renderModulePackage: new SyncWaterfallHook([
  177. "source",
  178. "module",
  179. "renderContext"
  180. ]),
  181. chunkHash: new SyncHook(["chunk", "hash", "context"])
  182. };
  183. compilationHooksMap.set(compilation, hooks);
  184. }
  185. return hooks;
  186. }
  187. constructor() {
  188. /** @type {WeakMap<Source, ModuleFactoryCacheEntry>} */
  189. this._moduleFactoryCache = new WeakMap();
  190. }
  191. /**
  192. * Apply the plugin
  193. * @param {Compiler} compiler the compiler instance
  194. * @returns {void}
  195. */
  196. apply(compiler) {
  197. compiler.hooks.compilation.tap(
  198. PLUGIN_NAME,
  199. (compilation, { normalModuleFactory }) => {
  200. const hooks = CssModulesPlugin.getCompilationHooks(compilation);
  201. compilation.dependencyFactories.set(
  202. CssImportDependency,
  203. normalModuleFactory
  204. );
  205. compilation.dependencyTemplates.set(
  206. CssImportDependency,
  207. new CssImportDependency.Template()
  208. );
  209. compilation.dependencyFactories.set(
  210. CssUrlDependency,
  211. normalModuleFactory
  212. );
  213. compilation.dependencyTemplates.set(
  214. CssUrlDependency,
  215. new CssUrlDependency.Template()
  216. );
  217. compilation.dependencyFactories.set(
  218. CssIcssImportDependency,
  219. normalModuleFactory
  220. );
  221. compilation.dependencyTemplates.set(
  222. CssIcssImportDependency,
  223. new CssIcssImportDependency.Template()
  224. );
  225. compilation.dependencyTemplates.set(
  226. CssIcssExportDependency,
  227. new CssIcssExportDependency.Template()
  228. );
  229. compilation.dependencyTemplates.set(
  230. CssIcssSymbolDependency,
  231. new CssIcssSymbolDependency.Template()
  232. );
  233. compilation.dependencyTemplates.set(
  234. StaticExportsDependency,
  235. new StaticExportsDependency.Template()
  236. );
  237. for (const type of [
  238. CSS_MODULE_TYPE,
  239. CSS_MODULE_TYPE_GLOBAL,
  240. CSS_MODULE_TYPE_MODULE,
  241. CSS_MODULE_TYPE_AUTO
  242. ]) {
  243. normalModuleFactory.hooks.createParser
  244. .for(type)
  245. .tap(PLUGIN_NAME, (parserOptions) => {
  246. switch (type) {
  247. case CSS_MODULE_TYPE:
  248. validateParserOptions[type](parserOptions);
  249. return new CssParser(parserOptions);
  250. case CSS_MODULE_TYPE_GLOBAL:
  251. validateParserOptions[type](parserOptions);
  252. return new CssParser({
  253. defaultMode: "global",
  254. ...parserOptions
  255. });
  256. case CSS_MODULE_TYPE_MODULE:
  257. validateParserOptions[type](parserOptions);
  258. return new CssParser({
  259. defaultMode: "local",
  260. ...parserOptions
  261. });
  262. case CSS_MODULE_TYPE_AUTO:
  263. validateParserOptions[type](parserOptions);
  264. return new CssParser({
  265. defaultMode: "auto",
  266. ...parserOptions
  267. });
  268. }
  269. });
  270. normalModuleFactory.hooks.createGenerator
  271. .for(type)
  272. .tap(PLUGIN_NAME, (generatorOptions) => {
  273. validateGeneratorOptions[type](generatorOptions);
  274. return new CssGenerator(
  275. generatorOptions,
  276. compilation.moduleGraph
  277. );
  278. });
  279. normalModuleFactory.hooks.createModuleClass
  280. .for(type)
  281. .tap(PLUGIN_NAME, (createData, resolveData) => {
  282. if (resolveData.dependencies.length > 0) {
  283. // When CSS is imported from CSS there is only one dependency
  284. const dependency = resolveData.dependencies[0];
  285. if (dependency instanceof CssImportDependency) {
  286. const parent =
  287. /** @type {CssModule} */
  288. (compilation.moduleGraph.getParentModule(dependency));
  289. if (parent instanceof CssModule) {
  290. /** @type {import("../CssModule").Inheritance | undefined} */
  291. let inheritance;
  292. if (
  293. parent.cssLayer !== undefined ||
  294. parent.supports ||
  295. parent.media
  296. ) {
  297. if (!inheritance) {
  298. inheritance = [];
  299. }
  300. inheritance.push([
  301. parent.cssLayer,
  302. parent.supports,
  303. parent.media
  304. ]);
  305. }
  306. if (parent.inheritance) {
  307. if (!inheritance) {
  308. inheritance = [];
  309. }
  310. inheritance.push(...parent.inheritance);
  311. }
  312. return new CssModule(
  313. /** @type {CSSModuleCreateData} */
  314. ({
  315. ...createData,
  316. cssLayer: dependency.layer,
  317. supports: dependency.supports,
  318. media: dependency.media,
  319. inheritance
  320. })
  321. );
  322. }
  323. return new CssModule(
  324. /** @type {CSSModuleCreateData} */
  325. ({
  326. ...createData,
  327. cssLayer: dependency.layer,
  328. supports: dependency.supports,
  329. media: dependency.media
  330. })
  331. );
  332. }
  333. }
  334. return new CssModule(
  335. /** @type {CSSModuleCreateData} */
  336. (createData)
  337. );
  338. });
  339. NormalModule.getCompilationHooks(compilation).processResult.tap(
  340. PLUGIN_NAME,
  341. (result, module) => {
  342. if (module.type === type) {
  343. const [source, ...rest] = result;
  344. return [removeBOM(source), ...rest];
  345. }
  346. return result;
  347. }
  348. );
  349. }
  350. JavascriptModulesPlugin.getCompilationHooks(
  351. compilation
  352. ).renderModuleContent.tap(PLUGIN_NAME, (source, module) => {
  353. if (module instanceof CssModule && module.hot) {
  354. const cssData = /** @type {BuildInfo} */ (module.buildInfo).cssData;
  355. if (!cssData) {
  356. return source;
  357. }
  358. const exports = cssData.exports;
  359. const stringifiedExports = JSON.stringify(
  360. JSON.stringify(
  361. [...exports].reduce((obj, [key, value]) => {
  362. obj[key] = value;
  363. return obj;
  364. }, /** @type {Record<string, string>} */ ({}))
  365. )
  366. );
  367. const hmrCode = Template.asString([
  368. "",
  369. `var __webpack_css_exports__ = ${stringifiedExports};`,
  370. "// only invalidate when locals change",
  371. "if (module.hot.data && module.hot.data.__webpack_css_exports__ && module.hot.data.__webpack_css_exports__ != __webpack_css_exports__) {",
  372. Template.indent("module.hot.invalidate();"),
  373. "} else {",
  374. Template.indent("module.hot.accept();"),
  375. "}",
  376. "module.hot.dispose(function(data) { data.__webpack_css_exports__ = __webpack_css_exports__; });"
  377. ]);
  378. return new ConcatSource(source, "\n", new RawSource(hmrCode));
  379. }
  380. return source;
  381. });
  382. const orderedCssModulesPerChunk = new WeakMap();
  383. compilation.hooks.afterCodeGeneration.tap(PLUGIN_NAME, () => {
  384. const { chunkGraph } = compilation;
  385. for (const chunk of compilation.chunks) {
  386. if (CssModulesPlugin.chunkHasCss(chunk, chunkGraph)) {
  387. orderedCssModulesPerChunk.set(
  388. chunk,
  389. this.getOrderedChunkCssModules(chunk, chunkGraph, compilation)
  390. );
  391. }
  392. }
  393. });
  394. compilation.hooks.chunkHash.tap(PLUGIN_NAME, (chunk, hash, context) => {
  395. hooks.chunkHash.call(chunk, hash, context);
  396. });
  397. compilation.hooks.contentHash.tap(PLUGIN_NAME, (chunk) => {
  398. const {
  399. chunkGraph,
  400. moduleGraph,
  401. runtimeTemplate,
  402. outputOptions: {
  403. hashSalt,
  404. hashDigest,
  405. hashDigestLength,
  406. hashFunction
  407. }
  408. } = compilation;
  409. const hash = createHash(hashFunction);
  410. if (hashSalt) hash.update(hashSalt);
  411. const codeGenerationResults =
  412. /** @type {CodeGenerationResults} */
  413. (compilation.codeGenerationResults);
  414. hooks.chunkHash.call(chunk, hash, {
  415. chunkGraph,
  416. codeGenerationResults,
  417. moduleGraph,
  418. runtimeTemplate
  419. });
  420. const modules = orderedCssModulesPerChunk.get(chunk);
  421. if (modules) {
  422. for (const module of modules) {
  423. hash.update(chunkGraph.getModuleHash(module, chunk.runtime));
  424. }
  425. }
  426. const digest = hash.digest(hashDigest);
  427. chunk.contentHash.css = nonNumericOnlyHash(digest, hashDigestLength);
  428. });
  429. compilation.hooks.renderManifest.tap(PLUGIN_NAME, (result, options) => {
  430. const { chunkGraph } = compilation;
  431. const { hash, chunk, codeGenerationResults, runtimeTemplate } =
  432. options;
  433. if (chunk instanceof HotUpdateChunk) return result;
  434. /** @type {CssModule[] | undefined} */
  435. const modules = orderedCssModulesPerChunk.get(chunk);
  436. if (modules !== undefined) {
  437. const { path: filename, info } = compilation.getPathWithInfo(
  438. CssModulesPlugin.getChunkFilenameTemplate(
  439. chunk,
  440. compilation.outputOptions
  441. ),
  442. {
  443. hash,
  444. runtime: chunk.runtime,
  445. chunk,
  446. contentHashType: "css"
  447. }
  448. );
  449. const undoPath = getUndoPath(
  450. filename,
  451. compilation.outputOptions.path,
  452. false
  453. );
  454. result.push({
  455. render: () =>
  456. this.renderChunk(
  457. {
  458. chunk,
  459. chunkGraph,
  460. codeGenerationResults,
  461. uniqueName: compilation.outputOptions.uniqueName,
  462. undoPath,
  463. modules,
  464. runtimeTemplate
  465. },
  466. hooks
  467. ),
  468. filename,
  469. info,
  470. identifier: `css${chunk.id}`,
  471. hash: chunk.contentHash.css
  472. });
  473. }
  474. return result;
  475. });
  476. const globalChunkLoading = compilation.outputOptions.chunkLoading;
  477. /**
  478. * @param {Chunk} chunk the chunk
  479. * @returns {boolean} true, when enabled
  480. */
  481. const isEnabledForChunk = (chunk) => {
  482. const options = chunk.getEntryOptions();
  483. const chunkLoading =
  484. options && options.chunkLoading !== undefined
  485. ? options.chunkLoading
  486. : globalChunkLoading;
  487. return chunkLoading === "jsonp" || chunkLoading === "import";
  488. };
  489. const onceForChunkSet = new WeakSet();
  490. /**
  491. * @param {Chunk} chunk chunk to check
  492. * @param {RuntimeRequirements} set runtime requirements
  493. */
  494. const handler = (chunk, set) => {
  495. if (onceForChunkSet.has(chunk)) return;
  496. onceForChunkSet.add(chunk);
  497. if (!isEnabledForChunk(chunk)) return;
  498. const CssLoadingRuntimeModule = getCssLoadingRuntimeModule();
  499. compilation.addRuntimeModule(chunk, new CssLoadingRuntimeModule(set));
  500. };
  501. compilation.hooks.runtimeRequirementInTree
  502. .for(RuntimeGlobals.hasCssModules)
  503. .tap(PLUGIN_NAME, handler);
  504. compilation.hooks.runtimeRequirementInTree
  505. .for(RuntimeGlobals.ensureChunkHandlers)
  506. .tap(PLUGIN_NAME, (chunk, set, { chunkGraph }) => {
  507. if (!isEnabledForChunk(chunk)) return;
  508. if (
  509. !chunkGraph.hasModuleInGraph(
  510. chunk,
  511. (m) =>
  512. m.type === CSS_MODULE_TYPE ||
  513. m.type === CSS_MODULE_TYPE_GLOBAL ||
  514. m.type === CSS_MODULE_TYPE_MODULE ||
  515. m.type === CSS_MODULE_TYPE_AUTO
  516. )
  517. ) {
  518. return;
  519. }
  520. set.add(RuntimeGlobals.hasOwnProperty);
  521. set.add(RuntimeGlobals.publicPath);
  522. set.add(RuntimeGlobals.getChunkCssFilename);
  523. });
  524. compilation.hooks.runtimeRequirementInTree
  525. .for(RuntimeGlobals.hmrDownloadUpdateHandlers)
  526. .tap(PLUGIN_NAME, (chunk, set, { chunkGraph }) => {
  527. if (!isEnabledForChunk(chunk)) return;
  528. if (
  529. !chunkGraph.hasModuleInGraph(
  530. chunk,
  531. (m) =>
  532. m.type === CSS_MODULE_TYPE ||
  533. m.type === CSS_MODULE_TYPE_GLOBAL ||
  534. m.type === CSS_MODULE_TYPE_MODULE ||
  535. m.type === CSS_MODULE_TYPE_AUTO
  536. )
  537. ) {
  538. return;
  539. }
  540. set.add(RuntimeGlobals.publicPath);
  541. set.add(RuntimeGlobals.getChunkCssFilename);
  542. });
  543. compilation.hooks.runtimeRequirementInTree
  544. .for(RuntimeGlobals.cssMergeStyleSheets)
  545. .tap(PLUGIN_NAME, (chunk) => {
  546. compilation.addRuntimeModule(
  547. chunk,
  548. new CssMergeStyleSheetsRuntimeModule()
  549. );
  550. });
  551. }
  552. );
  553. }
  554. /**
  555. * @param {Chunk} chunk chunk
  556. * @param {Iterable<Module>} modules unordered modules
  557. * @param {Compilation} compilation compilation
  558. * @returns {Module[]} ordered modules
  559. */
  560. getModulesInOrder(chunk, modules, compilation) {
  561. if (!modules) return [];
  562. /** @type {Module[]} */
  563. const modulesList = [...modules];
  564. // Get ordered list of modules per chunk group
  565. // Lists are in reverse order to allow to use Array.pop()
  566. const modulesByChunkGroup = Array.from(
  567. chunk.groupsIterable,
  568. (chunkGroup) => {
  569. const sortedModules = modulesList
  570. .map((module) => ({
  571. module,
  572. index: chunkGroup.getModulePostOrderIndex(module)
  573. }))
  574. .filter((item) => item.index !== undefined)
  575. .sort(
  576. (a, b) =>
  577. /** @type {number} */ (b.index) - /** @type {number} */ (a.index)
  578. )
  579. .map((item) => item.module);
  580. return { list: sortedModules, set: new Set(sortedModules) };
  581. }
  582. );
  583. if (modulesByChunkGroup.length === 1) {
  584. return modulesByChunkGroup[0].list.reverse();
  585. }
  586. const boundCompareModulesByIdOrIdentifier = compareModulesByIdOrIdentifier(
  587. compilation.chunkGraph
  588. );
  589. /**
  590. * @param {{ list: Module[] }} a a
  591. * @param {{ list: Module[] }} b b
  592. * @returns {-1 | 0 | 1} result
  593. */
  594. const compareModuleLists = ({ list: a }, { list: b }) => {
  595. if (a.length === 0) {
  596. return b.length === 0 ? 0 : 1;
  597. }
  598. if (b.length === 0) return -1;
  599. return boundCompareModulesByIdOrIdentifier(
  600. a[a.length - 1],
  601. b[b.length - 1]
  602. );
  603. };
  604. modulesByChunkGroup.sort(compareModuleLists);
  605. /** @type {Module[]} */
  606. const finalModules = [];
  607. for (;;) {
  608. const failedModules = new Set();
  609. const list = modulesByChunkGroup[0].list;
  610. if (list.length === 0) {
  611. // done, everything empty
  612. break;
  613. }
  614. /** @type {Module} */
  615. let selectedModule = list[list.length - 1];
  616. let hasFailed;
  617. outer: for (;;) {
  618. for (const { list, set } of modulesByChunkGroup) {
  619. if (list.length === 0) continue;
  620. const lastModule = list[list.length - 1];
  621. if (lastModule === selectedModule) continue;
  622. if (!set.has(selectedModule)) continue;
  623. failedModules.add(selectedModule);
  624. if (failedModules.has(lastModule)) {
  625. // There is a conflict, try other alternatives
  626. hasFailed = lastModule;
  627. continue;
  628. }
  629. selectedModule = lastModule;
  630. hasFailed = false;
  631. continue outer; // restart
  632. }
  633. break;
  634. }
  635. if (hasFailed) {
  636. // There is a not resolve-able conflict with the selectedModule
  637. // TODO print better warning
  638. compilation.warnings.push(
  639. new WebpackError(
  640. `chunk ${chunk.name || chunk.id}\nConflicting order between ${
  641. /** @type {Module} */
  642. (hasFailed).readableIdentifier(compilation.requestShortener)
  643. } and ${selectedModule.readableIdentifier(
  644. compilation.requestShortener
  645. )}`
  646. )
  647. );
  648. selectedModule = /** @type {Module} */ (hasFailed);
  649. }
  650. // Insert the selected module into the final modules list
  651. finalModules.push(selectedModule);
  652. // Remove the selected module from all lists
  653. for (const { list, set } of modulesByChunkGroup) {
  654. const lastModule = list[list.length - 1];
  655. if (lastModule === selectedModule) {
  656. list.pop();
  657. } else if (hasFailed && set.has(selectedModule)) {
  658. const idx = list.indexOf(selectedModule);
  659. if (idx >= 0) list.splice(idx, 1);
  660. }
  661. }
  662. modulesByChunkGroup.sort(compareModuleLists);
  663. }
  664. return finalModules;
  665. }
  666. /**
  667. * @param {Chunk} chunk chunk
  668. * @param {ChunkGraph} chunkGraph chunk graph
  669. * @param {Compilation} compilation compilation
  670. * @returns {Module[]} ordered css modules
  671. */
  672. getOrderedChunkCssModules(chunk, chunkGraph, compilation) {
  673. return [
  674. ...this.getModulesInOrder(
  675. chunk,
  676. /** @type {Iterable<Module>} */
  677. (
  678. chunkGraph.getOrderedChunkModulesIterableBySourceType(
  679. chunk,
  680. CSS_IMPORT_TYPE,
  681. compareModulesByIdOrIdentifier(chunkGraph)
  682. )
  683. ),
  684. compilation
  685. ),
  686. ...this.getModulesInOrder(
  687. chunk,
  688. /** @type {Iterable<Module>} */
  689. (
  690. chunkGraph.getOrderedChunkModulesIterableBySourceType(
  691. chunk,
  692. CSS_TYPE,
  693. compareModulesByIdOrIdentifier(chunkGraph)
  694. )
  695. ),
  696. compilation
  697. )
  698. ];
  699. }
  700. /**
  701. * @param {CssModule} module css module
  702. * @param {ChunkRenderContext} renderContext options object
  703. * @param {CompilationHooks} hooks hooks
  704. * @returns {Source | null} css module source
  705. */
  706. static renderModule(module, renderContext, hooks) {
  707. const { undoPath, moduleFactoryCache, moduleSourceContent } = renderContext;
  708. const cacheEntry = moduleFactoryCache.get(moduleSourceContent);
  709. /** @type {Inheritance} */
  710. const inheritance = [[module.cssLayer, module.supports, module.media]];
  711. if (module.inheritance) {
  712. inheritance.push(...module.inheritance);
  713. }
  714. let source;
  715. if (
  716. cacheEntry &&
  717. cacheEntry.undoPath === undoPath &&
  718. cacheEntry.inheritance.every(([layer, supports, media], i) => {
  719. const item = inheritance[i];
  720. if (Array.isArray(item)) {
  721. return layer === item[0] && supports === item[1] && media === item[2];
  722. }
  723. return false;
  724. })
  725. ) {
  726. source = cacheEntry.source;
  727. } else {
  728. if (!moduleSourceContent) return null;
  729. const moduleSourceCode =
  730. /** @type {string} */
  731. (moduleSourceContent.source());
  732. const publicPathAutoRegex = new RegExp(
  733. CssUrlDependency.PUBLIC_PATH_AUTO,
  734. "g"
  735. );
  736. /** @type {Source} */
  737. let moduleSource = new ReplaceSource(moduleSourceContent);
  738. let match;
  739. while ((match = publicPathAutoRegex.exec(moduleSourceCode))) {
  740. /** @type {ReplaceSource} */ (moduleSource).replace(
  741. match.index,
  742. (match.index += match[0].length - 1),
  743. undoPath
  744. );
  745. }
  746. for (let i = 0; i < inheritance.length; i++) {
  747. const layer = inheritance[i][0];
  748. const supports = inheritance[i][1];
  749. const media = inheritance[i][2];
  750. if (media) {
  751. moduleSource = new ConcatSource(
  752. `@media ${media} {\n`,
  753. new PrefixSource("\t", moduleSource),
  754. "}\n"
  755. );
  756. }
  757. if (supports) {
  758. moduleSource = new ConcatSource(
  759. `@supports (${supports}) {\n`,
  760. new PrefixSource("\t", moduleSource),
  761. "}\n"
  762. );
  763. }
  764. // Layer can be anonymous
  765. if (layer !== undefined && layer !== null) {
  766. moduleSource = new ConcatSource(
  767. `@layer${layer ? ` ${layer}` : ""} {\n`,
  768. new PrefixSource("\t", moduleSource),
  769. "}\n"
  770. );
  771. }
  772. }
  773. if (moduleSource) {
  774. moduleSource = new ConcatSource(moduleSource, "\n");
  775. }
  776. source = new CachedSource(moduleSource);
  777. moduleFactoryCache.set(moduleSourceContent, {
  778. inheritance,
  779. undoPath,
  780. source
  781. });
  782. }
  783. return tryRunOrWebpackError(
  784. () => hooks.renderModulePackage.call(source, module, renderContext),
  785. "CssModulesPlugin.getCompilationHooks().renderModulePackage"
  786. );
  787. }
  788. /**
  789. * @param {RenderContext} renderContext the render context
  790. * @param {CompilationHooks} hooks hooks
  791. * @returns {Source} generated source
  792. */
  793. renderChunk(
  794. {
  795. undoPath,
  796. chunk,
  797. codeGenerationResults,
  798. modules,
  799. runtimeTemplate,
  800. chunkGraph
  801. },
  802. hooks
  803. ) {
  804. const source = new ConcatSource();
  805. for (const module of modules) {
  806. try {
  807. const codeGenResult = codeGenerationResults.get(module, chunk.runtime);
  808. const moduleSourceContent =
  809. /** @type {Source} */
  810. (
  811. codeGenResult.sources.get(CSS_TYPE) ||
  812. codeGenResult.sources.get(CSS_IMPORT_TYPE)
  813. );
  814. const moduleSource = CssModulesPlugin.renderModule(
  815. module,
  816. {
  817. undoPath,
  818. chunk,
  819. chunkGraph,
  820. codeGenerationResults,
  821. moduleSourceContent,
  822. moduleFactoryCache: this._moduleFactoryCache,
  823. runtimeTemplate
  824. },
  825. hooks
  826. );
  827. if (moduleSource) {
  828. source.add(moduleSource);
  829. }
  830. } catch (err) {
  831. /** @type {Error} */
  832. (err).message += `\nduring rendering of css ${module.identifier()}`;
  833. throw err;
  834. }
  835. }
  836. chunk.rendered = true;
  837. return source;
  838. }
  839. /**
  840. * @param {Chunk} chunk chunk
  841. * @param {OutputOptions} outputOptions output options
  842. * @returns {TemplatePath} used filename template
  843. */
  844. static getChunkFilenameTemplate(chunk, outputOptions) {
  845. if (chunk.cssFilenameTemplate) {
  846. return chunk.cssFilenameTemplate;
  847. } else if (chunk.canBeInitial()) {
  848. return outputOptions.cssFilename;
  849. }
  850. return outputOptions.cssChunkFilename;
  851. }
  852. /**
  853. * @param {Chunk} chunk chunk
  854. * @param {ChunkGraph} chunkGraph chunk graph
  855. * @returns {boolean} true, when the chunk has css
  856. */
  857. static chunkHasCss(chunk, chunkGraph) {
  858. return (
  859. Boolean(
  860. chunkGraph.getChunkModulesIterableBySourceType(chunk, CSS_TYPE)
  861. ) ||
  862. Boolean(
  863. chunkGraph.getChunkModulesIterableBySourceType(chunk, CSS_IMPORT_TYPE)
  864. )
  865. );
  866. }
  867. }
  868. module.exports = CssModulesPlugin;