Make plugin hot-reloadable

leinardi · Feb 26, 2022 · 2aafc0a · 2aafc0a
1 parent 62c06bb
commit 2aafc0a
Show file tree

Hide file tree

Showing 26 changed files with 49 additions and 69 deletions.
diff --git a/build.gradle b/build.gradle
@@ -79,12 +79,20 @@ intellij {
 
 runIde {
     systemProperties.put("idea.log.debug.categories", "#com.leinardi.pycharm.mypy")
+    // Log verbose information when dynamic plugin unloading fails
+    systemProperties.put("ide.plugins.snapshot.on.unload.fail", "true")
 }
 
+// Causes error popup when building while sandbox IDE is open. Disable in development
+if (System.getenv('DEVELOP')) {
+    buildSearchableOptions.enabled = false
+}
+
+
 patchPluginXml {
     version = project.property('version')
     sinceBuild = project.property('sinceBuild')
-    untilBuild  = project.property('untilBuild')
+    untilBuild = project.property('untilBuild')
     pluginDescription = props.getProperty('plugin.Pylint-PyCharm.description')
     changeNotes = getChangelogHtml()
 }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/PylintAnnotator.java b/src/main/java/com/leinardi/pycharm/pylint/PylintAnnotator.java
@@ -66,7 +66,7 @@ public class PylintAnnotator extends ExternalAnnotator<PylintAnnotator.State, Py
     private static final String ERROR_MESSAGE_ID_SYNTAX_ERROR = "E0001";
 
     private PylintPlugin plugin(final Project project) {
-        final PylintPlugin pylintPlugin = project.getComponent(PylintPlugin.class);
+        final PylintPlugin pylintPlugin = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/PylintPlugin.java b/src/main/java/com/leinardi/pycharm/pylint/PylintPlugin.java
@@ -16,7 +16,7 @@
 
 package com.leinardi.pycharm.pylint;
 
-import com.intellij.openapi.components.ProjectComponent;
+import com.intellij.openapi.components.Service;
 import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.vfs.VirtualFile;
@@ -43,12 +43,8 @@
 /**
  * Main class for the Pylint scanning plug-in.
  */
-public final class PylintPlugin implements ProjectComponent {
-
-    /**
-     * The plugin ID. Caution: It must be identical to the String set in build.gradle at intellij.pluginName
-     */
-    public static final String ID_PLUGIN = "Pylint-PyCharm";
+@Service
+public final class PylintPlugin {
 
     private static final Logger LOG = com.intellij.openapi.diagnostic.Logger.getInstance(PylintPlugin.class);
 
@@ -94,22 +90,6 @@ public boolean isScanInProgress() {
         }
     }
 
-    @Override
-    public void projectOpened() {
-        LOG.debug("Project opened.");
-    }
-
-    @Override
-    public void projectClosed() {
-        LOG.debug("Project closed.");
-    }
-
-    @Override
-    @NotNull
-    public String getComponentName() {
-        return ID_PLUGIN;
-    }
-
     public static void processErrorAndLog(@NotNull final String action, @NotNull final Throwable e) {
         LOG.warn(action + " failed", e);
     }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/BaseAction.java b/src/main/java/com/leinardi/pycharm/pylint/actions/BaseAction.java
@@ -59,7 +59,7 @@ public void update(final AnActionEvent event) {
                 return;
             }
 
-            final PylintPlugin pylintPlugin = project.getComponent(PylintPlugin.class);
+            final PylintPlugin pylintPlugin = project.getService(PylintPlugin.class);
             if (pylintPlugin == null) {
                 throw new IllegalStateException("Couldn't get pylint plugin");
             }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/ClearAll.java b/src/main/java/com/leinardi/pycharm/pylint/actions/ClearAll.java
@@ -38,7 +38,7 @@ public void actionPerformed(final AnActionEvent event) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/Close.java b/src/main/java/com/leinardi/pycharm/pylint/actions/Close.java
@@ -37,7 +37,7 @@ public void actionPerformed(final AnActionEvent event) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/CollapseAll.java b/src/main/java/com/leinardi/pycharm/pylint/actions/CollapseAll.java
@@ -38,7 +38,7 @@ public void actionPerformed(final AnActionEvent event) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/DisplayConvention.java b/src/main/java/com/leinardi/pycharm/pylint/actions/DisplayConvention.java
@@ -39,7 +39,7 @@ public boolean isSelected(final AnActionEvent event) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }
@@ -63,7 +63,7 @@ public void setSelected(final AnActionEvent event, final boolean selected) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/DisplayErrors.java b/src/main/java/com/leinardi/pycharm/pylint/actions/DisplayErrors.java
@@ -39,7 +39,7 @@ public boolean isSelected(final AnActionEvent event) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }
@@ -63,7 +63,7 @@ public void setSelected(final AnActionEvent event, final boolean selected) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/DisplayInfo.java b/src/main/java/com/leinardi/pycharm/pylint/actions/DisplayInfo.java
@@ -39,7 +39,7 @@ public boolean isSelected(final AnActionEvent event) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }
@@ -63,7 +63,7 @@ public void setSelected(final AnActionEvent event, final boolean selected) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/DisplayRefactor.java b/src/main/java/com/leinardi/pycharm/pylint/actions/DisplayRefactor.java
@@ -39,7 +39,7 @@ public boolean isSelected(final AnActionEvent event) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }
@@ -63,7 +63,7 @@ public void setSelected(final AnActionEvent event, final boolean selected) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/DisplayWarnings.java b/src/main/java/com/leinardi/pycharm/pylint/actions/DisplayWarnings.java
@@ -39,7 +39,7 @@ public boolean isSelected(final AnActionEvent event) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }
@@ -63,7 +63,7 @@ public void setSelected(final AnActionEvent event, final boolean selected) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/ExpandAll.java b/src/main/java/com/leinardi/pycharm/pylint/actions/ExpandAll.java
@@ -38,7 +38,7 @@ public void actionPerformed(final AnActionEvent event) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/ScanCurrentChangeList.java b/src/main/java/com/leinardi/pycharm/pylint/actions/ScanCurrentChangeList.java
@@ -51,7 +51,7 @@ public final void actionPerformed(final AnActionEvent event) {
             }
 
             final ChangeListManager changeListManager = ChangeListManager.getInstance(project);
