Merge pull request #56 from lumaxis/feature/convert-tabs-to-spaces

New: Allow to convert tabs to spaces when copying a snippet

Author: lumaxis

CHANGELOG.md

@@ -11,6 +11,7 @@
   - Add `markdownCodeBlock.includeLanguageIdentifier` configuration option for Markdown block behavior. **This replaces `snippet-copy.addLanguageIdentifierToMarkdownBlock`**. 
   - Allows to set whether Markdown blocks should always include the [language identifier](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) which allows for syntax highlighting in some tools (for example github.com) but is not compatible with others (for example Slack).  
   - The default is "`prompt`" which makes the extension always prompt when using the "Copy Snippet as Markdown Code Block" command.
+- Add configuration setting to convert tabs to spaces when copying snippet. Additionally allows to configure the tab size for the conversion. 
 
 ## [0.2.3]
 

package.json

@@ -56,6 +56,16 @@
 						"Copy a fenced Markdown code block that includes the language identifier of the current document.  \nThis enables [automatic syntax highlighting](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) on e.g. GitHub or StackOverflow but isn't compatible with some apps, for example Slack.",
 						"Always prompt when copying a snippet as a Markdown code block whether to include the language identifier or not."
 					]
+				},
+				"snippet-copy.convertTabsToSpaces.enabled": {
+					"type": "boolean",
+					"default": "true",
+					"description": "Convert tabs in a snippet to spaces"
+				},
+				"snippet-copy.convertTabsToSpaces.tabSize": {
+					"type": "integer",
+					"default": 2,
+					"description": "How many spaces to replace a tab with"
 				}
 			}
 		},

src/lib/textHelpers.ts

