Add --ignoreConfig and dont allow specifying files on commandline without it if there is config file present (#62477)

Author: sheetalkamat

src/compiler/commandLineParser.ts

@@ -674,6 +674,15 @@ const commandOptionsWithoutBuild: CommandLineOption[] = [
         description: Diagnostics.Print_names_of_files_that_are_part_of_the_compilation_and_then_stop_processing,
         defaultValueDescription: false,
     },
+    {
+        name: "ignoreConfig",
+        type: "boolean",
+        showInSimplifiedHelpView: true,
+        category: Diagnostics.Command_line_Options,
+        isCommandLineOnly: true,
+        description: Diagnostics.Ignore_the_tsconfig_found_and_build_with_commandline_options_and_files,
+        defaultValueDescription: false,
+    },
 
     // Basic
     targetOptionDeclaration,

src/compiler/diagnosticMessages.json

@@ -1857,6 +1857,10 @@
         "category": "Error",
         "code": 1548
     },
+    "Ignore the tsconfig found and build with commandline options and files.": {
+        "category": "Message",
+        "code": 1549
+    },
 
     "The types of '{0}' are incompatible between these types.": {
         "category": "Error",
@@ -4733,6 +4737,10 @@
         "category": "Message",
         "code": 5111
     },
+    "tsconfig.json is present but will not be loaded if files are specified on commandline. Use '--ignoreConfig' to skip this error.": {
+        "category": "Error",
+        "code": 5112
+    },
 
     "Generates a sourcemap for each corresponding '.d.ts' file.": {
         "category": "Message",

src/compiler/executeCommandLine.ts

@@ -614,20 +614,27 @@ function executeCommandLineWorker(
             }
         }
     }
