Merge branch 'master' in main (#41)

* Added IntelliJ project files to gitignore
* Migrated sources to proper packages so that the source becomes more readable
* Optimized class imports
* Replaced log4j dependency with standard platform logging, as recommended here: https://blog.jetbrains.com/platform/2022/02/removing-log4j-from-the-intellij-platform/

Co-authored-by: David Veszelovszki <[email protected]>

Author: madppiper

.gitignore

@@ -7,6 +7,9 @@
 # User local IDEA configuration files
 .idea/
 
+#IntelliJ project
+*.iml
+
 # Build output & caches for IntelliJ plugin development
 build/
 idea-sandbox/

README.md

@@ -46,11 +46,11 @@ You may also choose to configure it _per repository_ using a `.idea/sourcegraph.
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
-    <component name="Config">
-        <option name="url" value="https://sourcegraph.example.com" />
-        <option name="defaultBranch" value="example-branch" />
-        <option name="remoteUrlReplacements" value="git.example.com, git-web.example.com" />
-    </component>
+  <component name="com.sourcegraph.project.SourcegraphConfig">
+    <option name="url" value="https://sourcegraph.example.com"/>
+    <option name="defaultBranch" value="example-branch"/>
+    <option name="remoteUrlReplacements" value="git.example.com, git-web.example.com"/>
+  </component>
 </project>
 ```
 

src/main/java/Copy.java …in/java/com/sourcegraph/action/Copy.javasrc/main/java/Copy.java renamed to src/main/java/com/sourcegraph/action/Copy.java src/main/java/Copy.java renamed to src/main/java/com/sourcegraph/action/Copy.java

@@ -1,3 +1,5 @@
+package com.sourcegraph.action;
+
 import com.intellij.notification.Notification;
 import com.intellij.notification.NotificationType;
 import com.intellij.notification.Notifications;

src/main/java/FileAction.java …a/com/sourcegraph/action/FileAction.javasrc/main/java/FileAction.java renamed to src/main/java/com/sourcegraph/action/FileAction.java src/main/java/FileAction.java renamed to src/main/java/com/sourcegraph/action/FileAction.java

@@ -1,11 +1,17 @@
+package com.sourcegraph.action;
+
 import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.application.ApplicationInfo;
+import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.editor.*;
 import com.intellij.openapi.fileEditor.FileDocumentManager;
 import com.intellij.openapi.fileEditor.FileEditorManager;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.vfs.VirtualFile;
+import com.sourcegraph.project.RepoInfo;
+import com.sourcegraph.util.SourcegraphUtil;
+
 
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
@@ -34,7 +40,7 @@ public void actionPerformed(AnActionEvent e) {
         SelectionModel sel = editor.getSelectionModel();
 
         // Get repo information.
-        RepoInfo repoInfo = Util.repoInfo(currentFile.getPath(), project);
+        RepoInfo repoInfo = SourcegraphUtil.repoInfo(currentFile.getPath(), project);
         if (Objects.equals(repoInfo.remoteURL, "")) {
             return;
         }
@@ -48,12 +54,12 @@ public void actionPerformed(AnActionEvent e) {
         VisualPosition selectionEndPosition = sel.getSelectionEndPosition();
         LogicalPosition start = selectionStartPosition != null ? editor.visualToLogicalPosition(selectionStartPosition) : null;
         LogicalPosition end = selectionEndPosition != null ? editor.visualToLogicalPosition(selectionEndPosition) : null;
-        uri = Util.sourcegraphURL(project)+"-/editor"
+        uri = SourcegraphUtil.sourcegraphURL(project)+"-/editor"
                 + "?remote_url=" + URLEncoder.encode(repoInfo.remoteURL, StandardCharsets.UTF_8)
                 + "&branch=" + URLEncoder.encode(repoInfo.branch, StandardCharsets.UTF_8)
                 + "&file=" + URLEncoder.encode(repoInfo.fileRel, StandardCharsets.UTF_8)
                 + "&editor=" + URLEncoder.encode("JetBrains", StandardCharsets.UTF_8)
-                + "&version=" + URLEncoder.encode(Util.VERSION, StandardCharsets.UTF_8)
+                + "&version=" + URLEncoder.encode(SourcegraphUtil.VERSION, StandardCharsets.UTF_8)
                 + (start != null ? ("&start_row=" + URLEncoder.encode(Integer.toString(start.line), StandardCharsets.UTF_8)
                 + "&start_col=" + URLEncoder.encode(Integer.toString(start.column), StandardCharsets.UTF_8)) : "")
                 + (end != null ? ("&end_row=" + URLEncoder.encode(Integer.toString(end.line), StandardCharsets.UTF_8)

src/main/java/Open.java …in/java/com/sourcegraph/action/Open.javasrc/main/java/Open.java renamed to src/main/java/com/sourcegraph/action/Open.java src/main/java/Open.java renamed to src/main/java/com/sourcegraph/action/Open.java

@@ -1,3 +1,5 @@
+package com.sourcegraph.action;
+
 import com.intellij.openapi.diagnostic.Logger;
 
 import java.awt.*;

src/main/java/OpenRevisionAction.java …urcegraph/action/OpenRevisionAction.javasrc/main/java/OpenRevisionAction.java renamed to src/main/java/com/sourcegraph/action/OpenRevisionAction.java src/main/java/OpenRevisionAction.java renamed to src/main/java/com/sourcegraph/action/OpenRevisionAction.java

@@ -1,3 +1,5 @@
+package com.sourcegraph.action;
+
 import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.application.ApplicationInfo;
@@ -13,41 +15,46 @@
 import java.net.URI;
 import java.util.Optional;
 
-import org.slf4j.LoggerFactory;
-import org.slf4j.Logger;
+import com.sourcegraph.project.CommitViewUriBuilder;
+import com.sourcegraph.project.RepoInfo;
+import com.sourcegraph.project.RevisionContext;
+import com.sourcegraph.util.SourcegraphUtil;
+
 import org.jetbrains.annotations.NotNull;
+import com.intellij.openapi.diagnostic.Logger;
 
 /**
  * Jetbrains IDE action to open a selected revision in Sourcegraph.
  */
 public class OpenRevisionAction extends AnAction implements DumbAware {
-    private final Logger logger = LoggerFactory.getLogger(this.getClass());
+  private final Logger logger = Logger.getInstance(this.getClass());
 
-    private Optional<RevisionContext> getHistoryRevision(AnActionEvent e) {
-        VcsFileRevision revision = e.getDataContext().getData(VcsDataKeys.VCS_FILE_REVISION);
-        Project project = e.getProject();
+  private Optional<RevisionContext> getHistoryRevision(AnActionEvent e) {
+    VcsFileRevision revision = e.getDataContext().getData(VcsDataKeys.VCS_FILE_REVISION);
+    Project project = e.getProject();
 
-        if (project == null) {
-            return Optional.empty();
-        }
-        if (revision == null) {
-            return Optional.empty();
-        }
-
-        String rev = revision.getRevisionNumber().toString();
-        return Optional.of(new RevisionContext(project, rev));
+    if (project == null) {
+      return Optional.empty();
+    }
+    if (revision == null) {
+      return Optional.empty();
     }
 
-    private Optional<RevisionContext> getLogRevision(AnActionEvent e) {
-        VcsLog log = e.getDataContext().getData(VcsLogDataKeys.VCS_LOG);
-        Project project = e.getProject();
+    String rev = revision.getRevisionNumber().toString();
+    return Optional.of(new RevisionContext(project, rev));
+  }
+
+  private Optional<RevisionContext> getLogRevision(AnActionEvent e) {
+    VcsLog log = e.getDataContext().getData(VcsLogDataKeys.VCS_LOG);
+    Project project = e.getProject();
+
+    if (project == null) {
+      return Optional.empty();
+    }
+    if (log == null || log.getSelectedCommits().isEmpty()) {
+      return Optional.empty();
+    }
 
-        if (project == null) {
-            return Optional.empty();
-        }
-        if (log == null || log.getSelectedCommits().isEmpty()) {
-            return Optional.empty();
-        }
 
         String rev = log.getSelectedCommits().get(0).getHash().asString();
         return Optional.of(new RevisionContext(project, rev));
@@ -62,10 +69,10 @@ public void actionPerformed(@NotNull AnActionEvent e) {
         try {
             String productName = ApplicationInfo.getInstance().getVersionName();
             String productVersion = ApplicationInfo.getInstance().getFullVersion();
-            RepoInfo repoInfo = Util.repoInfo(context.getProject().getProjectFilePath(), context.getProject());
+            RepoInfo repoInfo = SourcegraphUtil.repoInfo(context.getProject().getProjectFilePath(), context.getProject());
 
             CommitViewUriBuilder builder = new CommitViewUriBuilder();
-            URI uri = builder.build(Util.sourcegraphURL(context.getProject()), context.getRevisionNumber(), repoInfo, productName, productVersion);
+            URI uri = builder.build(SourcegraphUtil.sourcegraphURL(context.getProject()), context.getRevisionNumber(), repoInfo, productName, productVersion);
 
             // Open the URL in the browser.
             Desktop.getDesktop().browse(uri);

src/main/java/Search.java …/java/com/sourcegraph/action/Search.javasrc/main/java/Search.java renamed to src/main/java/com/sourcegraph/action/Search.java src/main/java/Search.java renamed to src/main/java/com/sourcegraph/action/Search.java

@@ -1,9 +1,10 @@
+package com.sourcegraph.action;
+
 import com.intellij.openapi.actionSystem.AnActionEvent;
-import org.jetbrains.annotations.NotNull;
 
 public class Search extends SearchActionBase {
     @Override
-    public void actionPerformed(@NotNull AnActionEvent e) {
+    public void actionPerformed(AnActionEvent e) {
         super.actionPerformedMode(e, "search");
     }
-}
+}

src/main/java/SearchActionBase.java …sourcegraph/action/SearchActionBase.javasrc/main/java/SearchActionBase.java renamed to src/main/java/com/sourcegraph/action/SearchActionBase.java src/main/java/SearchActionBase.java renamed to src/main/java/com/sourcegraph/action/SearchActionBase.java

@@ -1,3 +1,5 @@
+package com.sourcegraph.action;
+
 import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.editor.Document;
@@ -9,8 +11,10 @@
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.application.ApplicationInfo;
+import com.sourcegraph.project.RepoInfo;
+import com.sourcegraph.util.SourcegraphUtil;
+import org.jetbrains.annotations.Nullable;
 
-import javax.annotation.Nullable;
 import java.io.*;
 import java.awt.Desktop;
 import java.net.URI;
@@ -38,7 +42,7 @@ public void actionPerformedMode(AnActionEvent e, String mode) {
         SelectionModel sel = editor.getSelectionModel();
 
         // Get repo information.
-        RepoInfo repoInfo = Util.repoInfo(currentFile.getPath(), project);
+        RepoInfo repoInfo = SourcegraphUtil.repoInfo(currentFile.getPath(), project);
 
         String q = sel.getSelectedText();
         if (q == null || q.equals("")) {
@@ -50,9 +54,9 @@ public void actionPerformedMode(AnActionEvent e, String mode) {
         String productName = ApplicationInfo.getInstance().getVersionName();
         String productVersion = ApplicationInfo.getInstance().getFullVersion();
 
-        uri = Util.sourcegraphURL(project)+"-/editor"
+        uri = SourcegraphUtil.sourcegraphURL(project)+"-/editor"
                 + "?editor=" + URLEncoder.encode("JetBrains", StandardCharsets.UTF_8)
-                + "&version=" + URLEncoder.encode(Util.VERSION, StandardCharsets.UTF_8)
+                + "&version=" + URLEncoder.encode(SourcegraphUtil.VERSION, StandardCharsets.UTF_8)
                 + "&utm_product_name=" + URLEncoder.encode(productName, StandardCharsets.UTF_8)
                 + "&utm_product_version=" + URLEncoder.encode(productVersion, StandardCharsets.UTF_8)
                 + "&search=" + URLEncoder.encode(q, StandardCharsets.UTF_8);

src/main/java/SearchRepository.java …sourcegraph/action/SearchRepository.javasrc/main/java/SearchRepository.java renamed to src/main/java/com/sourcegraph/action/SearchRepository.java src/main/java/SearchRepository.java renamed to src/main/java/com/sourcegraph/action/SearchRepository.java

@@ -1,9 +1,11 @@
+package com.sourcegraph.action;
+
 import com.intellij.openapi.actionSystem.AnActionEvent;
-import org.jetbrains.annotations.NotNull;
+
 
 public class SearchRepository extends SearchActionBase {
     @Override
-    public void actionPerformed(@NotNull AnActionEvent e) {
+    public void actionPerformed(AnActionEvent e) {
         super.actionPerformedMode(e, "search.repository");
     }
-}
+}

src/main/java/CommitViewUriBuilder.java …egraph/project/CommitViewUriBuilder.javasrc/main/java/CommitViewUriBuilder.java renamed to src/main/java/com/sourcegraph/project/CommitViewUriBuilder.java src/main/java/CommitViewUriBuilder.java renamed to src/main/java/com/sourcegraph/project/CommitViewUriBuilder.java

@@ -1,4 +1,10 @@
+package com.sourcegraph.project;
+
 import com.google.common.base.Strings;
+import com.sourcegraph.project.RepoInfo;
+import com.sourcegraph.util.SourcegraphUtil;
+
+import java.io.UnsupportedEncodingException;
 import java.net.URI;
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
@@ -26,7 +32,7 @@ public URI build(String sourcegraphBase, String revisionNumber, RepoInfo repoInf
               String.format("/%s%s", remote.getHost(), path) +
               String.format("/-/commit/%s", revisionNumber) +
               String.format("?editor=%s", URLEncoder.encode("JetBrains", StandardCharsets.UTF_8)) +
-              String.format("&version=%s", URLEncoder.encode(Util.VERSION, StandardCharsets.UTF_8)) +
+              String.format("&version=%s", URLEncoder.encode(SourcegraphUtil.VERSION, StandardCharsets.UTF_8)) +
               String.format("&utm_product_name=%s", URLEncoder.encode(productName, StandardCharsets.UTF_8)) +
               String.format("&utm_product_version=%s", URLEncoder.encode(productVersion, StandardCharsets.UTF_8));