@@ -8,9 +8,10 @@ type MarkdownCodeBlockFlavorQuickPickItems = QuickPickItem & {
 };
 
 export async function generateSnippet(document: TextDocument, selections: Selection[], wrapInMarkdownCodeBlock = false): Promise<string> {
+	const config = workspace.getConfiguration('snippet-copy') as ExtensionConfig;
 	const texts: string[] = [];
 	selections.forEach(selection => {
-		texts.push(generateCopyableText(document, selection));
+		texts.push(generateCopyableText(document, selection, config));
 	});
 
 	const snippet = texts.join(endOfLineCharacter(document));
@@ -22,7 +23,7 @@ export async function generateSnippet(document: TextDocument, selections: Select
 	return snippet;
 }
 
-export function generateCopyableText(document: TextDocument, selection: Selection): string {
+export function generateCopyableText(document: TextDocument, selection: Selection, config: ExtensionConfig): string {
 	const lineIndexes = lineIndexesForSelection(selection);
 
 	// Remove last line's index if there's no selected text on that line
@@ -33,7 +34,11 @@ export function generateCopyableText(document: TextDocument, selection: Selectio
 	const minimumIndentation = minimumIndentationForLineIndexes(document, lineIndexes);
 	const text = contentOfLinesWithAdjustedIndentation(document, lineIndexes, minimumIndentation);
 
-	return text;
+	if (!config.convertTabsToSpaces.enabled) {
+		return text;
+	}
+
+	return replaceLeadingTabsWithSpaces(text, config.convertTabsToSpaces.tabSize);
 }
 
 export function wrapTextInMarkdownCodeBlock(document: TextDocument, text: string, addLanguageId = false): string {
@@ -59,6 +64,12 @@ export async function includeLanguageIdentifier(config: ExtensionConfig): Promis
 	return includeLanguageIdentifier === 'always';
 }
 
+export function replaceLeadingTabsWithSpaces(text: string, tabSize = 2): string {
+	const spaces = ' '.repeat(tabSize);
+
+	return text.replace(/^\t+/gm, (tabs) => tabs.replace(/\t/g, spaces));
+}
+
 export async function promptForMarkdownCodeBlockFlavor(): Promise<MarkdownCodeBlockFlavorQuickPickItems | undefined> {
 	const quickPickItems: MarkdownCodeBlockFlavorQuickPickItems[] = [
 		{

src/test/fixtures/tabs-python-example.py

@@ -0,0 +1,4 @@
+import logging
+
+	def fizzBuzz
+		logging.info("	FizzBuzz")

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

@@ -3,86 +3,107 @@ import * as path from 'path';
 import * as td from 'testdouble';
 import * as vscode from 'vscode';
 import { Position, Selection, TextDocument } from 'vscode';
-import { generateCopyableText, generateSnippet, includeLanguageIdentifier, isMarkdownCodeBlockFlavor, wrapTextInMarkdownCodeBlock } from '../../../lib/textHelpers';
+import { generateCopyableText, generateSnippet, includeLanguageIdentifier, isMarkdownCodeBlockFlavor, replaceLeadingTabsWithSpaces, wrapTextInMarkdownCodeBlock } from '../../../lib/textHelpers';
 import { ExtensionConfig } from '../../../types/config';
 
 const fixturesPath = '/../../../../src/test/fixtures/';
-const uri = vscode.Uri.file(
-	path.join(__dirname + fixturesPath + 'javascript-example.js')
+const uri = (fileName: string) => vscode.Uri.file(
+	path.join(__dirname + fixturesPath + fileName)
 );
 
 interface TestSelection {
 	selection: Selection;
-	content: string;
+	expectedResult: string;
 }
 
 describe('Text Helpers', () => {
-	const testSelection1: TestSelection = {
-		content: 'if (aValue) {\n  console.log(`Doing something with ${aValue}!`);\n}',
+	const javaScriptTestSelection1: TestSelection = {
+		expectedResult: 'if (aValue) {\n  console.log(`Doing something with ${aValue}!`);\n}',
 		selection: new Selection(2, 4, 4, 5)
 	};
-	const testSelection2: TestSelection = {
-		content: 'doSomethingElse() {\n  throw new Error(\'Nope!\');\n}',
+	const javaScriptTestSelection2: TestSelection = {
+		expectedResult: 'doSomethingElse() {\n  throw new Error(\'Nope!\');\n}',
 		selection: new Selection(7, 2, 9, 3)
 	};
-	const testSelection3: TestSelection = {
-		content: '}\n\ndoSomethingElse() {',
+	const javaScriptTestSelection3: TestSelection = {
+		expectedResult: '}\n\ndoSomethingElse() {',
 		selection: new Selection(5, 0, 7, 21)
 	};
-	let document: TextDocument;
+	const pythonTestSelection1: TestSelection = {
+		expectedResult: 'def fizzBuzz\n  logging.info("	FizzBuzz")',
+		selection: new Selection(2, 1, 3, 27)
+	};
+	let document1: TextDocument;
+	let document2: TextDocument;
 
 	before(async () => {
-		document = await vscode.workspace.openTextDocument(uri);
+		document1 = await vscode.workspace.openTextDocument(uri('javascript-example.js'));
+		document2 = await vscode.workspace.openTextDocument(uri('tabs-python-example.py'));
 	});
 
 	context('generateSnippet', () => {
 		it('generates the correct snippet for a single selection', async () => {
-			assert.deepEqual(testSelection1.content, await generateSnippet(document, [testSelection1.selection]));
+			assert.deepEqual(javaScriptTestSelection1.expectedResult, await generateSnippet(document1, [javaScriptTestSelection1.selection]));
 		});
 
 		it('generates the correct snippet for multiple selections', async () => {
-			assert.deepEqual(testSelection1.content + '\n' + testSelection2.content,
-				await generateSnippet(document, [testSelection1.selection, testSelection2.selection])
+			assert.deepEqual(javaScriptTestSelection1.expectedResult + '\n' + javaScriptTestSelection2.expectedResult,
+				await generateSnippet(document1, [javaScriptTestSelection1.selection, javaScriptTestSelection2.selection])
 			);
 		});
 
 		it('generates the correct snippet for multiple selections where one ends on the beginning of a newline', async () => {
-			assert.deepEqual(testSelection1.content + '\n' + testSelection2.content,
-				await generateSnippet(document, [
-					new Selection(testSelection1.selection.start, new Position(5, 0)),
-					testSelection2.selection
+			assert.deepEqual(javaScriptTestSelection1.expectedResult + '\n' + javaScriptTestSelection2.expectedResult,
+				await generateSnippet(document1, [
+					new Selection(javaScriptTestSelection1.selection.start, new Position(5, 0)),
+					javaScriptTestSelection2.selection
 				])
 			);
 		});
 	});
 
 	context('generateCopyableText', () => {
 		it('generates the correct text', () => {
-			assert.deepEqual(testSelection1.content, generateCopyableText(document, testSelection1.selection));
+			const config: unknown = td.object({ convertTabsToSpaces: { enabled: false, tabSize: 2 } });
+
+			assert.deepEqual(generateCopyableText(document1, javaScriptTestSelection1.selection, config as ExtensionConfig),
+				javaScriptTestSelection1.expectedResult);
 		});
 
 		it('generates the correct text when the cursor is on a newline', () => {
-			assert.deepEqual(testSelection1.content,
-				generateCopyableText(document, new Selection(testSelection1.selection.start, new Position(5, 0)))
+			const config: unknown = td.object({ convertTabsToSpaces: { enabled: false, tabSize: 2 } });
+
+			assert.deepEqual(generateCopyableText(document1, new Selection(javaScriptTestSelection1.selection.start, new Position(5, 0)), config as ExtensionConfig),
+				javaScriptTestSelection1.expectedResult
 			);
 		});
 
 		it('generates the correct text when selection contains empty line', () => {
-			assert.deepEqual(testSelection3.content,
-				generateCopyableText(document, testSelection3.selection)
+			const config: unknown = td.object({ convertTabsToSpaces: { enabled: false, tabSize: 2 } });
+
+			assert.deepEqual(generateCopyableText(document1, javaScriptTestSelection3.selection, config as ExtensionConfig),
+				javaScriptTestSelection3.expectedResult
+			);
+		});
+
+		it('generates the correct text when selection contains tabs and replacement is enabled', () => {
+			const config: unknown = td.object({ convertTabsToSpaces: { enabled: true, tabSize: 2 } });
+
+			assert.deepEqual(generateCopyableText(document2, pythonTestSelection1.selection, config as ExtensionConfig),
+				pythonTestSelection1.expectedResult
 			);
 		});
 	});
 
 	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```');
+			assert.equal(wrapTextInMarkdownCodeBlock(document1, 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```');
+			assert.equal(wrapTextInMarkdownCodeBlock(document1, codeSnippet, true), '```javascript\n' + codeSnippet + '\n```');
 		});
 	});
 
@@ -106,6 +127,22 @@ describe('Text Helpers', () => {
 		});
 	});
 
+	context('replaceLeadingTabsWithSpaces', () => {
+		it('returns the correct text with the default tabSize', () => {
+			assert.equal(replaceLeadingTabsWithSpaces('	'), '  ');
+		});
+
+		it('returns the correct text with the custom tabSize', () => {
+			assert.equal(replaceLeadingTabsWithSpaces('	', 3), '   ');
+		});
+
+		it('correctly replaces in a multiline string but does not replace tabs in the middle of the string', () => {
+			assert.equal(replaceLeadingTabsWithSpaces(`	console.log("	Hello")
+		console.log("World")`), `  console.log("	Hello")
+    console.log("World")`);
+		});
+	});
+
 	context('isMarkdownCodeBlockFlavor', () => {
 		it('returns true if value is "never"', () => {
 			assert.equal(isMarkdownCodeBlockFlavor('never'), true);

src/types/config.d.ts

@@ -7,4 +7,8 @@ export type ExtensionConfig = WorkspaceConfiguration & {
 		includeLanguageIdentifier: IncludeLanguageIdentifier | 'prompt'
 	};
 	addLanguageIdentifierToMarkdownBlock?: boolean;
+	convertTabsToSpaces: {
+		enabled: boolean;
+		tabSize: number;
+	}
 };