CssModulesPlugin.js 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919
  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").OutputNormalized} OutputOptions */
  49. /** @typedef {import("../Chunk")} Chunk */
  50. /** @typedef {import("../ChunkGraph")} ChunkGraph */
  51. /** @typedef {import("../CodeGenerationResults")} CodeGenerationResults */
  52. /** @typedef {import("../Compilation").ChunkHashContext} ChunkHashContext */
  53. /** @typedef {import("../Compiler")} Compiler */
  54. /** @typedef {import("../CssModule").Inheritance} Inheritance */
  55. /** @typedef {import("../Module")} Module */
  56. /** @typedef {import("../Module").BuildInfo} BuildInfo */
  57. /** @typedef {import("../Template").RuntimeTemplate} RuntimeTemplate */
  58. /** @typedef {import("../TemplatedPathPlugin").TemplatePath} TemplatePath */
  59. /** @typedef {import("../util/Hash")} Hash */
  60. /** @typedef {import("../util/createHash").Algorithm} Algorithm */
  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 exports =
  359. /** @type {BuildInfo} */
  360. (module.buildInfo).cssData.exports;
  361. const stringifiedExports = JSON.stringify(
  362. JSON.stringify(
  363. Array.from(exports).reduce((obj, [key, value]) => {
  364. obj[key] = value;
  365. return obj;
  366. }, {})
  367. )
  368. );
  369. const hmrCode = Template.asString([
  370. "",
  371. `var __webpack_css_exports__ = ${stringifiedExports};`,
  372. "// only invalidate when locals change",
  373. "if (module.hot.data && module.hot.data.__webpack_css_exports__ && module.hot.data.__webpack_css_exports__ != __webpack_css_exports__) {",
  374. Template.indent("module.hot.invalidate();"),
  375. "} else {",
  376. Template.indent("module.hot.accept();"),
  377. "}",
  378. "module.hot.dispose(function(data) { data.__webpack_css_exports__ = __webpack_css_exports__; });"
  379. ]);
  380. return new ConcatSource(source, "\n", new RawSource(hmrCode));
  381. }
  382. return source;
  383. });
  384. const orderedCssModulesPerChunk = new WeakMap();
  385. compilation.hooks.afterCodeGeneration.tap(PLUGIN_NAME, () => {
  386. const { chunkGraph } = compilation;
  387. for (const chunk of compilation.chunks) {
  388. if (CssModulesPlugin.chunkHasCss(chunk, chunkGraph)) {
  389. orderedCssModulesPerChunk.set(
  390. chunk,
  391. this.getOrderedChunkCssModules(chunk, chunkGraph, compilation)
  392. );
  393. }
  394. }
  395. });
  396. compilation.hooks.chunkHash.tap(PLUGIN_NAME, (chunk, hash, context) => {
  397. hooks.chunkHash.call(chunk, hash, context);
  398. });
  399. compilation.hooks.contentHash.tap(PLUGIN_NAME, chunk => {
  400. const {
  401. chunkGraph,
  402. codeGenerationResults,
  403. moduleGraph,
  404. runtimeTemplate,
  405. outputOptions: {
  406. hashSalt,
  407. hashDigest,
  408. hashDigestLength,
  409. hashFunction
  410. }
  411. } = compilation;
  412. const hash = createHash(/** @type {Algorithm} */ (hashFunction));
  413. if (hashSalt) hash.update(hashSalt);
  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 = /** @type {string} */ (hash.digest(hashDigest));
  427. chunk.contentHash.css = nonNumericOnlyHash(
  428. digest,
  429. /** @type {number} */
  430. (hashDigestLength)
  431. );
  432. });
  433. compilation.hooks.renderManifest.tap(PLUGIN_NAME, (result, options) => {
  434. const { chunkGraph } = compilation;
  435. const { hash, chunk, codeGenerationResults, runtimeTemplate } =
  436. options;
  437. if (chunk instanceof HotUpdateChunk) return result;
  438. /** @type {CssModule[] | undefined} */
  439. const modules = orderedCssModulesPerChunk.get(chunk);
  440. if (modules !== undefined) {
  441. const { path: filename, info } = compilation.getPathWithInfo(
  442. CssModulesPlugin.getChunkFilenameTemplate(
  443. chunk,
  444. compilation.outputOptions
  445. ),
  446. {
  447. hash,
  448. runtime: chunk.runtime,
  449. chunk,
  450. contentHashType: "css"
  451. }
  452. );
  453. const undoPath = getUndoPath(
  454. filename,
  455. /** @type {string} */
  456. (compilation.outputOptions.path),
  457. false
  458. );
  459. result.push({
  460. render: () =>
  461. this.renderChunk(
  462. {
  463. chunk,
  464. chunkGraph,
  465. codeGenerationResults,
  466. uniqueName:
  467. /** @type {string} */
  468. (compilation.outputOptions.uniqueName),
  469. undoPath,
  470. modules,
  471. runtimeTemplate
  472. },
  473. hooks
  474. ),
  475. filename,
  476. info,
  477. identifier: `css${chunk.id}`,
  478. hash: chunk.contentHash.css
  479. });
  480. }
  481. return result;
  482. });
  483. const globalChunkLoading = compilation.outputOptions.chunkLoading;
  484. /**
  485. * @param {Chunk} chunk the chunk
  486. * @returns {boolean} true, when enabled
  487. */
  488. const isEnabledForChunk = chunk => {
  489. const options = chunk.getEntryOptions();
  490. const chunkLoading =
  491. options && options.chunkLoading !== undefined
  492. ? options.chunkLoading
  493. : globalChunkLoading;
  494. return chunkLoading === "jsonp" || chunkLoading === "import";
  495. };
  496. const onceForChunkSet = new WeakSet();
  497. /**
  498. * @param {Chunk} chunk chunk to check
  499. * @param {Set<string>} set runtime requirements
  500. */
  501. const handler = (chunk, set) => {
  502. if (onceForChunkSet.has(chunk)) return;
  503. onceForChunkSet.add(chunk);
  504. if (!isEnabledForChunk(chunk)) return;
  505. set.add(RuntimeGlobals.makeNamespaceObject);
  506. const CssLoadingRuntimeModule = getCssLoadingRuntimeModule();
  507. compilation.addRuntimeModule(chunk, new CssLoadingRuntimeModule(set));
  508. };
  509. compilation.hooks.runtimeRequirementInTree
  510. .for(RuntimeGlobals.hasCssModules)
  511. .tap(PLUGIN_NAME, handler);
  512. compilation.hooks.runtimeRequirementInTree
  513. .for(RuntimeGlobals.ensureChunkHandlers)
  514. .tap(PLUGIN_NAME, (chunk, set, { chunkGraph }) => {
  515. if (!isEnabledForChunk(chunk)) return;
  516. if (
  517. !chunkGraph.hasModuleInGraph(
  518. chunk,
  519. m =>
  520. m.type === CSS_MODULE_TYPE ||
  521. m.type === CSS_MODULE_TYPE_GLOBAL ||
  522. m.type === CSS_MODULE_TYPE_MODULE ||
  523. m.type === CSS_MODULE_TYPE_AUTO
  524. )
  525. ) {
  526. return;
  527. }
  528. set.add(RuntimeGlobals.hasOwnProperty);
  529. set.add(RuntimeGlobals.publicPath);
  530. set.add(RuntimeGlobals.getChunkCssFilename);
  531. });
  532. compilation.hooks.runtimeRequirementInTree
  533. .for(RuntimeGlobals.hmrDownloadUpdateHandlers)
  534. .tap(PLUGIN_NAME, (chunk, set, { chunkGraph }) => {
  535. if (!isEnabledForChunk(chunk)) return;
  536. if (
  537. !chunkGraph.hasModuleInGraph(
  538. chunk,
  539. m =>
  540. m.type === CSS_MODULE_TYPE ||
  541. m.type === CSS_MODULE_TYPE_GLOBAL ||
  542. m.type === CSS_MODULE_TYPE_MODULE ||
  543. m.type === CSS_MODULE_TYPE_AUTO
  544. )
  545. ) {
  546. return;
  547. }
  548. set.add(RuntimeGlobals.publicPath);
  549. set.add(RuntimeGlobals.getChunkCssFilename);
  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(chunk.groupsIterable, chunkGroup => {
  567. const sortedModules = modulesList
  568. .map(module => ({
  569. module,
  570. index: chunkGroup.getModulePostOrderIndex(module)
  571. }))
  572. .filter(item => item.index !== undefined)
  573. .sort(
  574. (a, b) =>
  575. /** @type {number} */ (b.index) - /** @type {number} */ (a.index)
  576. )
  577. .map(item => item.module);
  578. return { list: sortedModules, set: new Set(sortedModules) };
  579. });
  580. if (modulesByChunkGroup.length === 1)
  581. return modulesByChunkGroup[0].list.reverse();
  582. const boundCompareModulesByIdOrIdentifier = compareModulesByIdOrIdentifier(
  583. compilation.chunkGraph
  584. );
  585. /**
  586. * @param {{ list: Module[] }} a a
  587. * @param {{ list: Module[] }} b b
  588. * @returns {-1 | 0 | 1} result
  589. */
  590. const compareModuleLists = ({ list: a }, { list: b }) => {
  591. if (a.length === 0) {
  592. return b.length === 0 ? 0 : 1;
  593. }
  594. if (b.length === 0) return -1;
  595. return boundCompareModulesByIdOrIdentifier(
  596. a[a.length - 1],
  597. b[b.length - 1]
  598. );
  599. };
  600. modulesByChunkGroup.sort(compareModuleLists);
  601. /** @type {Module[]} */
  602. const finalModules = [];
  603. for (;;) {
  604. const failedModules = new Set();
  605. const list = modulesByChunkGroup[0].list;
  606. if (list.length === 0) {
  607. // done, everything empty
  608. break;
  609. }
  610. /** @type {Module} */
  611. let selectedModule = list[list.length - 1];
  612. let hasFailed;
  613. outer: for (;;) {
  614. for (const { list, set } of modulesByChunkGroup) {
  615. if (list.length === 0) continue;
  616. const lastModule = list[list.length - 1];
  617. if (lastModule === selectedModule) continue;
  618. if (!set.has(selectedModule)) continue;
  619. failedModules.add(selectedModule);
  620. if (failedModules.has(lastModule)) {
  621. // There is a conflict, try other alternatives
  622. hasFailed = lastModule;
  623. continue;
  624. }
  625. selectedModule = lastModule;
  626. hasFailed = false;
  627. continue outer; // restart
  628. }
  629. break;
  630. }
  631. if (hasFailed) {
  632. // There is a not resolve-able conflict with the selectedModule
  633. // TODO print better warning
  634. compilation.warnings.push(
  635. new WebpackError(
  636. `chunk ${chunk.name || chunk.id}\nConflicting order between ${
  637. /** @type {Module} */
  638. (hasFailed).readableIdentifier(compilation.requestShortener)
  639. } and ${selectedModule.readableIdentifier(
  640. compilation.requestShortener
  641. )}`
  642. )
  643. );
  644. selectedModule = /** @type {Module} */ (hasFailed);
  645. }
  646. // Insert the selected module into the final modules list
  647. finalModules.push(selectedModule);
  648. // Remove the selected module from all lists
  649. for (const { list, set } of modulesByChunkGroup) {
  650. const lastModule = list[list.length - 1];
  651. if (lastModule === selectedModule) list.pop();
  652. else if (hasFailed && set.has(selectedModule)) {
  653. const idx = list.indexOf(selectedModule);
  654. if (idx >= 0) list.splice(idx, 1);
  655. }
  656. }
  657. modulesByChunkGroup.sort(compareModuleLists);
  658. }
  659. return finalModules;
  660. }
  661. /**
  662. * @param {Chunk} chunk chunk
  663. * @param {ChunkGraph} chunkGraph chunk graph
  664. * @param {Compilation} compilation compilation
  665. * @returns {Module[]} ordered css modules
  666. */
  667. getOrderedChunkCssModules(chunk, chunkGraph, compilation) {
  668. return [
  669. ...this.getModulesInOrder(
  670. chunk,
  671. /** @type {Iterable<Module>} */
  672. (
  673. chunkGraph.getOrderedChunkModulesIterableBySourceType(
  674. chunk,
  675. "css-import",
  676. compareModulesByIdOrIdentifier(chunkGraph)
  677. )
  678. ),
  679. compilation
  680. ),
  681. ...this.getModulesInOrder(
  682. chunk,
  683. /** @type {Iterable<Module>} */
  684. (
  685. chunkGraph.getOrderedChunkModulesIterableBySourceType(
  686. chunk,
  687. "css",
  688. compareModulesByIdOrIdentifier(chunkGraph)
  689. )
  690. ),
  691. compilation
  692. )
  693. ];
  694. }
  695. /**
  696. * @param {CssModule} module css module
  697. * @param {ChunkRenderContext} renderContext options object
  698. * @param {CompilationHooks} hooks hooks
  699. * @returns {Source} css module source
  700. */
  701. renderModule(module, renderContext, hooks) {
  702. const { codeGenerationResults, chunk, undoPath } = renderContext;
  703. const codeGenResult = codeGenerationResults.get(module, chunk.runtime);
  704. const moduleSourceContent =
  705. /** @type {Source} */
  706. (
  707. codeGenResult.sources.get("css") ||
  708. codeGenResult.sources.get("css-import")
  709. );
  710. const cacheEntry = this._moduleFactoryCache.get(moduleSourceContent);
  711. /** @type {Inheritance} */
  712. const inheritance = [[module.cssLayer, module.supports, module.media]];
  713. if (module.inheritance) {
  714. inheritance.push(...module.inheritance);
  715. }
  716. let source;
  717. if (
  718. cacheEntry &&
  719. cacheEntry.undoPath === undoPath &&
  720. cacheEntry.inheritance.every(([layer, supports, media], i) => {
  721. const item = inheritance[i];
  722. if (Array.isArray(item)) {
  723. return layer === item[0] && supports === item[1] && media === item[2];
  724. }
  725. return false;
  726. })
  727. ) {
  728. source = cacheEntry.source;
  729. } else {
  730. const moduleSourceCode =
  731. /** @type {string} */
  732. (moduleSourceContent.source());
  733. const publicPathAutoRegex = new RegExp(
  734. CssUrlDependency.PUBLIC_PATH_AUTO,
  735. "g"
  736. );
  737. /** @type {Source} */
  738. let moduleSource = new ReplaceSource(moduleSourceContent);
  739. let match;
  740. while ((match = publicPathAutoRegex.exec(moduleSourceCode))) {
  741. /** @type {ReplaceSource} */ (moduleSource).replace(
  742. match.index,
  743. (match.index += match[0].length - 1),
  744. undoPath
  745. );
  746. }
  747. for (let i = 0; i < inheritance.length; i++) {
  748. const layer = inheritance[i][0];
  749. const supports = inheritance[i][1];
  750. const media = inheritance[i][2];
  751. if (media) {
  752. moduleSource = new ConcatSource(
  753. `@media ${media} {\n`,
  754. new PrefixSource("\t", moduleSource),
  755. "}\n"
  756. );
  757. }
  758. if (supports) {
  759. moduleSource = new ConcatSource(
  760. `@supports (${supports}) {\n`,
  761. new PrefixSource("\t", moduleSource),
  762. "}\n"
  763. );
  764. }
  765. // Layer can be anonymous
  766. if (layer !== undefined && layer !== null) {
  767. moduleSource = new ConcatSource(
  768. `@layer${layer ? ` ${layer}` : ""} {\n`,
  769. new PrefixSource("\t", moduleSource),
  770. "}\n"
  771. );
  772. }
  773. }
  774. if (moduleSource) {
  775. moduleSource = new ConcatSource(moduleSource, "\n");
  776. }
  777. source = new CachedSource(moduleSource);
  778. this._moduleFactoryCache.set(moduleSourceContent, {
  779. inheritance,
  780. undoPath,
  781. source
  782. });
  783. }
  784. return tryRunOrWebpackError(
  785. () => hooks.renderModulePackage.call(source, module, renderContext),
  786. "CssModulesPlugin.getCompilationHooks().renderModulePackage"
  787. );
  788. }
  789. /**
  790. * @param {RenderContext} renderContext the render context
  791. * @param {CompilationHooks} hooks hooks
  792. * @returns {Source} generated source
  793. */
  794. renderChunk(
  795. {
  796. undoPath,
  797. chunk,
  798. chunkGraph,
  799. codeGenerationResults,
  800. modules,
  801. runtimeTemplate
  802. },
  803. hooks
  804. ) {
  805. const source = new ConcatSource();
  806. for (const module of modules) {
  807. try {
  808. const moduleSource = this.renderModule(
  809. module,
  810. {
  811. undoPath,
  812. chunk,
  813. chunkGraph,
  814. codeGenerationResults,
  815. runtimeTemplate
  816. },
  817. hooks
  818. );
  819. source.add(moduleSource);
  820. } catch (err) {
  821. /** @type {Error} */
  822. (err).message += `\nduring rendering of css ${module.identifier()}`;
  823. throw err;
  824. }
  825. }
  826. chunk.rendered = true;
  827. return source;
  828. }
  829. /**
  830. * @param {Chunk} chunk chunk
  831. * @param {OutputOptions} outputOptions output options
  832. * @returns {TemplatePath} used filename template
  833. */
  834. static getChunkFilenameTemplate(chunk, outputOptions) {
  835. if (chunk.cssFilenameTemplate) {
  836. return chunk.cssFilenameTemplate;
  837. } else if (chunk.canBeInitial()) {
  838. return /** @type {TemplatePath} */ (outputOptions.cssFilename);
  839. }
  840. return /** @type {TemplatePath} */ (outputOptions.cssChunkFilename);
  841. }
  842. /**
  843. * @param {Chunk} chunk chunk
  844. * @param {ChunkGraph} chunkGraph chunk graph
  845. * @returns {boolean} true, when the chunk has css
  846. */
  847. static chunkHasCss(chunk, chunkGraph) {
  848. return (
  849. Boolean(chunkGraph.getChunkModulesIterableBySourceType(chunk, "css")) ||
  850. Boolean(
  851. chunkGraph.getChunkModulesIterableBySourceType(chunk, "css-import")
  852. )
  853. );
  854. }
  855. }
  856. module.exports = CssModulesPlugin;