Made boolean CLI option values optional, if no value is supplied they default to true (#446)

Perryvw · web-flow · commit f7e95b9a6cf2 · 2019-02-23T18:17:04.000+01:00
diff --git a/src/CommandLineParser.ts b/src/CommandLineParser.ts
@@ -10,6 +10,10 @@ type ParseResult<T> =
     { isValid: true; result: T }
     | { isValid: false, errorMessage: string};
 
+type ArgumentParseResult<T> =
+    { isValid: true; result: T; increment?: number }
+    | { isValid: false, errorMessage: string };
+
 interface ParsedCommandLine extends ts.ParsedCommandLine {
     options: CompilerOptions;
 }
@@ -190,10 +194,11 @@ function parseTSTLOptions(commandLine: ts.ParsedCommandLine, args: string[]): CL
             const argumentName = args[i].substr(2);
             const option = optionDeclarations[argumentName];
             if (option) {
-                const argumentResult = getArgumentValue(argumentName, args[i + 1]);
-                i++; // Skip the value from being considered as argument name
+                const argumentResult = getArgumentValue(argumentName, i, args);
                 if (argumentResult.isValid === true) {
                     result[argumentName] = argumentResult.result;
+                    // Skip value from being considered as option
+                    i += argumentResult.increment !== undefined ? argumentResult.increment : 1;
                 } else {
                     return { isValid: false, errorMessage: argumentResult.errorMessage };
                 }
@@ -209,10 +214,11 @@ function parseTSTLOptions(commandLine: ts.ParsedCommandLine, args: string[]): CL
             }
 
             if (argumentName) {
-                const argumentResult = getArgumentValue(argumentName, args[i + 1]);
-                i++; // Skip the value from being considered as argument name
+                const argumentResult = getArgumentValue(argumentName, i, args);
                 if (argumentResult.isValid === true) {
                     result[argumentName] = argumentResult.result;
+                    // Skip value from being considered as option
+                    i += argumentResult.increment !== undefined ? argumentResult.increment : 1;
                 } else {
                     return { isValid: false, errorMessage: argumentResult.errorMessage };
                 }
@@ -232,13 +238,24 @@ function parseTSTLOptions(commandLine: ts.ParsedCommandLine, args: string[]): CL
     return { isValid: true, result: commandLine };
 }
 
-function getArgumentValue(argumentName: string, argument: string): ParseResult<string | boolean>
+function getArgumentValue(
+    argumentName: string,
+    argumentIndex: number,
+    args: string[]
+): ArgumentParseResult<string | boolean>
 {
+    const option = optionDeclarations[argumentName];
+    const argument = args[argumentIndex + 1];
+
+    if (option.type === "boolean" && (argument === undefined || argument.startsWith("-"))) {
+        // Set boolean arguments without supplied value to true
+        return { isValid: true, result: true, increment: 0 };
+    }
+
     if (argument === undefined) {
         return { isValid: false, errorMessage: `Missing value for parameter ${argumentName}`};
     }
 
-    const option = optionDeclarations[argumentName];
     const value = readValue(argument, option.type, argumentName);
 
     if (option.choices) {
diff --git a/test/unit/commandLineParser.spec.ts b/test/unit/commandLineParser.spec.ts
@@ -66,6 +66,8 @@ export class CommandLineParserTests
     @TestCase([""], false)
     @TestCase(["--noHeader", "true"], true)
     @TestCase(["--noHeader", "false"], false)
+    @TestCase(["--noHeader"], true)
+    @TestCase(["--noHeader", "--noHoisting"], true)
     @Test("CLI parser noHeader")
     public cliParserNoHeader(args: string[], expected: boolean): void {
         const result = parseCommandLine(args);
@@ -76,6 +78,21 @@ export class CommandLineParserTests
         }
     }
 
+    @TestCase([""], false)
+    @TestCase(["--noHoisting", "true"], true)
+    @TestCase(["--noHoisting", "false"], false)
+    @TestCase(["--noHoisting"], true)
+    @TestCase(["--noHoisting", "--noHeader"], true)
+    @Test("CLI parser noHoisting")
+    public cliParserNoHoisting(args: string[], expected: boolean): void {
+        const result = parseCommandLine(args);
+        if (result.isValid === true) {
+            Expect(result.result.options.noHoisting).toBe(expected);
+        } else {
+            Expect(result.isValid).toBeTruthy();
+        }
+    }
+
     @TestCase([""], false)
     @TestCase(["--project", "tsconfig.json"], true)
     @TestCase(["-p", "tsconfig.json"], true)
@@ -89,6 +106,21 @@ export class CommandLineParserTests
         }
     }
 
+    @Test("CLI Parser Multiple Options")
+    public cliParserMultipleOptions(): void {
+        const commandLine = "--project tsconfig.json --noHeader --noHoisting -lt 5.3";
+        const result = parseCommandLine(commandLine.split(" "));
+
+        if (result.isValid === true) {
+            Expect(result.result.options.project).toBeDefined();
+            Expect(result.result.options.noHeader).toBe(true);
+            Expect(result.result.options.noHoisting).toBe(true);
+            Expect(result.result.options.luaTarget).toBe(LuaTarget.Lua53);
+        } else {
+            Expect(result.isValid).toBeTruthy();
+        }
+    }
+
     @TestCase([""], false)
     @TestCase(["--help"], true)
     @TestCase(["-h"], true)
