Better remote heuristic + make remote configurable

Fixes #9

Author: Stephen Gutekanst

README.md

@@ -1,6 +1,6 @@
 # Sourcegraph for JetBrains IDEs [![JetBrains Plugin](https://img.shields.io/badge/JetBrains-Sourcegraph-green.svg)](https://plugins.jetbrains.com/plugin/9682-sourcegraph)
 
-The Sourcegraph plugin for JetBrains IDEs enables you to quickly open and search code on Sourcegraph.com easily and efficiently in JetBrains IDEs such as IntelliJ. This plugin works with most JetBrains IDEs:
+The Sourcegraph plugin for JetBrains IDEs enables you to quickly open and search code on Sourcegraph easily and efficiently in JetBrains IDEs such as IntelliJ. This plugin works with most JetBrains IDEs:
 
 - IntelliJ IDEA
 - IntelliJ IDEA Community Edition
@@ -11,7 +11,7 @@ The Sourcegraph plugin for JetBrains IDEs enables you to quickly open and search
 - RubyMine
 - AppCode
 - CLion
-- Gogland
+- GoLand
 - DataGrip
 - Rider
 - Android Studio
@@ -45,6 +45,7 @@ The plugin is configurable by creating a `sourcegraph-jetbrains.properties` in y
 url = https://sourcegraph.com
 ```
 
+By default, the plugin will use the `origin` git remote to determine which repository on Sourcegraph corresponds to the local repository. You may configure this by adding a `sourcegraph` remote which will take priority.
 
 ## Questions & Feedback
 
@@ -73,7 +74,19 @@ Please file an issue: https://github.com/sourcegraph/sourcegraph-jetbrains/issue
 
 ## Version History
 
-- v1.1.2 - Fixed an error that occurred when trying to search with no selection.
-- v1.1.1 - Fixed search shortcut; Updated the search URL to reflect a recent Sourcegraph.com change.
-- v1.1.0 - Added support for using the plugin with on-premises Sourcegraph instances.
-- v1.0.0 - Initial Release; basic Open File & Search functionality.
+#### v1.1.2
+
+- Fixed an error that occurred when trying to search with no selection.
+- The git remote used for repository detection is now `sourcegraph` and then `origin`, instead of the previously poor choice of just the first git remote.
+
+#### v1.1.1
+
+- Fixed search shortcut; Updated the search URL to reflect a recent Sourcegraph.com change.
+
+#### v1.1.0
+
+- Added support for using the plugin with on-premises Sourcegraph instances.
+
+#### v1.0.0
+
+- Initial Release; basic Open File & Search functionality.

resources/META-INF/plugin.xml

@@ -5,7 +5,7 @@
  <vendor email="hi@sourcegraph.com" url="https://sourcegraph.com">Sourcegraph</vendor>
 
  <description><![CDATA[
- Sourcegraph for JetBrains IDEs (IntelliJ, PyCharm, Goglang, etc.)<br>
+ Sourcegraph for JetBrains IDEs (IntelliJ, PyCharm, GoLand, etc.)<br>
  ]]></description>
 
  <change-notes><![CDATA[
@@ -14,6 +14,9 @@
  <ul>
  <li>Fixed an error that occurred when trying to search with no selection.</li>
  </ul>
+ <ul>
+ <li>The git remote used for repository detection is now `sourcegraph` and then `origin`, instead of the previously poor choice of just the first git remote.</li>
+ </ul>
  </li>
  <li>v1.1.1 - Fixed search shortcut.
  <ul>

src/Util.java

@@ -4,30 +4,31 @@
 import java.util.Properties;
 
 public class Util {
- public static String VERSION = "v1.1.1";
-
- // gitRemotes returns the names of all git remotes, e.g. ["origin", "foobar"]
- public static String[] gitRemotes(String repoDir) throws IOException {
- return exec("git remote", repoDir).split("[\\r\\n]+");
- }
+ public static String VERSION = "v1.1.2";
 
  // gitRemoteURL returns the remote URL for the given remote name.
  // e.g. "origin" -> "git@github.com:foo/bar"
- public static String gitRemoteURL(String repoDir, String remoteName) throws IOException {
- return exec("git remote get-url " + remoteName, repoDir).trim();
+ public static String gitRemoteURL(String repoDir, String remoteName) throws Exception {
+ String s = exec("git remote get-url " + remoteName, repoDir).trim();
+ if (s.isEmpty()) {
+ throw new Exception("no such remote");
+ }
+ return s;
  }
 
- // gitDefaultRemoteURL returns the remote URL of the first Git remote
- // found. An exception is thrown if there is not one.
- public static String gitDefaultRemoteURL(String repoDir) throws Exception {
- String[] remotes = gitRemotes(repoDir);
- if (remotes.length == 0) {
- throw new Exception("no configured git remotes");
- }
- if (remotes.length > 1) {
- Logger.getInstance(Util.class).info("using first git remote: " + remotes[0]);
+ // configuredGitRemoteURL returns the URL of the "sourcegraph" remote, if
+ // configured, or else the URL of the "origin" remote. An exception is
+ // thrown if neither exists.
+ public static String configuredGitRemoteURL(String repoDir) throws Exception {
+ try {
+ return gitRemoteURL(repoDir, "sourcegraph");
+ } catch (Exception err) {
+ try {
+ return gitRemoteURL(repoDir, "origin");
+ } catch (Exception err2) {
+ throw new Exception("no configured git remote \"sourcegraph\" or \"origin\"");
+ }
  }
- return gitRemoteURL(repoDir, remotes[0]);
  }
 
  // gitRootDir returns the repository root directory for any directory
@@ -88,7 +89,7 @@ public static RepoInfo repoInfo(String fileName) {
 
  // Determine file path, relative to repository root.
  fileRel = fileName.substring(repoRoot.length()+1);
- remoteURL = gitDefaultRemoteURL(repoRoot);
+ remoteURL = configuredGitRemoteURL(repoRoot);
  branch = gitBranch(repoRoot);
  } catch (Exception err) {
  Logger.getInstance(Util.class).info(err);