Skip to content

Commit cc1281b

Browse files
refactor(context): move context module sources into lib/context/ (#22115)
ContextModule, ContextModuleFactory, ContextExclusionPlugin and ContextReplacementPlugin were four of the 118 files sitting loose at the top of lib/. Group them under lib/context/ and update every reference, the serialization identifier, and the Architecture listing in AGENTS.md.
1 parent 2e999c1 commit cc1281b

20 files changed

Lines changed: 81 additions & 72 deletions
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"webpack": patch
3+
---
4+
5+
Move the context module sources into `lib/context/`.

‎AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ The directory listings below are the canonical map of the repository. **Whenever
6262
- `lib/cache/` — Filesystem and memory caches.
6363
- `lib/config/` — Config defaults, normalization, target presets.
6464
- `lib/container/` — Module Federation.
65+
- `lib/context/` — Context modules (`require.context`, dynamic request directories) and the plugins narrowing them.
6566
- `lib/css/` — CSS Modules, CSS parsing and generation.
6667
- `lib/debug/` — Debug helpers.
6768
- `lib/dependencies/` — `Dependency` classes and their templates (HarmonyImport, CommonJsRequire, RequireContext, …).

‎lib/Compiler.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ const Cache = require("./Cache");
1616
const CacheFacade = require("./CacheFacade");
1717
const ChunkGraph = require("./ChunkGraph");
1818
const Compilation = require("./Compilation");
19-
const ContextModuleFactory = require("./ContextModuleFactory");
2019
const ModuleGraph = require("./ModuleGraph");
2120
const NormalModuleFactory = require("./NormalModuleFactory");
2221
const RequestShortener = require("./RequestShortener");
2322
const ResolverFactory = require("./ResolverFactory");
2423
const Stats = require("./Stats");
24+
const ContextModuleFactory = require("./context/ContextModuleFactory");
2525
const WebpackError = require("./errors/WebpackError");
2626
const { Logger } = require("./logging/Logger");
2727
const asyncLib = require("./util/async");

‎lib/IgnorePlugin.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const EntryDependency = require("./dependencies/EntryDependency");
1515
*/
1616
/** @import Compiler from "./Compiler" */
1717
/** @import { ResolveData } from "./NormalModuleFactory" */
18-
/** @import { BeforeContextResolveData } from "./ContextModuleFactory" */
18+
/** @import { BeforeContextResolveData } from "./context/ContextModuleFactory" */
1919

2020
/** @typedef {(resource: string, context: string) => boolean} CheckResourceFn */
2121

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
"use strict";
66

7-
/** @import Compiler from "./Compiler" */
7+
/** @import Compiler from "../Compiler" */
88

99
const PLUGIN_NAME = "ContextExclusionPlugin";
1010

Lines changed: 37 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,49 +6,52 @@
66
"use strict";
77

88
const { OriginalSource, RawSource } = require("webpack-sources");
9-
const AsyncDependenciesBlock = require("./AsyncDependenciesBlock");
10-
const Module = require("./Module");
9+
const AsyncDependenciesBlock = require("../AsyncDependenciesBlock");
10+
const Module = require("../Module");
1111
const {
1212
JAVASCRIPT_TYPE,
1313
JAVASCRIPT_TYPES
14-
} = require("./ModuleSourceTypeConstants");
15-
const { JAVASCRIPT_MODULE_TYPE_DYNAMIC } = require("./ModuleTypeConstants");
16-
const RuntimeGlobals = require("./RuntimeGlobals");
17-
const Template = require("./Template");
14+
} = require("../ModuleSourceTypeConstants");
15+
const { JAVASCRIPT_MODULE_TYPE_DYNAMIC } = require("../ModuleTypeConstants");
16+
const RuntimeGlobals = require("../RuntimeGlobals");
17+
const Template = require("../Template");
1818
const {
1919
getOutgoingAsyncModules
20-
} = require("./async-modules/AsyncModuleHelpers");
21-
const { ImportPhase, ImportPhaseUtils } = require("./dependencies/ImportPhase");
22-
const { makeWebpackError } = require("./errors/HookWebpackError");
23-
const WebpackError = require("./errors/WebpackError");
20+
} = require("../async-modules/AsyncModuleHelpers");
21+
const {
22+
ImportPhase,
23+
ImportPhaseUtils
24+
} = require("../dependencies/ImportPhase");
25+
const { makeWebpackError } = require("../errors/HookWebpackError");
26+
const WebpackError = require("../errors/WebpackError");
2427
const {
2528
compareLocations,
2629
compareModulesById,
2730
compareSelect,
2831
concatComparators,
2932
keepOriginalOrder
30-
} = require("./util/comparators");
33+
} = require("../util/comparators");
3134
const {
3235
contextify,
3336
makePathsRelative,
3437
parseResource
35-
} = require("./util/identifier");
36-
const makeSerializable = require("./util/makeSerializable");
37-
const { propertyAccess } = require("./util/property");
38+
} = require("../util/identifier");
39+
const makeSerializable = require("../util/makeSerializable");
40+
const { propertyAccess } = require("../util/property");
3841

