fix(webpack-cli): add an option for preventing interpret

webpack · Jul 6, 2022 · 6cbe9d3 · 6cbe9d3
1 parent 58503be
commit 6cbe9d3
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 3 deletions.
diff --git a/packages/webpack-cli/src/types.ts b/packages/webpack-cli/src/types.ts
@@ -31,6 +31,7 @@ interface IWebpackCLI {
   colors: WebpackCLIColors;
   logger: WebpackCLILogger;
   isColorSupportChanged: boolean | undefined;
+  isConfigRegistered: boolean | undefined;
   webpack: typeof webpack;
   builtInOptionsCache: WebpackCLIBuiltInOption[] | undefined;
   program: WebpackCLICommand;

diff --git a/packages/webpack-cli/src/webpack-cli.ts b/packages/webpack-cli/src/webpack-cli.ts
@@ -69,6 +69,7 @@ class WebpackCLI implements IWebpackCLI {
   colors: WebpackCLIColors;
   logger: WebpackCLILogger;
   isColorSupportChanged: boolean | undefined;
+  isConfigRegistered: boolean | undefined;
   builtInOptionsCache: WebpackCLIBuiltInOption[] | undefined;
   webpack!: typeof webpack;
   program: WebpackCLICommand;
@@ -1310,6 +1311,14 @@ class WebpackCLI implements IWebpackCLI {
       cli.colors = cli.createColors(color);
     });
 
+    this.program.option("--config-registered", "Disable interpret a config file.");
+    this.program.on("option:config-registered", function () {
+      // @ts-expect-error shadowing 'this' is intended
+      const { configRegistered } = this.opts();
+
+      cli.isConfigRegistered = configRegistered;
+    });
+
     // Make `-v, --version` options
     // Make `version|v [commands...]` command
     const outputVersion = async (options: string[]) => {
@@ -1807,12 +1816,15 @@ class WebpackCLI implements IWebpackCLI {
   }
 
   async loadConfig(options: Partial<WebpackDevServerOptions>) {
+    const configRegistered =
+      typeof this.isConfigRegistered !== undefined && this.isConfigRegistered;
+
     const interpret = require("interpret");
     const loadConfigByPath = async (configPath: string, argv: Argv = {}) => {
       const ext = path.extname(configPath);
       const interpreted = Object.keys(interpret.jsVariants).find((variant) => variant === ext);
 
-      if (interpreted) {
+      if (interpreted && !configRegistered) {
         const rechoir: Rechoir = require("rechoir");
 
         try {
@@ -1904,7 +1916,7 @@ class WebpackCLI implements IWebpackCLI {
       path: new WeakMap(),
     };
 
-    if (options.config && options.config.length > 0) {
+    if (options.config && options.config.length > 0 && configRegistered) {
       const loadedConfigs = await Promise.all(
         options.config.map((configPath: string) =>
           loadConfigByPath(path.resolve(configPath), options.argv),

diff --git a/test/build/config-format/typescript/typescript.test.js b/test/build/config-format/typescript/typescript.test.js
@@ -1,7 +1,11 @@
 const { run } = require("../../../utils/test-utils");
-const { existsSync } = require("fs");
+const { existsSync, unlinkSync } = require("fs");
 const { resolve } = require("path");
 
+// eslint-disable-next-line node/no-unpublished-require
+const execa = require("execa");
+const { sync: spawnSync } = execa;
+
 describe("webpack cli", () => {
   it("should support typescript file", async () => {
     const { exitCode, stderr, stdout } = await run(__dirname, ["-c", "./webpack.config.ts"]);
@@ -11,4 +15,19 @@ describe("webpack cli", () => {
     expect(exitCode).toBe(0);
     expect(existsSync(resolve(__dirname, "dist/foo.bundle.js"))).toBeTruthy();
   });
+
+  it('should work with the "config-registered" option from flags', async () => {
+    const configFileName = "webpack.config";
+    const configFilePath = resolve(__dirname, `${configFileName}.ts`);
+    const buildScripts = spawnSync("yarn", ["tsc", configFilePath]);
+    expect(buildScripts.stdout).toBeTruthy();
+
+    const { exitCode, stderr, stdout } = await run(__dirname, ["--config-registered"]);
+    unlinkSync(resolve(__dirname, `${configFileName}.js`));
+
+    expect(stderr).toBeFalsy();
+    expect(stdout).toBeTruthy();
+    expect(exitCode).toBe(0);
+    expect(existsSync(resolve(__dirname, "dist/foo.bundle.js"))).toBeTruthy();
+  });
 });