CssModulesPlugin.js 27 KB

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