-    else if (commandLine.fileNames.length === 0) {
+    else if (!commandLine.options.ignoreConfig || commandLine.fileNames.length === 0) {
         const searchPath = normalizePath(sys.getCurrentDirectory());
         configFileName = findConfigFile(searchPath, fileName => sys.fileExists(fileName));
-    }
-
-    if (commandLine.fileNames.length === 0 && !configFileName) {
-        if (commandLine.options.showConfig) {
-            reportDiagnostic(createCompilerDiagnostic(Diagnostics.Cannot_find_a_tsconfig_json_file_at_the_current_directory_Colon_0, normalizePath(sys.getCurrentDirectory())));
+        // if (!commandLine.options.ignoreConfig) {
+        if (commandLine.fileNames.length !== 0) {
+            if (configFileName) {
+                // Error to not specify config file
+                reportDiagnostic(createCompilerDiagnostic(Diagnostics.tsconfig_json_is_present_but_will_not_be_loaded_if_files_are_specified_on_commandline_Use_ignoreConfig_to_skip_this_error));
+                return sys.exit(ExitStatus.DiagnosticsPresent_OutputsSkipped);
+            }
         }
-        else {
-            printVersion(sys);
-            printHelp(sys, commandLine);
+        else if (!configFileName) {
+            if (commandLine.options.showConfig) {
+                reportDiagnostic(createCompilerDiagnostic(Diagnostics.Cannot_find_a_tsconfig_json_file_at_the_current_directory_Colon_0, normalizePath(sys.getCurrentDirectory())));
+            }
+            else {
+                printVersion(sys);
+                printHelp(sys, commandLine);
+            }
+            return sys.exit(ExitStatus.DiagnosticsPresent_OutputsSkipped);
         }
-        return sys.exit(ExitStatus.DiagnosticsPresent_OutputsSkipped);
     }
 
     const currentDirectory = sys.getCurrentDirectory();

src/compiler/types.ts

@@ -7552,6 +7552,7 @@ export interface CompilerOptions {
     /** @internal */ watch?: boolean;
     esModuleInterop?: boolean;
     /** @internal */ showConfig?: boolean;
+    /** @internal */ ignoreConfig?: boolean;
     useDefineForClassFields?: boolean;
     /** @internal */ tscBuild?: boolean;
 

src/testRunner/tests.ts

@@ -119,6 +119,7 @@ export * from "./unittests/tsc/composite.js";
 export * from "./unittests/tsc/declarationEmit.js";
 export * from "./unittests/tsc/extends.js";
 export * from "./unittests/tsc/forceConsistentCasingInFileNames.js";
+export * from "./unittests/tsc/ignoreConfig.js";
 export * from "./unittests/tsc/incremental.js";
 export * from "./unittests/tsc/libraryResolution.js";
 export * from "./unittests/tsc/listFilesOnly.js";

src/testRunner/unittests/tsc/ignoreConfig.ts

@@ -0,0 +1,58 @@
+import * as ts from "../../_namespaces/ts.js";
+import { jsonToReadableText } from "../helpers.js";
+import { verifyTsc } from "../helpers/tsc.js";
+import { TestServerHost } from "../helpers/virtualFileSystemWithWatch.js";
+
+describe("unittests:: tsc:: ignoreConfig::", () => {
+    function sysWithoutConfig() {
+        return TestServerHost.createWatchedSystem({
+            "/home/src/workspaces/project/src/a.ts": "export const a = 10;",
+            "/home/src/workspaces/project/src/b.ts": "export const b = 10;",
+            "/home/src/workspaces/project/c.ts": "export const c = 10;",
+        });
+    }
+    function sysWithConfig() {
+        const sys = sysWithoutConfig();
+        sys.writeFile(
+            "/home/src/workspaces/project/tsconfig.json",
+            jsonToReadableText({
+                include: ["src"],
+            }),
+        );
+        return sys;
+    }
+    function runScenario(subScenario: string, commandLineArgs: readonly string[]) {
+        verifyTsc({
+            scenario: "ignoreConfig",
+            subScenario,
+            sys: sysWithConfig,
+            commandLineArgs,
+        });
+
+        verifyTsc({
+            scenario: "ignoreConfig",
+            subScenario: subScenario + " with --ignoreConfig",
+            sys: sysWithConfig,
+            commandLineArgs: commandLineArgs.concat("--ignoreConfig"),
+        });
+
+        verifyTsc({
+            scenario: "ignoreConfig",
+            subScenario: subScenario + " when config file absent",
+            sys: sysWithoutConfig,
+            commandLineArgs,
+        });
+
+        verifyTsc({
+            scenario: "ignoreConfig",
+            subScenario: subScenario + " when config file absent with --ignoreConfig",
+            sys: sysWithoutConfig,
+            commandLineArgs: commandLineArgs.concat("--ignoreConfig"),
+        });
+    }
+
+    runScenario("without any options", ts.emptyArray);
+    runScenario("specifying files", ["src/a.ts"]);
+    runScenario("specifying project", ["-p", "."]);
+    runScenario("mixing project and files", ["-p", ".", "src/a.ts", "c.ts"]);
+});

src/testRunner/unittests/tscWatch/resolutionCache.ts

@@ -424,7 +424,7 @@ declare module "fs" {
                 ],
             });
         }
-        verifyIgnore("watch without configFile", ["--w", `/user/username/projects/myproject/test.ts`]);
+        verifyIgnore("watch without configFile", ["--w", "--ignoreConfig", `/user/username/projects/myproject/test.ts`]);
         verifyIgnore("watch with configFile", ["--w", "-p", `/user/username/projects/myproject/tsconfig.json`]);
     });
 

tests/baselines/reference/config/showConfig/Shows tsconfig for single option/ignoreConfig/tsconfig.json

@@ -0,0 +1,5 @@
+{
+    "compilerOptions": {
+        "ignoreConfig": true
+    }
+}

tests/baselines/reference/tsc/commandLine/does-not-add-color-when-NO_COLOR-is-set.js

@@ -67,6 +67,9 @@ Compile the project given the path to its configuration file, or to a folder wit
 --showConfig
 Print the final configuration instead of building.
 
+--ignoreConfig
+Ignore the tsconfig found and build with commandline options and files.
+
 --build, -b
 Build one or more projects and their dependencies, if out of date
 

tests/baselines/reference/tsc/commandLine/help-all.js

@@ -35,6 +35,9 @@ Print this message.
 --help, -?
 
 
+--ignoreConfig
+Ignore the tsconfig found and build with commandline options and files.
+
 --init
 Initializes a TypeScript project and creates a tsconfig.json file.