Add plugin override for watchFactory

Author: sheetalkamat

src/compiler/commandLineParser.ts

@@ -6950,10 +6950,16 @@ export interface CreateProgramOptions {
     configFileParsingDiagnostics?: readonly Diagnostic[];
 }
 
+ /** @internal */
+export type CommandLineOptionExtraValidation = (value: CompilerOptionsValue, valueExpression?: Expression) =>
+    readonly [DiagnosticMessage, ...string[]] |
+    { diagnostics: readonly [DiagnosticMessage, ...string[]]; errorNode: Expression; } |
+    undefined;
+
 /** @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" | "string | object" | 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.
@@ -6973,7 +6979,7 @@ export interface CommandLineOptionBase {
     affectsDeclarationPath?: true;                          // true if the options affects declaration file path computed
     affectsBuildInfo?: true;                                // true if this options should be emitted in buildInfo
     transpileOptionValue?: boolean | undefined;             // If set this means that the option should be set to this value when transpiling
-    extraValidation?: (value: CompilerOptionsValue) => [DiagnosticMessage, ...string[]] | undefined; // Additional validation to be performed for the value to be valid
+    extraValidation?: CommandLineOptionExtraValidation;     // Additional validation to be performed for the value to be valid
 }
 
 /** @internal */
@@ -7015,21 +7021,21 @@ export interface DidYouMeanOptionsDiagnostics {
 }
 
 /** @internal */
-export interface TsConfigOnlyOption extends CommandLineOptionBase {
-    type: "object";
+export interface CommandLineOptionOfObjectType extends CommandLineOptionBase {
+    type: "object" | "string | object";
     elementOptions?: Map<string, CommandLineOption>;
     extraKeyDiagnostics?: DidYouMeanOptionsDiagnostics;
 }
 
 /** @internal */
 export interface CommandLineOptionOfListType extends CommandLineOptionBase {
     type: "list";
-    element: CommandLineOptionOfCustomType | CommandLineOptionOfStringType | CommandLineOptionOfNumberType | CommandLineOptionOfBooleanType | TsConfigOnlyOption;
+    element: CommandLineOptionOfCustomType | CommandLineOptionOfStringType | CommandLineOptionOfNumberType | CommandLineOptionOfBooleanType | CommandLineOptionOfObjectType;
     listPreserveFalsyValues?: boolean;
 }
 
 /** @internal */
-export type CommandLineOption = CommandLineOptionOfCustomType | CommandLineOptionOfStringType | CommandLineOptionOfNumberType | CommandLineOptionOfBooleanType | TsConfigOnlyOption | CommandLineOptionOfListType;
+export type CommandLineOption = CommandLineOptionOfCustomType | CommandLineOptionOfStringType | CommandLineOptionOfNumberType | CommandLineOptionOfBooleanType | CommandLineOptionOfObjectType | CommandLineOptionOfListType;
 
 /** @internal */
 export const enum CharacterCodes {

src/compiler/types.ts

@@ -299,6 +299,7 @@ function generateOptionOutput(sys: System, option: CommandLineOption, rightAlign
                 case "string":
                 case "number":
                 case "boolean":
+                case "string | object":
                     return getDiagnosticText(Diagnostics.type_Colon);
                 case "list":
                     return getDiagnosticText(Diagnostics.one_or_more_Colon);
@@ -319,6 +320,9 @@ function generateOptionOutput(sys: System, option: CommandLineOption, rightAlign
                     // TODO: check infinite loop
                     possibleValues = getPossibleValues(option.element);
                     break;
+                case "string | object":
+                    possibleValues = "string";
+                    break;
                 case "object":
                     possibleValues = "";
                     break;

src/executeCommandLine/executeCommandLine.ts

@@ -377,8 +377,11 @@ export namespace Compiler {
             // If not a primitive, the possible types are specified in what is effectively a map of options.
             case "list":
                 return ts.parseListTypeOption(option, value, errors);
+            case "object":
+            case "string | object":
+                return ts.parseObjectTypeOption(option, value, errors)?.value;
             default:
-                return ts.parseCustomTypeOption(option as ts.CommandLineOptionOfCustomType, value, errors);
+                return ts.parseCustomTypeOption(option, value, errors);
         }
     }
 

src/harness/harnessIO.ts

@@ -191,6 +191,9 @@ describe("unittests:: config:: commandLineParsing:: parseCommandLine", () => {
         assertParseResult("errors on invalid excludeFiles", ["--excludeFiles", "**/../*", "0.ts"]);
         assertParseResult("parse --watchFactory", ["--watchFactory", "somefactory", "0.ts"]);
         assertParseResult("errors on invalid watchFactory", ["--watchFactory", "somefactory/../malicious", "0.ts"]);
+        assertParseResult("parse --watchFactory object", ["--watchFactory", "{\"name\":\"somefactory\",\"myconfig\":\"somethingelse\"}", "0.ts"]);
+        assertParseResult("errors on invalid watchFactory name", ["--watchFactory", "{\"name\":\"somefactory/../malicious\"}", "0.ts"]);
+        assertParseResult("errors on invalid watchFactory object", ["--watchFactory", "{\"name\":\"myplugin\"", "0.ts"]);
     });
 });
 
@@ -247,5 +250,8 @@ describe("unittests:: config:: commandLineParsing:: parseBuildOptions", () => {
         assertParseResult("errors on invalid excludeFiles", ["--excludeFiles", "**/../*"]);
         assertParseResult("parse --watchFactory", ["--watchFactory", "somefactory"]);
         assertParseResult("errors on invalid watchFactory", ["--watchFactory", "somefactory/../malicious"]);
+        assertParseResult("parse --watchFactory object", ["--watchFactory", `{"name":"somefactory","myconfig":"somethingelse"}`]);
+        assertParseResult("errors on invalid watchFactory name", ["--watchFactory", "{\"name\":\"somefactory/../malicious\"}"]);
+        assertParseResult("errors on invalid watchFactory object", ["--watchFactory", "{\"name\":\"myplugin\""]);
     });
 });

