Merge pull request #9 from lumaxis/feature/markdown-blocks

New: Add support for copying snippets as Markdown code blocks

Author: lumaxis

CHANGELOG.md

@@ -4,7 +4,9 @@
 
 ### Features
 
--  Add support for copying snippets from multiple selections
+- Add additional command to copy snippet with surrounding Markdown code block syntax
+- Add configuration option to add language identifier to Markdown code blocks
+- Add support for copying snippets from multiple selections
 
 ### Chores
 

README.md

@@ -1,18 +1,30 @@
 # Snippet Copy
 
 Ever wanted to copy part of a source file as a snippet and paste it somewhere else, like in Slack or in a GitHub comment?
-Previously, you either got a bunch of unnecessary indentation that made the snippet ugly to read or you had to manually un-tab the snippet, copy, and then reset the indentation.
 
+Previously, you either got a bunch of unnecessary indentation that made the snippet ugly to read or you had to manually un-tab the snippet, copy, and then reset the indentation.
 With **Snippet Copy** you can automatically get a snippet added to your clipboard with all the unnecessary indentation already removed!
 
 ## Features
 
-You can use the extension via a bunch of different ways:
+All features can be used via different ways in VS Code
 
-- Via the Command Palette and the pre-configured keyboard shortcut
+- ⌨️ The **Command Palette** and the pre-configured **Keyboard Shortcuts**
 
 	![Command in Command Palette](images/command-palette.png)
 
-- Via the Context Menu on selected text in the editor
+- 📝 The **Context Menu** on selected text in the editor
 
 	![Command in Context Menu](images/context-menu.png)
+
+### Copy Snippet Without Leading Indentation
+
+Simply get a copy of your currently selected code or text snippet added to your clipboard – without any unnecessary indentation that you would otherwise need to remove manually.
+
+### Copy Snippet Without Leading Indentation as Markdown Code Block
+
+This command has an additional configuration option that let's you determine if the Markdown code block should contain the file's language identifier which enables [syntax highlighting](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) in some places:
+
+```json
+"snippet-copy.addLanguageIdToMarkdownBlock": false // Default is false
+```

package.json

@@ -19,31 +19,58 @@
 		"vscode": "^1.44.0"
 	},
 	"activationEvents": [
-		"onCommand:snippet-copy.copyWithoutLeadingIndentation"
+		"onCommand:snippet-copy.copySnippet",
+		"onCommand:snippet-copy.copySnippetAsMarkdownCodeBlock"
 	],
 	"main": "./out/extension.js",
 	"contributes": {
 		"commands": [
 			{
-				"command": "snippet-copy.copyWithoutLeadingIndentation",
-				"title": "Copy Without Leading Indentation"
+				"command": "snippet-copy.copySnippet",
+				"title": "Copy Snippet Without Leading Indentation"
+			},
+			{
+				"command": "snippet-copy.copySnippetAsMarkdownCodeBlock",
+				"title": "Copy Snippet Without Leading Indentation as Markdown Code Block"
 			}
 		],
+		"configuration": {
+			"title": "Snippet Copy",
+			"properties": {
+				"snippet-copy.addLanguageIdentifierToMarkdownBlock": {
+					"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",
+				"command": "snippet-copy.copySnippet",
 				"mac": "Cmd+Ctrl+c",
 				"linux": "Meta+Ctrl+c",
 				"win": "Win+Ctrl+c",
 				"when": "editorHasSelection"
+			},
+			{
+				"command": "snippet-copy.copySnippetAsMarkdownCodeBlock",
+				"mac": "Cmd+Ctrl+Shift+c",
+				"linux": "Meta+Ctrl+Shift+c",
+				"win": "Win+Ctrl+Shift+c",
+				"when": "editorHasSelection"
 			}
 		],
 		"menus": {
 			"editor/context": [
 				{
-					"command": "snippet-copy.copyWithoutLeadingIndentation",
+					"command": "snippet-copy.copySnippet",
 					"when": "editorHasSelection",
 					"group": "9_cutcopypaste@2"
+				},
+				{
+					"command": "snippet-copy.copySnippetAsMarkdownCodeBlock",
+					"when": "editorHasSelection",
+					"group": "9_cutcopypaste@3"
 				}
 			]
 		}

src/extension.ts

@@ -1,15 +1,21 @@
-import * as vscode from 'vscode';
-import { ExtensionContext } from 'vscode';
+import { commands, env, ExtensionContext } from 'vscode';
 import { generateSnippet } from './lib/textHelpers';
 
 export function activate(context: ExtensionContext) {
-	let disposable = vscode.commands.registerTextEditorCommand('snippet-copy.copyWithoutLeadingIndentation', async (editor) => {
-		const snippet = generateSnippet(editor.document, editor.selections);
+	context.subscriptions.push(
+		commands.registerTextEditorCommand('snippet-copy.copySnippet', async (editor) => {
+			const snippet = generateSnippet(editor.document, editor.selections, false);
 
-		await vscode.env.clipboard.writeText(snippet);
-	});
+			await env.clipboard.writeText(snippet);
+		})
+	);
+	context.subscriptions.push(
+		commands.registerTextEditorCommand('snippet-copy.copySnippetAsMarkdownCodeBlock', async (editor) => {
+			const snippet = generateSnippet(editor.document, editor.selections, true);
 
-	context.subscriptions.push(disposable);
+			await env.clipboard.writeText(snippet);
+		})
+	);
 }
 
 export function deactivate() { }

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.addLanguageIdentifierToMarkdownBlock);
+	}
+
 	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```');
+			});
+		});
 	});
 });