feat: export and disable it by default

web-infra-dev · Dec 13, 2024 · 520b46f · 520b46f
1 parent a313b28
commit 520b46f
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 9 deletions.
diff --git a/packages/rspack/etc/core.api.md b/packages/rspack/etc/core.api.md
@@ -5076,6 +5076,7 @@ declare namespace rspackExports {
         ExternalsPlugin,
         HotModuleReplacementPlugin,
         NoEmitOnErrorsPlugin,
+        WarnCaseSensitiveModulesPlugin,
         DllPlugin,
         DllPluginOptions,
         DllReferencePlugin,
@@ -10966,6 +10967,17 @@ export class ValidationError extends Error {
 // @public (undocumented)
 export const version: string;
 
+// @public (undocumented)
+export const WarnCaseSensitiveModulesPlugin: {
+    new (): {
+        name: BuiltinPluginName;
+        _args: [];
+        affectedHooks: "done" | "make" | "compile" | "emit" | "afterEmit" | "invalid" | "thisCompilation" | "afterDone" | "compilation" | "normalModuleFactory" | "contextModuleFactory" | "initialize" | "shouldEmit" | "infrastructureLog" | "beforeRun" | "run" | "assetEmitted" | "failed" | "shutdown" | "watchRun" | "watchClose" | "environment" | "afterEnvironment" | "afterPlugins" | "afterResolvers" | "beforeCompile" | "afterCompile" | "finishMake" | "entryOption" | "additionalPass" | undefined;
+        raw(compiler: Compiler_2): BuiltinPlugin;
+        apply(compiler: Compiler_2): void;
+    };
+};
+
 // @public (undocumented)
 interface Wasm {
     // (undocumented)

diff --git a/packages/rspack/src/exports.ts b/packages/rspack/src/exports.ts
@@ -103,6 +103,7 @@ export { DynamicEntryPlugin } from "./builtin-plugin";
 export { ExternalsPlugin } from "./builtin-plugin";
 export { HotModuleReplacementPlugin } from "./builtin-plugin";
 export { NoEmitOnErrorsPlugin } from "./builtin-plugin";
+export { WarnCaseSensitiveModulesPlugin } from "./builtin-plugin";
 export { DllPlugin, type DllPluginOptions } from "./lib/DllPlugin";
 export {
 	DllReferencePlugin,

diff --git a/packages/rspack/src/rspackOptionsApply.ts b/packages/rspack/src/rspackOptionsApply.ts
@@ -64,7 +64,6 @@ import {
 	SizeLimitsPlugin,
 	SourceMapDevToolPlugin,
 	SplitChunksPlugin,
-	WarnCaseSensitiveModulesPlugin,
 	WorkerPlugin
 } from "./builtin-plugin";
 import EntryOptionPlugin from "./lib/EntryOptionPlugin";
@@ -361,8 +360,6 @@ export class RspackOptionsApply {
 			new SizeLimitsPlugin(options.performance).apply(compiler);
 		}
 
-		new WarnCaseSensitiveModulesPlugin().apply(compiler);
-
 		if (options.cache) {
 			new MemoryCachePlugin().apply(compiler);
 		}

diff --git a/website/docs/en/plugins/webpack/_meta.json b/website/docs/en/plugins/webpack/_meta.json
@@ -3,6 +3,8 @@
   "banner-plugin",
   "context-replacement-plugin",
   "define-plugin",
+  "dll-plugin",
+  "dll-reference-plugin",
   "electron-target-plugin",
   "enable-chunk-loading-plugin",
   "enable-library-plugin",
@@ -26,7 +28,6 @@
   "runtime-chunk-plugin",
   "source-map-dev-tool-plugin",
   "split-chunks-plugin",
-  "internal-plugins",
-  "dll-plugin",
-  "dll-reference-plugin"
+  "warn-case-sensitive-modules-plugin",
+  "internal-plugins"
 ]
diff --git a/website/docs/en/plugins/webpack/warn-case-sensitive-modules-plugin.mdx b/website/docs/en/plugins/webpack/warn-case-sensitive-modules-plugin.mdx
@@ -0,0 +1,13 @@
+import { ApiMeta } from '@components/ApiMeta.tsx';
+
+# WarnCaseSensitiveModulesPlugin
+
+<ApiMeta addedVersion={'1.2.0'} />
+
+Detect and warn about case-sensitive module naming conflicts.
+
+When compiling on a file system with other case semantics, if there are multiple modules whose names differ only in casing, it may lead to unexpected error behaviors.
+
+```js
+new rspack.WarnCaseSensitiveModulesPlugin();
+```
diff --git a/website/docs/zh/plugins/webpack/_meta.json b/website/docs/zh/plugins/webpack/_meta.json
@@ -3,6 +3,8 @@
   "banner-plugin",
   "context-replacement-plugin",
   "define-plugin",
+  "dll-plugin",
+  "dll-reference-plugin",
   "electron-target-plugin",
   "enable-chunk-loading-plugin",
   "enable-library-plugin",
@@ -26,7 +28,6 @@
   "runtime-chunk-plugin",
   "source-map-dev-tool-plugin",
   "split-chunks-plugin",
-  "internal-plugins",
-  "dll-plugin",
-  "dll-reference-plugin"
+  "warn-case-sensitive-modules-plugin",
+  "internal-plugins"
 ]
diff --git a/website/docs/zh/plugins/webpack/warn-case-sensitive-modules-plugin.mdx b/website/docs/zh/plugins/webpack/warn-case-sensitive-modules-plugin.mdx
@@ -0,0 +1,13 @@
+import { ApiMeta } from '@components/ApiMeta.tsx';
+
+# WarnCaseSensitiveModulesPlugin
+
+<ApiMeta addedVersion={'1.2.0'} />
+
+检测并就区分大小写的模块命名冲突发出警告。
+
+当在具有其他大小写语义的文件系统上进行编译时，如果存在多个名称仅大小写不同的模块，可能会导致出现意外的错误行为。
+
+```js
+new rspack.WarnCaseSensitiveModulesPlugin();
+```