src/testRunner/unittests/config/commandLineParsing.ts

@@ -126,6 +126,24 @@ describe("unittests:: config:: showConfig", () => {
         if (option.name === "project") return;
         let args: string[];
         let optionValue: object | undefined;
+        if (option.type === "string | object") {
+            if (option.isTSConfigOnly) {
+                showTSConfigCorrectly(
+                    `Shows tsconfig for single option/${option.name}WithStringValue`,
+                    ["-p", "tsconfig.json"],
+                    isCompilerOptions ?
+                        { compilerOptions: { [option.name]: "someString" } } :
+                        { watchOptions: { [option.name]: "someString" } }
+                );
+            }
+            else {
+                showTSConfigCorrectly(
+                    `Shows tsconfig for single option/${option.name}WithStringValue`,
+                    [`--${option.name}`, "someString"],
+                        /*configJson*/ undefined,
+                );
+            }
+        }
         switch (option.type) {
             case "boolean": {
                 if (option.isTSConfigOnly) {
@@ -167,6 +185,7 @@ describe("unittests:: config:: showConfig", () => {
                 }
                 break;
             }
+            case "string | object":
             case "object": {
                 args = ["-p", "tsconfig.json"];
                 optionValue = { [option.name]: {} };

src/testRunner/unittests/config/showConfig.ts

@@ -169,6 +169,12 @@ describe("unittests:: config:: tsconfigParsingWatchOptions:: parseConfigFileText
         {
             json: { watchOptions: { watchFactory: "somefactory/../malicious" } },
         },
+        {
+            json: { watchOptions: { watchFactory: { name: "somefactory", myconfig: "somethingelse" } } },
+        },
+        {
+            json: { watchOptions: { watchFactory: { name: "somefactory/../malicious" } } },
+        },
     ]);
 
     verifyWatchOptions("watch options extending passed in watch options", () => [

src/testRunner/unittests/config/tsconfigParsingWatchOptions.ts

@@ -928,8 +928,7 @@ describe("unittests:: tsc-watch:: watchEnvironment:: tsc-watch with different po
                 scenario,
                 ...input,
                 subScenario: `${input.subScenario} object`,
-                sys: () => input.sys({ watchFactory }),
-                // sys: () => input.sys({ watchFactory: { name: watchFactory, myconfig: "somethingelse" } as ts.PluginImport }),
+                sys: () => input.sys({ watchFactory: { name: watchFactory, myconfig: "somethingelse" } as ts.PluginImport }),
             });
         }
 
@@ -946,8 +945,7 @@ describe("unittests:: tsc-watch:: watchEnvironment:: tsc-watch with different po
                 scenario,
                 ...input,
                 subScenario: `${input.subScenario} object`,
-                commandLineArgs: ["-w", "--extendedDiagnostics", "--watchFactory", watchFactory],
-                // commandLineArgs: ["-w", "--extendedDiagnostics", "--watchFactory", JSON.stringify({ name: watchFactory, myconfig: "somethingelse" })],
+                commandLineArgs: ["-w", "--extendedDiagnostics", "--watchFactory", JSON.stringify({ name: watchFactory, myconfig: "somethingelse" })],
             });
         }
     });

src/testRunner/unittests/tscWatch/watchEnvironment.ts

@@ -714,9 +714,8 @@ describe("unittests:: tsserver:: watchEnvironment:: watchFile is single watcher
         interface PluginImport extends ts.PluginImport {
             myconfig: "somethingelse";
         }
-        function getWatchFactory(watchFactory: string, _useObject: boolean): PluginImport | string {
-            return watchFactory;
-            // return useObject ? { name: watchFactory, myconfig: "somethingelse" } : watchFactory;
+        function getWatchFactory(watchFactory: string, useObject: boolean): PluginImport | string {
+            return useObject ? { name: watchFactory, myconfig: "somethingelse" } : watchFactory;
         }
 
         function configureGlobalWatchOptions(session: TestSession, watchFactory: string, useObject: boolean) {

src/testRunner/unittests/tsserver/watchEnvironment.ts

@@ -0,0 +1,9 @@
+--watchFactory {"name":"somefactory/../malicious"}
+buildOptions::
+{}
+WatchOptions::
+{}
+Projects::
+.
+Errors::
+error TS5096: 'watchFactory' name can only be a package name.