Stop IdeaVim actions flowing into JB Client

IdeaVim actions are local only - they control local behaviour and should not be visible in the Client Fixes VIM-3283
JetBrains · Feb 23, 2024 · bd19256 · bd19256
1 parent 66ff56a
commit bd19256
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 10 deletions.
diff --git a/src/main/java/com/maddyhome/idea/vim/action/VimPluginToggleAction.kt b/src/main/java/com/maddyhome/idea/vim/action/VimPluginToggleAction.kt
@@ -11,6 +11,7 @@ package com.maddyhome.idea.vim.action
 import com.intellij.openapi.actionSystem.ActionPlaces
 import com.intellij.openapi.actionSystem.ActionUpdateThread
 import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.actionSystem.remoting.ActionRemoteBehaviorSpecification
 import com.intellij.openapi.project.DumbAwareToggleAction
 import com.maddyhome.idea.vim.VimPlugin
 import com.maddyhome.idea.vim.helper.MessageHelper
@@ -19,7 +20,7 @@ import com.maddyhome.idea.vim.helper.MessageHelper
  * This class is used to handle the Vim Plugin enabled/disabled toggle. This is most likely used as a menu option
  * but could also be used as a toolbar item.
  */
-internal class VimPluginToggleAction : DumbAwareToggleAction()/*, LightEditCompatible*/ {
+internal class VimPluginToggleAction : DumbAwareToggleAction(), ActionRemoteBehaviorSpecification.Disabled/*, LightEditCompatible*/ {
   override fun isSelected(event: AnActionEvent): Boolean = VimPlugin.isEnabled()
 
   override fun setSelected(event: AnActionEvent, b: Boolean) {

diff --git a/src/main/java/com/maddyhome/idea/vim/action/VimShortcutKeyAction.kt b/src/main/java/com/maddyhome/idea/vim/action/VimShortcutKeyAction.kt
@@ -15,6 +15,7 @@ import com.intellij.openapi.actionSystem.AnAction
 import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.actionSystem.AnActionWrapper
 import com.intellij.openapi.actionSystem.PlatformDataKeys
+import com.intellij.openapi.actionSystem.remoting.ActionRemoteBehaviorSpecification
 import com.intellij.openapi.application.invokeLater
 import com.intellij.openapi.diagnostic.logger
 import com.intellij.openapi.editor.Editor
@@ -59,7 +60,7 @@ import javax.swing.KeyStroke
  * This class is used in Which-Key plugin, so don't make it internal. Generally, we should provide a proper
  *   way to get ideavim keys for this plugin. See VIM-3085
  */
-public class VimShortcutKeyAction : AnAction(), DumbAware/*, LightEditCompatible*/ {
+public class VimShortcutKeyAction : AnAction(), DumbAware, ActionRemoteBehaviorSpecification.Disabled/*, LightEditCompatible*/ {
   private val traceTime: Boolean
     get() {
       // Make sure the injector is initialized
@@ -390,4 +391,4 @@ private class ActionEnableStatus(
 
 private enum class LogLevel {
   DEBUG, INFO, ERROR,
-}
+}
diff --git a/src/main/java/com/maddyhome/idea/vim/action/internal/AddBlockInlaysAction.kt b/src/main/java/com/maddyhome/idea/vim/action/internal/AddBlockInlaysAction.kt
@@ -13,6 +13,7 @@ import com.intellij.openapi.actionSystem.AnAction
 import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.actionSystem.CommonDataKeys
 import com.intellij.openapi.actionSystem.DataContext
+import com.intellij.openapi.actionSystem.remoting.ActionRemoteBehaviorSpecification
 import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.editor.EditorCustomElementRenderer
 import com.intellij.openapi.editor.Inlay
@@ -32,7 +33,7 @@ import java.util.*
 import javax.swing.UIManager
 import kotlin.math.max
 
-internal class AddBlockInlaysAction : AnAction() {
+internal class AddBlockInlaysAction : AnAction(), ActionRemoteBehaviorSpecification.Disabled {
   override fun actionPerformed(e: AnActionEvent) {
     val dataContext = e.dataContext
     val editor = getEditor(dataContext) ?: return

diff --git a/src/main/java/com/maddyhome/idea/vim/action/internal/AddInlineInlaysAction.kt b/src/main/java/com/maddyhome/idea/vim/action/internal/AddInlineInlaysAction.kt
@@ -13,6 +13,7 @@ import com.intellij.openapi.actionSystem.AnAction
 import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.actionSystem.CommonDataKeys
 import com.intellij.openapi.actionSystem.DataContext
+import com.intellij.openapi.actionSystem.remoting.ActionRemoteBehaviorSpecification
 import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.editor.VisualPosition
 import com.maddyhome.idea.vim.api.lineLength
@@ -22,7 +23,7 @@ import com.maddyhome.idea.vim.newapi.vim
 import java.util.*
 import kotlin.math.max
 
-internal class AddInlineInlaysAction : AnAction() {
+internal class AddInlineInlaysAction : AnAction(), ActionRemoteBehaviorSpecification.Disabled {
   companion object {
     private val random = Random()
   }

diff --git a/src/main/java/com/maddyhome/idea/vim/listener/IdeaSpecifics.kt b/src/main/java/com/maddyhome/idea/vim/listener/IdeaSpecifics.kt
@@ -26,6 +26,7 @@ import com.intellij.openapi.actionSystem.AnActionWrapper
 import com.intellij.openapi.actionSystem.CommonDataKeys
 import com.intellij.openapi.actionSystem.ex.AnActionListener
 import com.intellij.openapi.actionSystem.impl.ProxyShortcutSet
+import com.intellij.openapi.actionSystem.remoting.ActionRemoteBehaviorSpecification
 import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.project.DumbAwareToggleAction
 import com.intellij.openapi.util.TextRange
@@ -207,7 +208,7 @@ internal object IdeaSpecifics {
 }
 
 //region Find action ID
-internal class FindActionIdAction : DumbAwareToggleAction() {
+internal class FindActionIdAction : DumbAwareToggleAction(), ActionRemoteBehaviorSpecification.Disabled {
   override fun isSelected(e: AnActionEvent): Boolean = injector.globalIjOptions().trackactionids
 
   override fun setSelected(e: AnActionEvent, state: Boolean) {

diff --git a/src/main/java/com/maddyhome/idea/vim/ui/ReloadVimRc.kt b/src/main/java/com/maddyhome/idea/vim/ui/ReloadVimRc.kt
@@ -15,6 +15,7 @@ import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.actionSystem.DataContext
 import com.intellij.openapi.actionSystem.DefaultActionGroup
 import com.intellij.openapi.actionSystem.PlatformDataKeys
+import com.intellij.openapi.actionSystem.remoting.ActionRemoteBehaviorSpecification
 import com.intellij.openapi.diagnostic.logger
 import com.intellij.openapi.editor.Document
 import com.intellij.openapi.editor.toolbar.floating.AbstractFloatingToolbarProvider
@@ -109,7 +110,7 @@ internal object VimRcFileState : VimrcFileState {
   }
 }
 
-internal class ReloadVimRc : DumbAwareAction() {
+internal class ReloadVimRc : DumbAwareAction(), ActionRemoteBehaviorSpecification.Disabled {
   override fun update(e: AnActionEvent) {
     val editor = e.getData(PlatformDataKeys.EDITOR) ?: run {
       e.presentation.isEnabledAndVisible = false
@@ -172,7 +173,7 @@ internal class ReloadFloatingToolbar : AbstractFloatingToolbarProvider(ACTION_GR
   }
 }
 
-internal class ReloadFloatingToolbarActionGroup : DefaultActionGroup() {
+internal class ReloadFloatingToolbarActionGroup : DefaultActionGroup(), ActionRemoteBehaviorSpecification.Disabled {
   companion object {
     const val ACTION_GROUP = "IdeaVim.ReloadVimRc.group"
   }

diff --git a/src/main/java/com/maddyhome/idea/vim/ui/StatusBar.kt b/src/main/java/com/maddyhome/idea/vim/ui/StatusBar.kt
@@ -20,6 +20,7 @@ import com.intellij.openapi.actionSystem.ActionUpdateThread
 import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.actionSystem.DataContext
 import com.intellij.openapi.actionSystem.DefaultActionGroup
+import com.intellij.openapi.actionSystem.remoting.ActionRemoteBehaviorSpecification
 import com.intellij.openapi.application.impl.LaterInvocator
 import com.intellij.openapi.fileTypes.PlainTextLanguage
 import com.intellij.openapi.options.ShowSettingsUtil
@@ -145,7 +146,7 @@ internal class VimStatusBar : StatusBarWidget, StatusBarWidget.IconPresentation
   override fun getPresentation(): StatusBarWidget.WidgetPresentation = this
 }
 
-internal class VimActions : DumbAwareAction() {
+internal class VimActions : DumbAwareAction(), ActionRemoteBehaviorSpecification.Disabled {
 
   override fun actionPerformed(e: AnActionEvent) {
     val project = e.project ?: return

diff --git a/src/main/java/com/maddyhome/idea/vim/ui/widgets/mode/ModeWidgetPopup.kt b/src/main/java/com/maddyhome/idea/vim/ui/widgets/mode/ModeWidgetPopup.kt
@@ -11,6 +11,7 @@ package com.maddyhome.idea.vim.ui.widgets.mode
 import com.intellij.ide.ui.LafManager
 import com.intellij.openapi.actionSystem.AnAction
 import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.actionSystem.remoting.ActionRemoteBehaviorSpecification
 import com.intellij.openapi.ui.DialogPanel
 import com.intellij.openapi.ui.popup.JBPopup
 import com.intellij.openapi.ui.popup.JBPopupFactory
@@ -44,7 +45,7 @@ import javax.swing.JPanel
 import kotlin.properties.ReadWriteProperty
 import kotlin.reflect.KProperty
 
-public class ModeWidgetPopup : AnAction() {
+public class ModeWidgetPopup : AnAction(), ActionRemoteBehaviorSpecification.Disabled {
   public override fun actionPerformed(e: AnActionEvent) {
     val project = e.project ?: return
     val popup = createPopup() ?: return

diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -135,6 +135,14 @@
   <xi:include href="/META-INF/includes/VimExtensions.xml" xpointer="xpointer(/idea-plugin/*)"/>
   <xi:include href="/META-INF/includes/VimListeners.xml" xpointer="xpointer(/idea-plugin/*)"/>
 
+  <!--
+
+  IMPORTANT!
+
+  Please make sure that all actions added implement the ActionRemoteBehaviorSpecification.Disabled interface on your
+  action. This will prevent the action from flowing from a Code With Me host to the JetBrains Client
+
+  -->
   <actions resource-bundle="messages.IdeaVimBundle">
     <action id="VimPluginToggle" class="com.maddyhome.idea.vim.action.VimPluginToggleAction">
       <add-to-group group-id="ToolsMenu" anchor="last"/>