Add option to not include line numbers except when there's a selection (#57)

* Add requireSelectionForLines functionality

* Mention in README that line range will be included if there's a selection

* Mention requireSelectionForLines in README

* annotate markdown block as JS, so that we can place useful comments

Author: suan

README.md

@@ -47,6 +47,8 @@ Press <kbd>F1</kbd> and type `Copy GitHub link to clipboard`.
 
 ![copy](screenshots/copy.png?raw=true "Copy function")
 
+(The URL for Github will also include line ranges if there are lines selected in the editor)
+
 Press <kbd>F1</kbd> and type `Open Pull Request`.
 
 ![copy](screenshots/pull-req-cmd.png?raw=true "Copy function")
@@ -66,9 +68,10 @@ Right click on explorer item and choose `Open in GitHub` or `Copy GitHub link to
 
 Add following line into workspace settings;
 
-```json
+```js
 {
-  "openInGitHub.gitHubDomain":"your custom github domain here"
+  "openInGitHub.gitHubDomain":"your custom github domain here",
+  "openInGitHub.requireSelectionForLines":false   // If enabled, the copied or opened URL won't include line number(s) unless there's an active selection
 }
 ```
 

package.json

@@ -55,6 +55,11 @@
           ],
           "default": "github.com",
           "description": "Configure a custom Github domain. Useful for Github entreprise"
+        },
+        "openInGitHub.requireSelectionForLines": {
+          "type": "boolean",
+          "default": false,
+          "description": "If enabled, the copied or opened URL won't include line number(s) unless there's an active selection"
         }
       }
     },

src/extension.js

@@ -16,6 +16,7 @@ var gitRev = require('git-rev-2');
 var findParentDir = require('find-parent-dir');
 
 const gitProvider = require('./gitProvider');
+const requireSelectionForLines = workspace.getConfiguration('openInGitHub').get('requireSelectionForLines');
 
 function getGitProviderLink(cb, fileFsPath, lines, pr) {
     var cwd = workspace.rootPath;
@@ -48,14 +49,18 @@ function getGitProviderLink(cb, fileFsPath, lines, pr) {
                 cb(provider.prUrl(branch));
             }
             else {
-                if (lines[0] == lines[1]) {
-                    cb(provider.webUrl(branch, subdir, lines[0]));
+                if (lines) {
+                    if (lines[0] == lines[1]) {
+                        cb(provider.webUrl(branch, subdir, lines[0]));
+                    }
+                    else {
+                        cb(provider.webUrl(branch, subdir, lines[0], lines[1]));
+                    }
                 }
                 else {
-                    cb(provider.webUrl(branch, subdir, lines[0], lines[1]));
+                    cb(provider.webUrl(branch, subdir));
                 }
             }
-
         });
     });
 }
@@ -70,10 +75,20 @@ function getGitProviderLinkForCurrentEditorLines(cb) {
     var editor = Window.activeTextEditor;
     if (editor) {
         var fileFsPath = editor.document.uri.fsPath;
-        getGitProviderLink(cb, fileFsPath, getSelectedLines(editor));
+
+        if (includeLines(editor)) {
+            getGitProviderLink(cb, fileFsPath, getSelectedLines(editor));
+        }
+        else {
+            getGitProviderLinkForFile(fileFsPath, cb);
+        }
     }
 }
 
+function includeLines(editor) {
+    return !requireSelectionForLines || !editor.selection.isEmpty;
+}
+
 function getSelectedLines(editor) {
     var anchorLineIndex = editor.selection.anchor.line + 1;
     var activeLineIndex = editor.selection.active.line + 1;