Merge pull request #32 from lumaxis/feature/improve-empty-lines-handling

Improve handling of empty or whitespace-only lines

Author: lumaxis

.eslintrc.json

@@ -15,6 +15,7 @@
 		"semi": "off",
 		"indent": ["error", "tab"]
 	},
+	"ignorePatterns": ["**/fixtures/**"],
 	"overrides": [
 		{
 			"files": ["**/*.ts"],

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [Unreleased]
+
+### Fixes
+
+- Ignore empty or whitespace-only lines when calculating minimum indentation of the snippet (#17)
+
 ## [0.2.0]
 
 ### Features

src/lib/documentHelpers.ts

@@ -7,9 +7,18 @@ export function linesForIndexes(document: TextDocument, lineIndexes: number[]):
 }
 
 export function minimumIndentationForLineIndexes(document: TextDocument, lineIndexes: number[]): number {
-	const indentationLevels = lineIndexes.map((lineIndex) => {
-		return document.lineAt(lineIndex).firstNonWhitespaceCharacterIndex;
-	});
+	const indentationLevels = lineIndexes.reduce<number[]>((indentationLevels, lineIndex) => {
+		const line = document.lineAt(lineIndex);
+
+		// Skip empty lines so they don't skew the calculation results
+		if (line.isEmptyOrWhitespace) {
+			return indentationLevels;
+		}
+
+		indentationLevels.push(line.firstNonWhitespaceCharacterIndex);
+
+		return indentationLevels;
+	}, []);
 
 	const minimumIndentationLevelInSelection = Math.min(...indentationLevels);
 	return minimumIndentationLevelInSelection;

src/test/fixtures/.editorconfig

@@ -0,0 +1 @@
+root = true

src/test/fixtures/javascript-example.js

@@ -8,4 +8,9 @@ class MyThing {
   doSomethingElse() {
     throw new Error('Nope!');
   }
+
+    emptyFunction() {
+
+  
+    }
 }

src/test/suite/lib/documentHelpers.test.ts

@@ -36,6 +36,10 @@ describe('Document Helpers', function () {
 		it('calculates the correct minimum indentation level for multiple lines', () => {
 			assert.equal(minimumIndentationForLineIndexes(document, [1, 2, 3]), 2);
 		});
+
+		it('calculates the correct minimum indentation level when lines contain an empty line', () => {
+			assert.equal(minimumIndentationForLineIndexes(document, [11, 12, 13, 14]), 4);
+		});
 	});
 
 	context('contentOfLinesWithAdjustedIndentation', async () => {

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

@@ -23,6 +23,10 @@ describe('Text Helpers', () => {
 		content: 'doSomethingElse() {\n  throw new Error(\'Nope!\');\n}',
 		selection: new Selection(7, 2, 9, 3)
 	};
+	const testSelection3: TestSelection = {
+		content: '}\n\ndoSomethingElse() {',
+		selection: new Selection(5, 0, 7, 21)
+	};
 	let document: TextDocument;
 
 	before(async () => {
@@ -61,6 +65,12 @@ describe('Text Helpers', () => {
 			);
 		});
 
+		it('generates the correct text when selection contains empty line', () => {
+			assert.deepEqual(testSelection3.content,
+				generateCopyableText(document, testSelection3.selection)
+			);
+		});
+
 		context('wrapTextInMarkdownCodeBlock', () => {
 			it('returns the text wrapped in a Markdown code block', () => {
 				const codeSnippet = 'console.log("Yo");';