Flag program in launch.json as an optional property (microsoft#1578)

DonJayamanne · web-flow · commit 1e09454e14d3 · 2018-05-07T11:51:35.000-07:00
Fixes microsoft#1503 Also fix a few other linter warnings/errors.
diff --git a/news/3 Code Health/1503.md b/news/3 Code Health/1503.md
@@ -0,0 +1 @@
+Flag `program` in `launch.json` configuration items as an optional attribute.
diff --git a/src/client/debugger/Common/Contracts.ts b/src/client/debugger/Common/Contracts.ts
@@ -71,7 +71,7 @@ export interface BaseLaunchRequestArguments extends DebugProtocol.LaunchRequestA
     type?: DebuggerType;
     /** An absolute path to the program to debug. */
     module?: string;
-    program: string;
+    program?: string;
     pythonPath: string;
     /** Automatically stop target after launch. If not specified, target does not stop. */
     stopOnEntry?: boolean;
diff --git a/src/client/debugger/Main.ts b/src/client/debugger/Main.ts
@@ -92,7 +92,7 @@ export class PythonDebugger extends LoggingDebugSession {
     private startDebugServer(): Promise<IDebugServer> {
         let programDirectory = '';
         if ((this.launchArgs && this.launchArgs.program) || (this.attachArgs && this.attachArgs.localRoot)) {
-            programDirectory = this.launchArgs ? path.dirname(this.launchArgs.program) : this.attachArgs.localRoot;
+            programDirectory = (this.launchArgs && this.launchArgs.program) ? path.dirname(this.launchArgs.program) : this.attachArgs.localRoot;
         }
         if (this.launchArgs && typeof this.launchArgs.cwd === 'string' && this.launchArgs.cwd.length > 0 && this.launchArgs.cwd !== 'null') {
             programDirectory = this.launchArgs.cwd;
@@ -227,7 +227,7 @@ export class PythonDebugger extends LoggingDebugSession {
         }
         // Confirm the file exists
         if (typeof args.module !== 'string' || args.module.length === 0) {
-            if (!fs.existsSync(args.program)) {
+            if (!args.program || !fs.existsSync(args.program)) {
                 return this.sendErrorResponse(response, 2001, `File does not exist. "${args.program}"`);
             }
         }
diff --git a/src/client/workspaceSymbols/generator.ts b/src/client/workspaceSymbols/generator.ts
@@ -31,7 +31,7 @@ export class Generator implements vscode.Disposable {
         if (!this.pythonSettings.workspaceSymbols.enabled) {
             return;
         }
-        return await this.generateTags({ directory: this.workspaceFolder.fsPath });
+        return this.generateTags({ directory: this.workspaceFolder.fsPath });
     }
     private buildCmdArgs(): string[] {
         const exclusions = this.pythonSettings.workspaceSymbols.exclusionPatterns;
@@ -40,7 +40,7 @@ export class Generator implements vscode.Disposable {
         return [`--options=${this.optionsFile}`, '--languages=Python'].concat(excludes);
     }
     @captureTelemetry(WORKSPACE_SYMBOLS_BUILD)
-    private generateTags(source: { directory?: string, file?: string }): Promise<void> {
+    private generateTags(source: { directory?: string; file?: string }): Promise<void> {
         const tagFile = path.normalize(this.pythonSettings.workspaceSymbols.tagFilePath);
         const cmd = this.pythonSettings.workspaceSymbols.ctagsPath;
         const args = this.buildCmdArgs();

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Flag `program` in `launch.json` configuration items as an optional attribute.
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ export class PythonDebugger extends LoggingDebugSession {`
`92`	`92`	`private startDebugServer(): Promise<IDebugServer> {`
`93`	`93`	`let programDirectory = '';`
`94`	`94`	`if ((this.launchArgs && this.launchArgs.program) \|\| (this.attachArgs && this.attachArgs.localRoot)) {`
`95`		`- programDirectory = this.launchArgs ? path.dirname(this.launchArgs.program) : this.attachArgs.localRoot;`
	`95`	`+ programDirectory = (this.launchArgs && this.launchArgs.program) ? path.dirname(this.launchArgs.program) : this.attachArgs.localRoot;`
`96`	`96`	`}`
`97`	`97`	`if (this.launchArgs && typeof this.launchArgs.cwd === 'string' && this.launchArgs.cwd.length > 0 && this.launchArgs.cwd !== 'null') {`
`98`	`98`	`programDirectory = this.launchArgs.cwd;`
`@@ -227,7 +227,7 @@ export class PythonDebugger extends LoggingDebugSession {`
`227`	`227`	`}`
`228`	`228`	`// Confirm the file exists`
`229`	`229`	`if (typeof args.module !== 'string' \|\| args.module.length === 0) {`
`230`		`- if (!fs.existsSync(args.program)) {`
	`230`	`+ if (!args.program \|\| !fs.existsSync(args.program)) {`
`231`	`231`	return this.sendErrorResponse(response, 2001, `File does not exist. "${args.program}"`);
`232`	`232`	`}`
`233`	`233`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ export class Generator implements vscode.Disposable {`
`31`	`31`	`if (!this.pythonSettings.workspaceSymbols.enabled) {`
`32`	`32`	`return;`
`33`	`33`	`}`
`34`		`- return await this.generateTags({ directory: this.workspaceFolder.fsPath });`
	`34`	`+ return this.generateTags({ directory: this.workspaceFolder.fsPath });`
`35`	`35`	`}`
`36`	`36`	`private buildCmdArgs(): string[] {`
`37`	`37`	`const exclusions = this.pythonSettings.workspaceSymbols.exclusionPatterns;`
`@@ -40,7 +40,7 @@ export class Generator implements vscode.Disposable {`
`40`	`40`	return [`--options=${this.optionsFile}`, '--languages=Python'].concat(excludes);
`41`	`41`	`}`
`42`	`42`	`@captureTelemetry(WORKSPACE_SYMBOLS_BUILD)`
`43`		`- private generateTags(source: { directory?: string, file?: string }): Promise<void> {`
	`43`	`+ private generateTags(source: { directory?: string; file?: string }): Promise<void> {`
`44`	`44`	`const tagFile = path.normalize(this.pythonSettings.workspaceSymbols.tagFilePath);`
`45`	`45`	`const cmd = this.pythonSettings.workspaceSymbols.ctagsPath;`
`46`	`46`	`const args = this.buildCmdArgs();`