add description propery to editor commands

microsoft · Aug 22, 2016 · 16dd81d · 16dd81d
1 parent ad7c1fe
commit 16dd81d
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/vs/editor/common/config/config.ts b/src/vs/editor/common/config/config.ts
@@ -30,17 +30,20 @@ export interface ICommandOptions {
 	id: string;
 	precondition: ContextKeyExpr;
 	kbOpts?: ICommandKeybindingsOptions;
+	description?: ICommandHandlerDescription;
 }
 
 export abstract class Command {
 	public id: string;
 	public precondition: ContextKeyExpr;
 	private kbOpts: ICommandKeybindingsOptions;
+	private description: ICommandHandlerDescription;
 
 	constructor(opts:ICommandOptions) {
 		this.id = opts.id;
 		this.precondition = opts.precondition;
 		this.kbOpts = opts.kbOpts;
+		this.description = opts.description;
 	}
 
 	public abstract runCommand(accessor:ServicesAccessor, args: any): void | TPromise<void>;
@@ -67,6 +70,7 @@ export abstract class Command {
 			win: kbOpts.win,
 			linux: kbOpts.linux,
 			mac: kbOpts.mac,
+			description: this.description
 		};
 	}
 }

diff --git a/src/vs/editor/common/editorCommonExtensions.ts b/src/vs/editor/common/editorCommonExtensions.ts
@@ -62,10 +62,14 @@ export abstract class EditorAction extends ConfigEditorCommand {
 	}
 
 	public runEditorCommand(accessor:ServicesAccessor, editor: editorCommon.ICommonCodeEditor, args: any): void | TPromise<void> {
-		accessor.get(ITelemetryService).publicLog('editorActionInvoked', { name: this.label, id: this.id });
+		this.reportTelemetry(accessor);
 		return this.run(accessor, editor);
 	}
 
+	protected reportTelemetry(accessor:ServicesAccessor){
+		accessor.get(ITelemetryService).publicLog('editorActionInvoked', { name: this.label, id: this.id });
+	}
+
 	public abstract run(accessor:ServicesAccessor, editor:editorCommon.ICommonCodeEditor): void | TPromise<void>;
 }