Made a selection that ends on a new line end at the end of the previous line.

Author: reduckted

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Changes
 
 -   🐛 GitHub links now prevent markdown files from being rendered.
+-   🐛 Selections that end at the start of a new line are adjusted to end at the end of the previous line.
 
 # 2.5.0 (2021-04-11)
 

src/commands/get-link-command.ts

@@ -7,7 +7,7 @@ import { NoRemoteHeadError } from '../no-remote-head-error';
 import { RepositoryFinder } from '../repository-finder';
 import { STRINGS } from '../strings';
 import { LinkType, Repository, RepositoryWithRemote, SelectedRange } from '../types';
-import { hasRemote, toSelectedRange } from '../utilities';
+import { getSelectedRange, hasRemote } from '../utilities';
 
 /**
  * The command to get a URL from a file.
@@ -62,7 +62,7 @@ export class GetLinkCommand {
                 // selection from the active editor, so we'll only include the selection
                 // if the file we are generating the link for is in the active editor.
                 if (resource.toString() === editor?.document.uri.toString()) {
-                    selection = toSelectedRange(editor.selection);
+                    selection = getSelectedRange(editor);
                     log('Line selection: %o', selection);
                 }
             }

src/utilities.ts

@@ -1,4 +1,4 @@
-import { Position, Selection } from 'vscode';
+import { Position, Selection, TextEditor } from 'vscode';
 
 import { Repository, RepositoryWithRemote, SelectedRange } from './types';
 
@@ -96,19 +96,31 @@ function hasMessage(err: unknown): err is { message: string } {
 }
 
 /**
- * Converts a `Selection` to a `SelectedRange`.
+ * Gets the `SelectedRange` from the editor's selection.
  *
- * @param selection The selection to convert.
+ * @param editor The editor to get the selection from.
  * @returns The selected range.
  */
-export function toSelectedRange(selection: Selection): SelectedRange {
+export function getSelectedRange(editor: TextEditor): SelectedRange {
+    let start: Position;
+    let end: Position;
+
+    start = editor.selection.start;
+    end = editor.selection.end;
+
+    // If the selection ends at the start of a new line,
+    // then change it to end at the end of the previous line.
+    if (end.line > start.line && end.character === 0) {
+        end = editor.document.lineAt(end.line - 1).range.end;
+    }
+
     // The line numbers are zero-based in the editor,
     // but we need them to be one-based for URLs.
     return {
-        startLine: selection.start.line + 1,
-        endLine: selection.end.line + 1,
-        startColumn: selection.start.character + 1,
-        endColumn: selection.end.character + 1
+        startLine: start.line + 1,
+        endLine: end.line + 1,
+        startColumn: start.character + 1,
+        endColumn: end.character + 1
     };
 }
 

test/utilities.test.ts

@@ -1,6 +1,8 @@
+import assert = require('assert');
 import { expect } from 'chai';
+import { commands, Position, Selection, TextEditor, window } from 'vscode';
 
-import { hasRemote, normalizeUrl } from '../src/utilities';
+import { getSelectedRange, hasRemote, normalizeUrl, toSelection } from '../src/utilities';
 
 describe('utilities', () => {
     describe('hasRemote', () => {
@@ -50,4 +52,78 @@ describe('utilities', () => {
             expect(normalizeUrl('ssh://example.com/')).to.equal('example.com');
         });
     });
+
+    describe('getSelectedRange', () => {
+        let editor: TextEditor;
+
+        before(async () => {
+            await commands.executeCommand('openEditors.newUntitledFile');
+
+            assert(window.activeTextEditor !== undefined);
+            editor = window.activeTextEditor;
+
+            await editor.edit((b) => {
+                b.insert(
+                    new Position(0, 0),
+                    ['first line', 'second', 'third', 'fourth line', 'fifth'].join('\n')
+                );
+            });
+        });
+
+        after(async () => {
+            await commands.executeCommand('workbench.action.closeActiveEditor');
+        });
+
+        it('should convert to one-based values.', () => {
+            editor.selection = new Selection(new Position(1, 2), new Position(3, 4));
+
+            expect(getSelectedRange(editor)).to.deep.equal({
+                startLine: 2,
+                startColumn: 3,
+                endLine: 4,
+                endColumn: 5
+            });
+        });
+
+        it('should return correct value when selection is single point at the start of the line.', () => {
+            editor.selection = new Selection(new Position(1, 0), new Position(1, 0));
+
+            expect(getSelectedRange(editor)).to.deep.equal({
+                startLine: 2,
+                startColumn: 1,
+                endLine: 2,
+                endColumn: 1
+            });
+        });
+
+        it('should return correct value when selection is a single line.', () => {
+            editor.selection = new Selection(new Position(3, 2), new Position(3, 5));
+
+            expect(getSelectedRange(editor)).to.deep.equal({
+                startLine: 4,
+                startColumn: 3,
+                endLine: 4,
+                endColumn: 6
+            });
+        });
+
+        it('should exclude the last line if selection ends at the start of a new line.', () => {
+            editor.selection = new Selection(new Position(2, 0), new Position(3, 0));
+
+            expect(getSelectedRange(editor)).to.deep.equal({
+                startLine: 3,
+                startColumn: 1,
+                endLine: 3,
+                endColumn: 6
+            });
+        });
+    });
+
+    describe('toSelection', () => {
+        it('should convert to zero-based values.', () => {
+            expect(
+                toSelection({ startLine: 10, startColumn: 20, endLine: 30, endColumn: 40 })
+            ).to.deep.equal(new Selection(new Position(9, 19), new Position(29, 39)));
+        });
+    });
 });