Adding an overload to TextEditor.edit for insertion of a SnippetString

extensions/vscode-api-tests/src/editor.test.ts

@@ -6,7 +6,7 @@
 'use strict';
 
 import * as assert from 'assert';
-import { workspace, window, Position, Range, commands, TextEditor, TextDocument, TextEditorCursorStyle, TextEditorLineNumbersStyle } from 'vscode';
+import { workspace, window, Position, Range, commands, TextEditor, TextDocument, TextEditorCursorStyle, TextEditorLineNumbersStyle, SnippetString } from 'vscode';
 import { createRandomFile, deleteFile, cleanUp } from './utils';
 
 suite('editor tests', () => {
@@ -33,6 +33,35 @@ suite('editor tests', () => {
 		});
 	}
 
+	test('insert snippet', () => {
+		const snippetString = new SnippetString()
+			.appendText('This is a ')
+			.appendTabstop()
+			.appendPlaceholder('placeholder')
+			.appendText(' snippet');
+
+		return withRandomFileEditor('', (editor, doc) => {
+			return editor.insertSnippet(snippetString.value, new Position(0, 0)).then(inserted => {
+				assert.ok(inserted);
+				assert.equal(doc.getText(), 'This is a placeholder snippet');
+				assert.ok(doc.isDirty);
+			});
+		});
+	});
+
+	test('insert snippet with replacement', () => {
+		const snippetString = new SnippetString()
+			.appendText('has been');
+
+		return withRandomFileEditor('This will be replaced', (editor, doc) => {
+			return editor.insertSnippet(snippetString.value, new Range(0, 5, 0, 12)).then(inserted => {
+				assert.ok(inserted);
+				assert.equal(doc.getText(), 'This has been replaced');
+				assert.ok(doc.isDirty);
+			});
+		});
+	});
+
 	test('make edit', () => {
 		return withRandomFileEditor('', (editor, doc) => {
 			return editor.edit((builder) => {

extensions/vscode-api-tests/src/typings/ref.d.ts

@@ -3,6 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+/// <reference path='../../../../src/vs/vscode.proposed.d.ts'/>
 /// <reference path='../../../../src/typings/mocha.d.ts'/>
 /// <reference path='../../../../extensions/declares.d.ts'/>
 /// <reference path='../../../../extensions/node.d.ts'/>

src/vs/editor/contrib/snippet/common/snippetController.ts

@@ -466,11 +466,20 @@ export class SnippetController {
 		return SnippetController.ID;
 	}
 
+	public get inSnippetMode() {
+		return this._inSnippetMode.get();
+	}
+
 	public insertSnippet(template: string, overwriteBefore: number, overwriteAfter: number): void {
 		const snippet = CodeSnippet.fromTextmate(template, this._variableResolver);
 		this.run(snippet, overwriteBefore, overwriteAfter);
 	}
 
+	public insertSnippetWithReplaceRange(template: string, replaceRange: Range): void {
+		const snippet = CodeSnippet.fromTextmate(template, this._variableResolver);
+		this.runWithReplaceRange(snippet, replaceRange);
+	}
+
 	public run(snippet: CodeSnippet, overwriteBefore: number, overwriteAfter: number, stripPrefix?: boolean): void {
 		this._runAndRestoreController(() => {
 			if (snippet.isInsertOnly || snippet.isSingleTabstopOnly) {

src/vs/vscode.d.ts

@@ -967,6 +967,17 @@ declare module 'vscode' {
 		 */
 		edit(callback: (editBuilder: TextEditorEdit) => void, options?: { undoStopBefore: boolean; undoStopAfter: boolean; }): Thenable<boolean>;
 
+		/**
+		 * Inserts the given snippet template and enters snippet mode.
+		 *
+		 * If the editor is already in snippet mode, insertion fails and the returned promise resolves to false.
+		 *
+		 * @param template The snippet template to insert
+		 * @param posOrRange The position or replacement range representing the location of the insertion.
+		 * @return A promise that resolves with a value indicating if the snippet could be inserted.
+		 */
+		insertSnippet(template: string, posOrRange: Position | Range): Thenable<boolean>;
+
 		/**
 		 * Adds a set of decorations to the text editor. If a set of decorations already exists with
 		 * the given [decoration type](#TextEditorDecorationType), they will be replaced.

src/vs/vscode.proposed.d.ts

@@ -85,4 +85,16 @@ declare module 'vscode' {
 		 */
 		getClickCommand?(node: T): string;
 	}
+	export interface TextEditor {
+		/**
+		 * Inserts the given snippet template and enters snippet mode.
+		 *
+		 * If the editor is already in snippet mode, insertion fails and the returned promise resolves to false.
+		 *
+		 * @param template The snippet template to insert
+		 * @param posOrRange The position or replacement range representing the location of the insertion.
+		 * @return A promise that resolves with a value indicating if the snippet could be inserted.
+		 */
+		insertSnippet(template: string, posOrRange: Position | Range): Thenable<boolean>;
+	}
 }

src/vs/workbench/api/node/extHost.protocol.ts

@@ -137,6 +137,7 @@ export abstract class MainThreadEditorsShape {
 	$tryRevealRange(id: string, range: editorCommon.IRange, revealType: TextEditorRevealType): TPromise<any> { throw ni(); }
 	$trySetSelections(id: string, selections: editorCommon.ISelection[]): TPromise<any> { throw ni(); }
 	$tryApplyEdits(id: string, modelVersionId: number, edits: editorCommon.ISingleEditOperation[], opts: IApplyEditsOptions): TPromise<boolean> { throw ni(); }
+	$tryInsertSnippet(id: string, template: string, posOrRange: editorCommon.IPosition | editorCommon.IRange): TPromise<boolean> { throw ni(); }
 }
 
 export abstract class MainThreadTreeExplorersShape {

src/vs/workbench/api/node/extHostEditors.ts

@@ -13,7 +13,7 @@ import { TPromise } from 'vs/base/common/winjs.base';
 import { IThreadService } from 'vs/workbench/services/thread/common/threadService';
 import { ExtHostDocuments, ExtHostDocumentData } from 'vs/workbench/api/node/extHostDocuments';
 import { Selection, Range, Position, EndOfLine, TextEditorRevealType, TextEditorSelectionChangeKind, TextEditorLineNumbersStyle } from './extHostTypes';
-import { ISingleEditOperation, TextEditorCursorStyle } from 'vs/editor/common/editorCommon';
+import { ISingleEditOperation, TextEditorCursorStyle, IPosition, IRange } from 'vs/editor/common/editorCommon';
 import { IResolvedTextEditorConfiguration, ISelectionChangeEvent, ITextEditorConfigurationUpdate } from 'vs/workbench/api/node/mainThreadEditorsTracker';
 import * as TypeConverters from './extHostTypeConverters';
 import { MainContext, MainThreadEditorsShape, ExtHostEditorsShape, ITextEditorAddData, ITextEditorPositionData } from './extHost.protocol';
@@ -620,6 +620,22 @@ class ExtHostTextEditor implements vscode.TextEditor {
 		});
 	}
 
+	insertSnippet(template: string, posOrRange: Position | Range) {
+		let convertedPosOrRange: IPosition | IRange;
+
+		if (Position.isPosition(posOrRange)) {
+			convertedPosOrRange = TypeConverters.fromPosition(posOrRange);
+		}
+		else if (Range.isRange(posOrRange)) {
+			convertedPosOrRange = TypeConverters.fromRange(posOrRange);
+		}
+		else {
+			return TPromise.wrapError(new Error('Unrecognized value for posOrRange'));
+		}
+
+		return this._proxy.$tryInsertSnippet(this._id, template, convertedPosOrRange);
+	}
+
 	// ---- util
 
 	private _runOnProxy(callback: () => TPromise<any>, silent: boolean): TPromise<ExtHostTextEditor> {

src/vs/workbench/api/node/mainThreadEditors.ts

@@ -8,7 +8,7 @@ import URI from 'vs/base/common/uri';
 import { IDisposable, dispose } from 'vs/base/common/lifecycle';
 import { TPromise } from 'vs/base/common/winjs.base';
 import { IThreadService } from 'vs/workbench/services/thread/common/threadService';
-import { ISingleEditOperation, ISelection, IRange, IEditor, EditorType, ICommonCodeEditor, ICommonDiffEditor, IDecorationRenderOptions, IDecorationOptions } from 'vs/editor/common/editorCommon';
+import { ISingleEditOperation, ISelection, IPosition, IRange, IEditor, EditorType, ICommonCodeEditor, ICommonDiffEditor, IDecorationRenderOptions, IDecorationOptions } from 'vs/editor/common/editorCommon';
 import { ICodeEditorService } from 'vs/editor/common/services/codeEditorService';
 import { IWorkbenchEditorService } from 'vs/workbench/services/editor/common/editorService';
 import { IEditorGroupService } from 'vs/workbench/services/group/common/groupService';
@@ -293,6 +293,13 @@ export class MainThreadEditors extends MainThreadEditorsShape {
 		return TPromise.as(this._textEditorsMap[id].applyEdits(modelVersionId, edits, opts));
 	}
 
+	$tryInsertSnippet(id: string, template: string, posOrRange: IPosition | IRange): TPromise<boolean> {
+		if (!this._textEditorsMap[id]) {
+			return TPromise.wrapError('TextEditor disposed');
+		}
+		return TPromise.as(this._textEditorsMap[id].insertSnippet(template, posOrRange));
+	}
+
 	$registerTextEditorDecorationType(key: string, options: IDecorationRenderOptions): void {
 		this._editorTracker.registerTextEditorDecorationType(key, options);
 	}

src/vs/workbench/api/node/mainThreadEditorsTracker.ts

@@ -12,8 +12,10 @@ import { IModelService } from 'vs/editor/common/services/modelService';
 import { IDisposable, dispose } from 'vs/base/common/lifecycle';
 import { RunOnceScheduler } from 'vs/base/common/async';
 import { IdGenerator } from 'vs/base/common/idGenerator';
+import { Position } from 'vs/editor/common/core/position';
 import { Range } from 'vs/editor/common/core/range';
 import { Selection } from 'vs/editor/common/core/selection';
+import { SnippetController } from 'vs/editor/contrib/snippet/common/snippetController';
 import { EndOfLine, TextEditorLineNumbersStyle } from 'vs/workbench/api/node/extHostTypes';
 
 export interface ITextEditorConfigurationUpdate {
@@ -383,6 +385,29 @@ export class MainThreadTextEditor {
 		console.warn('applyEdits on invisible editor');
 		return false;
 	}
+
+	insertSnippet(template: string, posOrRange: EditorCommon.IPosition | EditorCommon.IRange) {
+		const snippetController = SnippetController.get(this._codeEditor);
+		if (snippetController.inSnippetMode) {
+			return false;
+		}
+
+		const range = Range.isIRange(posOrRange) ? Range.lift(posOrRange) : null;
+		const position = Position.isIPosition(posOrRange) ? Position.lift(posOrRange) : range.getStartPosition();
+
+		this._codeEditor.setPosition(position);
+		this._codeEditor.revealLine(position.lineNumber);
+		this._codeEditor.focus();
+
+		if (range) {
+			snippetController.insertSnippetWithReplaceRange(template, range);
+		}
+		else {
+			snippetController.insertSnippet(template, 0, 0);
+		}
+
+		return true;
+	}
 }
 
 /**

src/vs/workbench/test/node/api/extHostEditors.test.ts

@@ -34,6 +34,7 @@ suite('ExtHostTextEditorOptions', () => {
 			$tryRevealRange: undefined,
 			$trySetSelections: undefined,
 			$tryApplyEdits: undefined,
+			$tryInsertSnippet: undefined
 		};
 		opts = new ExtHostTextEditorOptions(mockProxy, '1', {
 			tabSize: 4,