Fix(29118): tsconfig.extends as array (#50403)

navya9singh · web-flow · commit 7267fcaeb98e · 2022-12-13T11:16:07.000-08:00
* tsconfig.extends as array

* Updated baselines

* Changes for pr

* Changes for pr comments

* Fixed formatting and edited a test

* Resolved errors after a merge conflict

* Added "string | list" type implentation

* Removed string | list type implementation

* Fixed formatting

* Added compiler test

* Resolving programUpdate errors

* Fixing commandLineParser error
diff --git a/src/compiler/builder.ts b/src/compiler/builder.ts
@@ -1161,6 +1161,7 @@ function getBuildInfo(state: BuilderProgramState, bundle: BundleBuildInfo | unde
 
 function convertToReusableCompilerOptionValue(option: CommandLineOption | undefined, value: CompilerOptionsValue, relativeToBuildInfo: (path: string) => string) {
     if (option) {
+        Debug.assert(option.type !== "listOrElement");
         if (option.type === "list") {
             const values = value as readonly (string | number)[];
             if (option.element.isFilePath && values.length) {
diff --git a/src/compiler/commandLineParser.ts b/src/compiler/commandLineParser.ts
diff --git a/src/compiler/types.ts b/src/compiler/types.ts
@@ -6977,7 +6977,7 @@ export interface CreateProgramOptions {
 /** @internal */
 export interface CommandLineOptionBase {
     name: string;
-    type: "string" | "number" | "boolean" | "object" | "list" | Map<string, number | string>;    // a value of a primitive type, or an object literal mapping named values to actual values
+    type: "string" | "number" | "boolean" | "object" | "list" | "listOrElement" | Map<string, number | string>;    // a value of a primitive type, or an object literal mapping named values to actual values
     isFilePath?: boolean;                                   // True if option value is a path or fileName
     shortName?: string;                                     // A short mnemonic for convenience - for instance, 'h' can be used in place of 'help'
     description?: DiagnosticMessage;                        // The message describing what the command line switch does.
@@ -7047,7 +7047,7 @@ export interface TsConfigOnlyOption extends CommandLineOptionBase {
 
 /** @internal */
 export interface CommandLineOptionOfListType extends CommandLineOptionBase {
-    type: "list";
+    type: "list" | "listOrElement";
     element: CommandLineOptionOfCustomType | CommandLineOptionOfStringType | CommandLineOptionOfNumberType | CommandLineOptionOfBooleanType | TsConfigOnlyOption;
     listPreserveFalsyValues?: boolean;
 }
diff --git a/src/executeCommandLine/executeCommandLine.ts b/src/executeCommandLine/executeCommandLine.ts
@@ -253,9 +253,9 @@ function generateOptionOutput(sys: System, option: CommandLineOption, rightAlign
         typeof option.defaultValueDescription === "object"
             ? getDiagnosticText(option.defaultValueDescription)
             : formatDefaultValue(
-                  option.defaultValueDescription,
-                  option.type === "list" ? option.element.type : option.type
-              );
+                option.defaultValueDescription,
+                option.type === "list" || option.type === "listOrElement" ? option.element.type : option.type
+            );
     const terminalWidth = sys.getWidthOfTerminal?.() ?? 0;
 
     // Note: child_process might return `terminalWidth` as undefined.
@@ -365,6 +365,7 @@ function generateOptionOutput(sys: System, option: CommandLineOption, rightAlign
         };
 
         function getValueType(option: CommandLineOption) {
+            Debug.assert(option.type !== "listOrElement");
             switch (option.type) {
                 case "string":
                 case "number":
@@ -386,7 +387,7 @@ function generateOptionOutput(sys: System, option: CommandLineOption, rightAlign
                     possibleValues = option.type;
                     break;
                 case "list":
-                    // TODO: check infinite loop
+                case "listOrElement":
                     possibleValues = getPossibleValues(option.element);
                     break;
                 case "object":
diff --git a/src/harness/harnessIO.ts b/src/harness/harnessIO.ts
@@ -380,6 +380,7 @@ export namespace Compiler {
             }
             // If not a primitive, the possible types are specified in what is effectively a map of options.
             case "list":
+            case "listOrElement":
                 return ts.parseListTypeOption(option, value, errors);
             default:
                 return ts.parseCustomTypeOption(option as ts.CommandLineOptionOfCustomType, value, errors);
diff --git a/src/services/getEditsForFileRename.ts b/src/services/getEditsForFileRename.ts
@@ -120,7 +120,7 @@ function updateTsconfigFiles(program: Program, changeTracker: textChanges.Change
                 if (foundExactMatch || propertyName !== "include" || !isArrayLiteralExpression(property.initializer)) return;
                 const includes = mapDefined(property.initializer.elements, e => isStringLiteral(e) ? e.text : undefined);
                 if (includes.length === 0) return;
-                const matchers = getFileMatcherPatterns(configDir, /*excludes*/ [], includes, useCaseSensitiveFileNames, currentDirectory);
+                const matchers = getFileMatcherPatterns(configDir, /*excludes*/[], includes, useCaseSensitiveFileNames, currentDirectory);
                 // If there isn't some include for this, add a new one.
                 if (getRegexFromPattern(Debug.checkDefined(matchers.includeFilePattern), useCaseSensitiveFileNames).test(oldFileOrDirPath) &&
                     !getRegexFromPattern(Debug.checkDefined(matchers.includeFilePattern), useCaseSensitiveFileNames).test(newFileOrDirPath)) {
@@ -131,6 +131,7 @@ function updateTsconfigFiles(program: Program, changeTracker: textChanges.Change
             case "compilerOptions":
                 forEachProperty(property.initializer, (property, propertyName) => {
                     const option = getOptionFromName(propertyName);
+                    Debug.assert(option?.type !== "listOrElement");
                     if (option && (option.isFilePath || option.type === "list" && option.element.isFilePath)) {
                         updatePaths(property);
                     }
diff --git a/src/testRunner/unittests/config/configurationExtension.ts b/src/testRunner/unittests/config/configurationExtension.ts
@@ -186,7 +186,47 @@ function createFileSystem(ignoreCase: boolean, cwd: string, root: string) {
                 "dev/tests/unit/spec.ts": "",
                 "dev/tests/utils.ts": "",
                 "dev/tests/scenarios/first.json": "",
-                "dev/tests/baselines/first/output.ts": ""
+                "dev/tests/baselines/first/output.ts": "",
+                    "dev/configs/extendsArrayFirst.json": JSON.stringify({
+                        compilerOptions: {
+                            allowJs: true,
+                            noImplicitAny: true,
+                            strictNullChecks: true
+                        }
+                    }),
+                    "dev/configs/extendsArraySecond.json": JSON.stringify({
+                        compilerOptions: {
+                            module: "amd"
+                        },
+                        include: ["../supplemental.*"]
+                    }),
+                    "dev/configs/extendsArrayThird.json": JSON.stringify({
+                        compilerOptions: {
+                            module: null, // eslint-disable-line no-null/no-null
+                            noImplicitAny: false
+                        },
+                        extends: "./extendsArrayFirst",
+                        include: ["../supplemental.*"]
+                    }),
+                    "dev/configs/extendsArrayFourth.json": JSON.stringify({
+                        compilerOptions: {
+                            module: "system",
+                            strictNullChecks: false
+                        },
+                        include: null, // eslint-disable-line no-null/no-null
+                        files: ["../main.ts"]
+                    }),
+                    "dev/configs/extendsArrayFifth.json": JSON.stringify({
+                        extends: ["./extendsArrayFirst", "./extendsArraySecond", "./extendsArrayThird", "./extendsArrayFourth"],
+                        files: [],
+                    }),
+                    "dev/extendsArrayFails.json": JSON.stringify({
+                        extends: ["./missingFile"],
+                        compilerOptions: {
+                            types: []
+                        }
+                    }),
+                    "dev/extendsArrayFails2.json": JSON.stringify({ extends: [42] }),
             }
         }
     });
@@ -295,9 +335,9 @@ describe("unittests:: config:: configurationExtension", () => {
                 messageText: `Unknown option 'excludes'. Did you mean 'exclude'?`
             }]);
 
-            testFailure("can error when 'extends' is not a string", "extends.json", [{
+            testFailure("can error when 'extends' is not a string or Array", "extends.json", [{
                 code: 5024,
-                messageText: `Compiler option 'extends' requires a value of type string.`
+                messageText: `Compiler option 'extends' requires a value of type string or Array.`
             }]);
 
             testSuccess("can overwrite compiler options using extended 'null'", "configs/third.json", {
@@ -352,5 +392,40 @@ describe("unittests:: config:: configurationExtension", () => {
                 assert.deepEqual(sourceFile.extendedSourceFiles, expected);
             });
         });
+
+        describe(testName, () => {
+            it("adds extendedSourceFiles from an array only once", () => {
+                const sourceFile = ts.readJsonConfigFile("configs/extendsArrayFifth.json", (path) => host.readFile(path));
+                const dir = ts.combinePaths(basePath, "configs");
+                const expected = [
+                    ts.combinePaths(dir, "extendsArrayFirst.json"),
+                    ts.combinePaths(dir, "extendsArraySecond.json"),
+                    ts.combinePaths(dir, "extendsArrayThird.json"),
+                    ts.combinePaths(dir, "extendsArrayFourth.json"),
+                ];
+                ts.parseJsonSourceFileConfigFileContent(sourceFile, host, dir, {}, "extendsArrayFifth.json");
+                assert.deepEqual(sourceFile.extendedSourceFiles, expected);
+                ts.parseJsonSourceFileConfigFileContent(sourceFile, host, dir, {}, "extendsArrayFifth.json");
+                assert.deepEqual(sourceFile.extendedSourceFiles, expected);
+            });
+
+            testSuccess("can overwrite top-level compilerOptions", "configs/extendsArrayFifth.json", {
+                allowJs: true,
+                noImplicitAny: false,
+                strictNullChecks: false,
+                module: ts.ModuleKind.System
+            }, []);
+
+            testFailure("can report missing configurations", "extendsArrayFails.json", [{
+                code: 6053,
+                messageText: `File './missingFile' not found.`
+            }]);
+
+            testFailure("can error when 'extends' is not a string or Array2", "extendsArrayFails2.json", [{
+                code: 5024,
+                messageText: `Compiler option 'extends' requires a value of type string.`
+            }]);
+        });
     });
 });
+
diff --git a/src/testRunner/unittests/config/showConfig.ts b/src/testRunner/unittests/config/showConfig.ts
@@ -147,6 +147,10 @@ describe("unittests:: config:: showConfig", () => {
                 }
                 break;
             }
+            case "listOrElement": {
+                ts.Debug.fail();
+                break;
+            }
             case "string": {
                 if (option.isTSConfigOnly) {
                     args = ["-p", "tsconfig.json"];
diff --git a/src/testRunner/unittests/tsbuildWatch/programUpdates.ts b/src/testRunner/unittests/tsbuildWatch/programUpdates.ts
@@ -597,7 +597,7 @@ export function someFn() { }`),
     verifyTscWatch({
         scenario: "programUpdates",
         subScenario: "works with extended source files",
-        commandLineArgs: ["-b", "-w", "-v", "project1.tsconfig.json", "project2.tsconfig.json"],
+        commandLineArgs: ["-b", "-w", "-v", "project1.tsconfig.json", "project2.tsconfig.json", "project3.tsconfig.json"],
         sys: () => {
             const alphaExtendedConfigFile: File = {
                 path: "/a/b/alpha.tsconfig.json",
@@ -633,10 +633,49 @@ export function someFn() { }`),
                     files: [otherFile.path]
                 })
             };
+            const otherFile2: File = {
+                path: "/a/b/other2.ts",
+                content: "let k = 0;",
+            };
+            const extendsConfigFile1: File = {
+                path: "/a/b/extendsConfig1.tsconfig.json",
+                content: JSON.stringify({
+                    compilerOptions: {
+                        composite: true,
+                    }
+                })
+            };
+            const extendsConfigFile2: File = {
+                path: "/a/b/extendsConfig2.tsconfig.json",
+                content: JSON.stringify({
+                    compilerOptions: {
+                        strictNullChecks: false,
+                    }
+                })
+            };
+            const extendsConfigFile3: File = {
+                path: "/a/b/extendsConfig3.tsconfig.json",
+                content: JSON.stringify({
+                    compilerOptions: {
+                        noImplicitAny: true,
+                    }
+                })
+            };
+            const project3Config: File = {
+                path: "/a/b/project3.tsconfig.json",
+                content: JSON.stringify({
+                    extends: ["./extendsConfig1.tsconfig.json", "./extendsConfig2.tsconfig.json", "./extendsConfig3.tsconfig.json"],
+                    compilerOptions: {
+                        composite: false,
+                    },
+                    files: [otherFile2.path]
+                })
+            };
             return createWatchedSystem([
                 libFile,
                 alphaExtendedConfigFile, project1Config, commonFile1, commonFile2,
-                bravoExtendedConfigFile, project2Config, otherFile
+                bravoExtendedConfigFile, project2Config, otherFile, otherFile2,
+                    extendsConfigFile1, extendsConfigFile2, extendsConfigFile3, project3Config
             ], { currentDirectory: "/a/b" });
         },
         edits: [
@@ -689,7 +728,37 @@ export function someFn() { }`),
                     sys.checkTimeoutQueueLength(0);
                 },
             },
-        ]
+            {
+                caption: "Modify extendsConfigFile2",
+                edit: sys => sys.writeFile("/a/b/extendsConfig2.tsconfig.json", JSON.stringify({
+                    compilerOptions: { strictNullChecks: true }
+                })),
+                timeouts: sys => { // Build project3
+                    sys.checkTimeoutQueueLengthAndRun(1);
+                    sys.checkTimeoutQueueLength(0);
+                },
+            },
+            {
+                caption: "Modify project 3",
+                edit: sys => sys.writeFile("/a/b/project3.tsconfig.json", JSON.stringify({
+                    extends: ["./extendsConfig1.tsconfig.json", "./extendsConfig2.tsconfig.json"],
+                    compilerOptions: { composite: false },
+                    files: ["/a/b/other2.ts"]
+                })),
+                timeouts: sys => { // Build project3
+                    sys.checkTimeoutQueueLengthAndRun(1);
+                    sys.checkTimeoutQueueLength(0);
+                },
+            },
+            {
+                caption: "Delete extendedConfigFile2 and report error",
+                edit: sys => sys.deleteFile("./extendsConfig2.tsconfig.json"),
+                timeouts: sys => { // Build project3
+                    sys.checkTimeoutQueueLengthAndRun(1);
+                    sys.checkTimeoutQueueLength(0);
+                },
+            }
+        ],
     });
 
     verifyTscWatch({
diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -9170,7 +9170,7 @@ declare namespace ts {
         /**
          * Note that the case of the config path has not yet been normalized, as no files have been imported into the project yet
          */
-        extendedConfigPath?: string;
+        extendedConfigPath?: string | string[];
     }
     interface ExtendedConfigCacheEntry {
         extendedResult: TsConfigSourceFile;
diff --git a/tests/baselines/reference/api/typescript.d.ts b/tests/baselines/reference/api/typescript.d.ts
@@ -5236,7 +5236,7 @@ declare namespace ts {
         /**
          * Note that the case of the config path has not yet been normalized, as no files have been imported into the project yet
          */
-        extendedConfigPath?: string;
+        extendedConfigPath?: string | string[];
     }
     interface ExtendedConfigCacheEntry {
         extendedResult: TsConfigSourceFile;
diff --git a/tests/baselines/reference/configFileExtendsAsList.errors.txt b/tests/baselines/reference/configFileExtendsAsList.errors.txt
@@ -0,0 +1,31 @@
+/index.ts(1,12): error TS7006: Parameter 'x' implicitly has an 'any' type.
+/index.ts(3,1): error TS2454: Variable 'y' is used before being assigned.
+
+
+==== /tsconfig.json (0 errors) ====
+    {
+        "extends": ["./tsconfig1.json", "./tsconfig2.json"]
+    }
+    
+==== /tsconfig1.json (0 errors) ====
+    {
+        "compilerOptions": {
+            "strictNullChecks": true
+        }
+    }
+    
+==== /tsconfig2.json (0 errors) ====
+    {
+        "compilerOptions": {
+            "noImplicitAny": true
+        }
+    }
+    
+==== /index.ts (2 errors) ====
+    function f(x) { } // noImplicitAny error
+               ~
+!!! error TS7006: Parameter 'x' implicitly has an 'any' type.
+    let y: string;
+    y.toLowerCase(); // strictNullChecks error
+    ~
+!!! error TS2454: Variable 'y' is used before being assigned.
diff --git a/tests/baselines/reference/configFileExtendsAsList.js b/tests/baselines/reference/configFileExtendsAsList.js
@@ -0,0 +1,25 @@
+//// [tests/cases/compiler/configFileExtendsAsList.ts] ////
+
+//// [tsconfig1.json]
+{
+    "compilerOptions": {
+        "strictNullChecks": true
+    }
+}
+
+//// [tsconfig2.json]
+{
+    "compilerOptions": {
+        "noImplicitAny": true
+    }
+}
+
+//// [index.ts]
+function f(x) { } // noImplicitAny error
+let y: string;
+y.toLowerCase(); // strictNullChecks error
+
+//// [index.js]
+function f(x) { } // noImplicitAny error
+var y;
+y.toLowerCase(); // strictNullChecks error
diff --git a/tests/baselines/reference/configFileExtendsAsList.symbols b/tests/baselines/reference/configFileExtendsAsList.symbols
@@ -0,0 +1,13 @@
+=== /index.ts ===
+function f(x) { } // noImplicitAny error
+>f : Symbol(f, Decl(index.ts, 0, 0))
+>x : Symbol(x, Decl(index.ts, 0, 11))
+
+let y: string;
+>y : Symbol(y, Decl(index.ts, 1, 3))
+
+y.toLowerCase(); // strictNullChecks error
+>y.toLowerCase : Symbol(String.toLowerCase, Decl(lib.es5.d.ts, --, --))
+>y : Symbol(y, Decl(index.ts, 1, 3))
+>toLowerCase : Symbol(String.toLowerCase, Decl(lib.es5.d.ts, --, --))
+
diff --git a/tests/baselines/reference/configFileExtendsAsList.types b/tests/baselines/reference/configFileExtendsAsList.types
@@ -0,0 +1,14 @@
+=== /index.ts ===
+function f(x) { } // noImplicitAny error
+>f : (x: any) => void
+>x : any
+
+let y: string;
+>y : string
+
+y.toLowerCase(); // strictNullChecks error
+>y.toLowerCase() : string
+>y.toLowerCase : () => string
+>y : string
+>toLowerCase : () => string
+
diff --git a/tests/baselines/reference/tsbuildWatch/programUpdates/works-with-extended-source-files.js b/tests/baselines/reference/tsbuildWatch/programUpdates/works-with-extended-source-files.js
diff --git a/tests/cases/compiler/configFileExtendsAsList.ts b/tests/cases/compiler/configFileExtendsAsList.ts

Original file line number	Diff line number	Diff line change
`@@ -380,6 +380,7 @@ export namespace Compiler {`
`380`	`380`	`}`
`381`	`381`	`// If not a primitive, the possible types are specified in what is effectively a map of options.`
`382`	`382`	`case "list":`
	`383`	`+ case "listOrElement":`
`383`	`384`	`return ts.parseListTypeOption(option, value, errors);`
`384`	`385`	`default:`
`385`	`386`	`return ts.parseCustomTypeOption(option as ts.CommandLineOptionOfCustomType, value, errors);`
Original file line number	Diff line number	Diff line change
`@@ -147,6 +147,10 @@ describe("unittests:: config:: showConfig", () => {`
`147`	`147`	`}`
`148`	`148`	`break;`
`149`	`149`	`}`
	`150`	`+ case "listOrElement": {`
	`151`	`+ ts.Debug.fail();`
	`152`	`+ break;`
	`153`	`+ }`
`150`	`154`	`case "string": {`
`151`	`155`	`if (option.isTSConfigOnly) {`
`152`	`156`	`args = ["-p", "tsconfig.json"];`
Original file line number	Diff line number	Diff line change
`@@ -9170,7 +9170,7 @@ declare namespace ts {`
`9170`	`9170`	`/**`
`9171`	`9171`	`* Note that the case of the config path has not yet been normalized, as no files have been imported into the project yet`
`9172`	`9172`	`*/`
`9173`		`- extendedConfigPath?: string;`
	`9173`	`+ extendedConfigPath?: string \| string[];`
`9174`	`9174`	`}`
`9175`	`9175`	`interface ExtendedConfigCacheEntry {`
`9176`	`9176`	`extendedResult: TsConfigSourceFile;`