3942
/** @import { Source } from "webpack-sources" */
40-
/** @import { ResolveOptions } from "../declarations/WebpackOptions" */
43+
/** @import { ResolveOptions } from "../../declarations/WebpackOptions" */
4144
/**
4245
* @import {
4346
* WebpackOptionsNormalizedWithDefaults as WebpackOptions
44-
* } from "./config/defaults"
47+
* } from "../config/defaults"
4548
*/
46-
/** @import Chunk, { ChunkId, ChunkName } from "./Chunk" */
47-
/** @import ChunkGraph, { ModuleId } from "./ChunkGraph" */
48-
/** @import { RawChunkGroupOptions } from "./ChunkGroup" */
49-
/** @import Compilation, { FileSystemDependencies } from "./Compilation" */
50-
/** @import Dependency, { RawReferencedExports } from "./Dependency" */
51-
/** @import { Snapshot } from "./FileSystemInfo" */
49+
/** @import Chunk, { ChunkId, ChunkName } from "../Chunk" */
50+
/** @import ChunkGraph, { ModuleId } from "../ChunkGraph" */
51+
/** @import { RawChunkGroupOptions } from "../ChunkGroup" */
52+
/** @import Compilation, { FileSystemDependencies } from "../Compilation" */
53+
/** @import Dependency, { RawReferencedExports } from "../Dependency" */
54+
/** @import { Snapshot } from "../FileSystemInfo" */
5255
/**
5356
* @import {
5457
* BuildCallback,
@@ -63,17 +66,17 @@ const { propertyAccess } = require("./util/property");
6366
* RuntimeRequirements,
6467
* Sources,
6568
* SourceTypes
66-
* } from "./Module"
69+
* } from "../Module"
6770
*/
68-
/** @import RequestShortener from "./RequestShortener" */
69-
/** @import { ResolverWithOptions } from "./ResolverFactory" */
70-
/** @import RuntimeTemplate from "./RuntimeTemplate" */
71-
/** @import ContextElementDependency from "./dependencies/ContextElementDependency" */
72-
/** @import { ImportAttributes } from "./javascript/JavascriptParser" */
73-
/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext<[string, boolean]>} ObjectDeserializerContext */
74-
/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext<[string, boolean]>} ObjectSerializerContext */
75-
/** @import { InputFileSystem } from "./util/fs" */
76-
/** @import { ImportPhaseType } from "./dependencies/ImportPhase" */
71+
/** @import RequestShortener from "../RequestShortener" */
72+
/** @import { ResolverWithOptions } from "../ResolverFactory" */
73+
/** @import RuntimeTemplate from "../RuntimeTemplate" */
74+
/** @import ContextElementDependency from "../dependencies/ContextElementDependency" */
75+
/** @import { ImportAttributes } from "../javascript/JavascriptParser" */
76+
/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext<[string, boolean]>} ObjectDeserializerContext */
77+
/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext<[string, boolean]>} ObjectSerializerContext */
78+
/** @import { InputFileSystem } from "../util/fs" */
79+
/** @import { ImportPhaseType } from "../dependencies/ImportPhase" */
7780

7881
/** @typedef {"sync" | "eager" | "weak" | "async-weak" | "lazy" | "lazy-once"} ContextMode Context mode */
7982

@@ -1473,7 +1476,7 @@ module.exports = webpackEmptyAsyncContext;`;
14731476
const returnModuleObject = this.getReturnModuleObjectSource(fakeMap);
14741477
const globImportAccess = this.getImportPropertyAccess();
14751478
const sortedDependencies =
1476-
/** @type {import("./dependencies/ContextElementDependency")[]} */
1479+
/** @type {import("../dependencies/ContextElementDependency")[]} */
14771480
(dependencies).sort((a, b) =>
14781481
a.userRequest < b.userRequest
14791482
? -1
@@ -1724,6 +1727,6 @@ module.exports = webpackEmptyAsyncContext;`;
17241727
}
17251728
}
17261729

1727-
makeSerializable(ContextModule, "webpack/lib/ContextModule");
1730+
makeSerializable(ContextModule, "webpack/lib/context/ContextModule");
17281731

17291732
module.exports = ContextModule;
Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@
66
"use strict";
77