-            project.getComponent(PylintPlugin.class)
+            project.getService(PylintPlugin.class)
                     .asyncScanFiles(VfUtil.filterOnlyPythonProjectFiles(project,
                             filesFor(changeListManager.getDefaultChangeList())));
         } catch (Throwable e) {
@@ -85,7 +85,7 @@ public void update(final AnActionEvent event) {
                 return;
             }
 
-            final PylintPlugin pylintPlugin = project.getComponent(PylintPlugin.class);
+            final PylintPlugin pylintPlugin = project.getService(PylintPlugin.class);
             if (pylintPlugin == null) {
                 throw new IllegalStateException("Couldn't get pylint plugin");
             }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/ScanCurrentFile.java b/src/main/java/com/leinardi/pycharm/pylint/actions/ScanCurrentFile.java
@@ -46,7 +46,7 @@ public void actionPerformed(final AnActionEvent event) {
 
         try {
             final PylintPlugin pylintPlugin
-                    = project.getComponent(PylintPlugin.class);
+                    = project.getService(PylintPlugin.class);
             if (pylintPlugin == null) {
                 throw new IllegalStateException("Couldn't get pylint plugin");
             }
@@ -59,7 +59,7 @@ public void actionPerformed(final AnActionEvent event) {
 
                     final VirtualFile selectedFile = getSelectedFile(project);
                     if (selectedFile != null) {
-                        project.getComponent(PylintPlugin.class).asyncScanFiles(
+                        project.getService(PylintPlugin.class).asyncScanFiles(
                                 Collections.singletonList(selectedFile));
                     }
 
@@ -111,7 +111,7 @@ public void update(final AnActionEvent event) {
             }
 
             final PylintPlugin pylintPlugin
-                    = project.getComponent(PylintPlugin.class);
+                    = project.getService(PylintPlugin.class);
             if (pylintPlugin == null) {
                 throw new IllegalStateException("Couldn't get pylint plugin");
             }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/ScanEverythingAction.java b/src/main/java/com/leinardi/pycharm/pylint/actions/ScanEverythingAction.java
@@ -39,6 +39,6 @@ public void run() {
         filesToScan = VfUtil.flattenFiles(new VirtualFile[]{project.getBaseDir()});
         filesToScan = VfUtil.filterOnlyPythonProjectFiles(project, filesToScan);
 
-        project.getComponent(PylintPlugin.class).asyncScanFiles(filesToScan);
+        project.getService(PylintPlugin.class).asyncScanFiles(filesToScan);
     }
 }
diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/ScanModifiedFiles.java b/src/main/java/com/leinardi/pycharm/pylint/actions/ScanModifiedFiles.java
@@ -47,7 +47,7 @@ public final void actionPerformed(final AnActionEvent event) {
             }
 
             final ChangeListManager changeListManager = ChangeListManager.getInstance(project);
-            project.getComponent(PylintPlugin.class).asyncScanFiles(
+            project.getService(PylintPlugin.class).asyncScanFiles(
                     VfUtil.filterOnlyPythonProjectFiles(project, changeListManager.getAffectedFiles())
             );
         } catch (Throwable e) {
@@ -66,7 +66,7 @@ public void update(final AnActionEvent event) {
                 return;
             }
 
-            final PylintPlugin pylintPlugin = project.getComponent(PylintPlugin.class);
+            final PylintPlugin pylintPlugin = project.getService(PylintPlugin.class);
             if (pylintPlugin == null) {
                 throw new IllegalStateException("Couldn't get pylint plugin");
             }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/ScanModule.java b/src/main/java/com/leinardi/pycharm/pylint/actions/ScanModule.java
@@ -58,7 +58,7 @@ public final void actionPerformed(final AnActionEvent event) {
             }
 
             final PylintPlugin pylintPlugin
-                    = project.getComponent(PylintPlugin.class);
+                    = project.getService(PylintPlugin.class);
             if (pylintPlugin == null) {
                 throw new IllegalStateException("Couldn't get pylint plugin");
             }
@@ -107,7 +107,7 @@ public final void update(final AnActionEvent event) {
             }
 
             final PylintPlugin pylintPlugin
-                    = project.getComponent(PylintPlugin.class);
+                    = project.getService(PylintPlugin.class);
             if (pylintPlugin == null) {
                 throw new IllegalStateException("Couldn't get pylint plugin");
             }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/ScanProject.java b/src/main/java/com/leinardi/pycharm/pylint/actions/ScanProject.java
@@ -40,7 +40,7 @@ public void actionPerformed(final AnActionEvent event) {
                 return;
             }
 
-            final PylintPlugin pylintPlugin = project.getComponent(PylintPlugin.class);
+            final PylintPlugin pylintPlugin = project.getService(PylintPlugin.class);
             if (pylintPlugin == null) {
                 throw new IllegalStateException("Couldn't get pylint plugin");
             }
@@ -89,7 +89,7 @@ public void update(final AnActionEvent event) {
                 return;
             }
 
-            final PylintPlugin pylintPlugin = project.getComponent(PylintPlugin.class);
+            final PylintPlugin pylintPlugin = project.getService(PylintPlugin.class);
             if (pylintPlugin == null) {
                 throw new IllegalStateException("Couldn't get pylint plugin");
             }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/ScanSourceRootsAction.java b/src/main/java/com/leinardi/pycharm/pylint/actions/ScanSourceRootsAction.java
@@ -34,7 +34,7 @@ class ScanSourceRootsAction implements Runnable {
 
     @Override
     public void run() {
-        project.getComponent(PylintPlugin.class)
+        project.getService(PylintPlugin.class)
                 .asyncScanFiles(VfUtil.filterOnlyPythonProjectFiles(project,
                         VfUtil.flattenFiles(sourceRoots)));
     }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/ScrollToSource.java b/src/main/java/com/leinardi/pycharm/pylint/actions/ScrollToSource.java
@@ -39,7 +39,7 @@ public boolean isSelected(final AnActionEvent event) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }
@@ -63,7 +63,7 @@ public void setSelected(final AnActionEvent event, final boolean selected) {
         }
 
         final PylintPlugin pylintPlugin
-                = project.getComponent(PylintPlugin.class);
+                = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/Settings.java b/src/main/java/com/leinardi/pycharm/pylint/actions/Settings.java
@@ -35,7 +35,7 @@ public void actionPerformed(final AnActionEvent event) {
             return;
         }
 
-        final PylintPlugin pylintPlugin = project.getComponent(PylintPlugin.class);
+        final PylintPlugin pylintPlugin = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/actions/StopCheck.java b/src/main/java/com/leinardi/pycharm/pylint/actions/StopCheck.java
@@ -39,7 +39,7 @@ public void actionPerformed(final AnActionEvent event) {
 
         try {
             final PylintPlugin pylintPlugin
-                    = project.getComponent(PylintPlugin.class);
+                    = project.getService(PylintPlugin.class);
             if (pylintPlugin == null) {
                 throw new IllegalStateException("Couldn't get pylint plugin");
             }
@@ -70,7 +70,7 @@ public void update(final AnActionEvent event) {
             }
 
             final PylintPlugin pylintPlugin
-                    = project.getComponent(PylintPlugin.class);
+                    = project.getService(PylintPlugin.class);
             if (pylintPlugin == null) {
                 throw new IllegalStateException("Couldn't get pylint plugin");
             }

diff --git a/src/main/java/com/leinardi/pycharm/pylint/handlers/ScanFilesBeforeCheckinHandler.java b/src/main/java/com/leinardi/pycharm/pylint/handlers/ScanFilesBeforeCheckinHandler.java
@@ -101,7 +101,7 @@ public ReturnResult beforeCheckin(@Nullable final CommitExecutor executor,
             return COMMIT;
         }
 
-        final PylintPlugin plugin = project.getComponent(PylintPlugin.class);
+        final PylintPlugin plugin = project.getService(PylintPlugin.class);
         if (plugin == null) {
             LOG.warn("Could not get Pylint Plug-in, skipping");
             return COMMIT;

diff --git a/src/main/java/com/leinardi/pycharm/pylint/toolwindow/PylintToolWindowPanel.java b/src/main/java/com/leinardi/pycharm/pylint/toolwindow/PylintToolWindowPanel.java
@@ -132,7 +132,7 @@ public PylintToolWindowPanel(final ToolWindow toolWindow, final Project project)
         this.toolWindow = toolWindow;
         this.project = project;
 
-        pylintPlugin = project.getComponent(PylintPlugin.class);
+        pylintPlugin = project.getService(PylintPlugin.class);
         if (pylintPlugin == null) {
             throw new IllegalStateException("Couldn't get pylint plugin");
         }