Add option to wrap snippet in Markdown code block

Author: lumaxis

package.json

@@ -29,6 +29,16 @@
 				"title": "Copy Without Leading Indentation"
 			}
 		],
+		"configuration": {
+			"title": "Snippet Copy",
+			"properties": {
+				"snippet-copy.addLanguageIdToMarkdownBlock": {
+					"type": "boolean",
+					"default": false,
+					"description": "Add a programming language identifier to the beginning of the Markdown code block. This is incompatible with some apps, for example Slack."
+				}
+			}
+		},
 		"keybindings": [
 			{
 				"command": "snippet-copy.copyWithoutLeadingIndentation",

src/lib/documentHelpers.ts

@@ -38,3 +38,7 @@ export function adjustedRangeWithMinimumIndentation(range: Range, minimumIndenta
 export function endOfLineCharacter(document: TextDocument): string {
 	return document.eol === EndOfLine.CRLF ? '\r\n' : '\n';
 }
+
+export function languageId(document: TextDocument): string {
+	return document.languageId;
+}

src/lib/textHelpers.ts

@@ -1,15 +1,21 @@
-import { Selection, TextDocument } from "vscode";
-import { contentOfLinesWithAdjustedIndentation, endOfLineCharacter, minimumIndentationForLineIndexes } from "./documentHelpers";
+import { Selection, TextDocument, workspace } from "vscode";
+import { contentOfLinesWithAdjustedIndentation, endOfLineCharacter, languageId, minimumIndentationForLineIndexes } from "./documentHelpers";
 import { lineIndexesForSelection } from "./selectionHelpers";
 
-export function generateSnippet(document: TextDocument, selections: Selection[]): string {
+export function generateSnippet(document: TextDocument, selections: Selection[], markdownCodeBlock = false): string {
 	let texts: string[] = [];
 	selections.forEach(selection => {
 		texts.push(generateCopyableText(document, selection));
 	});
 
 	const snippet = texts.join(endOfLineCharacter(document));
 
+	if (markdownCodeBlock) {
+		const config = workspace.getConfiguration('snippet-copy');
+
+		return wrapTextInMarkdownCodeBlock(document, snippet, config.addLanguageId);
+	}
+
 	return snippet;
 }
 
@@ -26,3 +32,13 @@ export function generateCopyableText(document: TextDocument, selection: Selectio
 
 	return text;
 }
+
+export function wrapTextInMarkdownCodeBlock(document: TextDocument, text: string, addLanguageId = false): string {
+	const codeBlockDelimiter = '```';
+	const eolCharacter = endOfLineCharacter(document);
+	const optionalLanguageIdentifier = addLanguageId ? languageId(document) : '';
+
+	return 	codeBlockDelimiter + optionalLanguageIdentifier + eolCharacter +
+					text + eolCharacter +
+					codeBlockDelimiter;
+}

src/test/suite/lib/textHelpers.test.ts

@@ -2,7 +2,7 @@ import * as assert from 'assert';
 import * as path from 'path';
 import * as vscode from 'vscode';
 import { Position, Selection, TextDocument } from 'vscode';
-import { generateCopyableText, generateSnippet } from '../../../lib/textHelpers';
+import { generateCopyableText, generateSnippet, wrapTextInMarkdownCodeBlock } from '../../../lib/textHelpers';
 
 const fixturesPath = '/../../../../src/test/fixtures/';
 const uri = vscode.Uri.file(
@@ -60,5 +60,17 @@ describe('Text Helpers', () => {
 				generateCopyableText(document, new Selection(testSelection1.selection.start, new Position(5, 0)))
 			);
 		});
+
+		context('wrapTextInMarkdownCodeBlock', () => {
+			it('returns the text wrapped in a Markdown code block', () => {
+				const codeSnippet = 'console.log("Yo");';
+				assert.equal(wrapTextInMarkdownCodeBlock(document, codeSnippet), '```\n' + codeSnippet + '\n```');
+			});
+
+			it('returns the wrapped text with a language identifier', () => {
+				const codeSnippet = 'console.log("Yo");';
+				assert.equal(wrapTextInMarkdownCodeBlock(document, codeSnippet, true), '```javascript\n' + codeSnippet + '\n```');
+			});
+		});
 	});
 });