88
const { AsyncSeriesWaterfallHook, SyncWaterfallHook } = require("tapable");
9-
const ContextModule = require("./ContextModule");
10-
const ModuleFactory = require("./ModuleFactory");
11-
const ContextElementDependency = require("./dependencies/ContextElementDependency");
12-
const LazySet = require("./util/LazySet");
13-
const asyncLib = require("./util/async");
14-
const { cachedSetProperty } = require("./util/cleverMerge");
15-
const { createFakeHook } = require("./util/deprecation");
16-
const { join } = require("./util/fs");
9+
const ModuleFactory = require("../ModuleFactory");
10+
const ContextElementDependency = require("../dependencies/ContextElementDependency");
11+
const LazySet = require("../util/LazySet");
12+
const asyncLib = require("../util/async");
13+
const { cachedSetProperty } = require("../util/cleverMerge");
14+
const { createFakeHook } = require("../util/deprecation");
15+
const { join } = require("../util/fs");
1716
const {
1817
globPatternBaseReachesDir,
1918
globUserRequest,
2019
isNonExhaustiveImportMetaGlobSkippedDir,
2120
resolveContextModuleGlobPattern
22-
} = require("./util/globUtils");
21+
} = require("../util/globUtils");
22+
const ContextModule = require("./ContextModule");
2323

24-
/** @import { ResolvedContextModuleGlobPattern } from "./util/globUtils" */
24+
/** @import { ResolvedContextModuleGlobPattern } from "../util/globUtils" */
2525
/** @typedef {(context: string, subResource: string, callback: () => void, resolvedGlobPatterns?: ResolvedContextModuleGlobPattern[]) => void} AddSubDirectoryFn */
2626
/** @import { ResolveRequest } from "enhanced-resolve" */
27-
/** @import { FileSystemDependencies } from "./Compilation" */
27+
/** @import { FileSystemDependencies } from "../Compilation" */
2828
/**
2929
* @import {
3030
* ContextModuleOptions,
@@ -36,17 +36,17 @@ const {
3636
* @import {
3737
* ModuleFactoryCreateData,
3838
* ModuleFactoryCallback
39-
* } from "./ModuleFactory"
39+
* } from "../ModuleFactory"
4040
*/
41-
/** @import ResolverFactory from "./ResolverFactory" */
42-
/** @import ContextDependency from "./dependencies/ContextDependency" */
41+
/** @import ResolverFactory from "../ResolverFactory" */
42+
/** @import ContextDependency from "../dependencies/ContextDependency" */
4343

4444
/**
4545
* Defines the shared type used by this module.
4646
* @template T
47-
* @typedef {import("./util/deprecation").FakeHook<T>} FakeHook<T>
47+
* @typedef {import("../util/deprecation").FakeHook<T>} FakeHook<T>
4848
*/
49-
/** @import { IStats, InputFileSystem } from "./util/fs" */
49+
/** @import { IStats, InputFileSystem } from "../util/fs" */
5050
/** @typedef {{ context: string, request: string }} ContextAlternativeRequest */
5151

5252
/**
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55

66
"use strict";
77

8-
const ContextElementDependency = require("./dependencies/ContextElementDependency");
9-
const { isAbsolute, join } = require("./util/fs");
8+
const ContextElementDependency = require("../dependencies/ContextElementDependency");
9+
const { isAbsolute, join } = require("../util/fs");
1010

11-
/** @import Compiler from "./Compiler" */
11+
/** @import Compiler from "../Compiler" */
1212
/** @import { ContextModuleOptions } from "./ContextModule" */
1313
/**
1414
* @import {
1515
* BeforeContextResolveData,
1616
* AfterContextResolveData
1717
* } from "./ContextModuleFactory"
1818
*/
19-
/** @import { InputFileSystem } from "./util/fs" */
19+
/** @import { InputFileSystem } from "../util/fs" */
2020

2121
/** @typedef {Record<string, string>} NewContentCreateContextMap */
2222

‎lib/dependencies/ContextDependency.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const getCriticalDependencyWarning = memoize(() =>
1515
);
1616

1717
/** @import { Range } from "../javascript/JavascriptParser" */
18-
/** @import { ContextOptions } from "../ContextModule" */
18+
/** @import { ContextOptions } from "../context/ContextModule" */
1919
/** @import { TRANSITIVE } from "../Dependency" */
2020
/** @import ModuleGraph from "../ModuleGraph" */
2121
/** @import WebpackError from "../errors/WebpackError" */

‎lib/dependencies/ContextElementDependency.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const Dependency = require("../Dependency");
99
const makeSerializable = require("../util/makeSerializable");
1010
const ModuleDependency = require("./ModuleDependency");
1111

12-
/** @import ContextModule from "../ContextModule" */
12+
/** @import ContextModule from "../context/ContextModule" */
1313
/** @import { RawReferencedExports, ReferencedExports } from "../Dependency" */
1414
/** @import Module from "../Module" */
1515
/** @import ModuleGraph from "../ModuleGraph" */

0 commit comments

Comments
 (0)