Support: Toggling Highlight

Author: phanthaiduong22

CHANGELOG.md

@@ -5,13 +5,21 @@ All notable changes to the Trailing Spaces plugin will be documented in this fil
 ## [Unreleased]
 ### Added
 - **Real-time highlighting** of trailing spaces in all open documents
+- **Toggle highlighting functionality** to enable/disable trailing space highlighting
+  - Available via Edit → Trailing Spaces → Toggle Highlighting menu
+  - Default keyboard shortcut: `Alt+Shift+D`
+  - Dynamic action text that shows current state (Enable/Disable Highlighting)
+  - Instantly updates all open editors when toggled
 - **Delete action** to remove all trailing spaces in the current document
   - Available via Command Palette (`Ctrl+Shift+A` / `Cmd+Shift+A`) - search "Trailing Spaces: Delete"
+  - Available via Edit → Trailing Spaces → Delete menu
   - Default keyboard shortcut: `Alt+Shift+T`
-  - Accessible from Edit menu
 - **Persistent settings**
   - Located at File → Settings → Tools → Trailing Spaces (Windows/Linux)
   - Located at Preferences → Tools → Trailing Spaces (Mac)
+- **Enable Highlighting setting** (default: enabled)
+  - Global setting to enable/disable all trailing space highlighting
+  - Can be toggled via settings panel or toggle action
 - **Highlight Current Line setting** (default: enabled)
   - When enabled: Always highlight trailing spaces in the currently edited line
   - When disabled: Skip highlighting in the current line to avoid distraction while typing

README.md

@@ -11,6 +11,16 @@ Jetbrains provides a way to automate deletion of trailing spaces in setting. Dep
 
 ## Usage
 
+### Toggle Highlighting
+
+You can toggle highlighting of trailing spaces on and off at any time using:
+
+1. **Menu**: Go to **"Edit / Trailing Spaces / Toggle Highlighting"**
+2. **Keyboard Shortcut**: Use `Alt+Shift+D` to instantly toggle highlighting
+3. **Settings**: Use the "Enable highlighting" checkbox in the plugin settings
+
+The action text dynamically updates to show whether it will "Enable" or "Disable" highlighting based on the current state.
+
 ### Delete
 
 The main feature you gain from using this plugin is that of deleting all trailing spaces in the currently edited document. In order to use this deletion feature, you may either:
@@ -19,7 +29,7 @@ The main feature you gain from using this plugin is that of deleting all trailin
 
 2. **Keyboard Shortcut**: The plugin comes with a default keyboard shortcut `Alt+Shift+T` to delete all trailing spaces at once in the current file!
 
-3. **Menu**: Access the action from the "Edit" menu where "Trailing Spaces: Delete" is available
+3. **Menu**: Access the action from **"Edit / Trailing Spaces / Delete"**
 
 With these options, you can quickly delete all trailing spaces in your current document whenever needed!
 
@@ -29,10 +39,15 @@ Several options are available to customize the plugin's behavior. Those settings
 
 To access the settings: Go to **"File / Settings / Tools / Trailing Spaces"** (or **"Preferences / Tools / Trailing Spaces"** on Mac).
 
+### Enable Highlighting
+**Default: true**
+
+This is the master toggle for all trailing space highlighting. When disabled, no trailing spaces will be highlighted in any file. This setting can also be toggled using the "Toggle Trailing Spaces" action (`Alt+Shift+D`) or via the menu at "Edit / Trailing Spaces / Toggle Highlighting".
+
 ### Highlight Current Line
 **Default: true**
 
 Highlighting of trailing spaces in the currently edited line can be annoying: each time you are about to start a new word, the space you type is matched as trailing spaces. The currently edited line can thus be ignored by disabling this option.
 
-When this setting is disabled, trailing spaces in the line being edited will not be highlighted.
+When this setting is disabled, trailing spaces in the line being edited will not be highlighted (only effective when "Enable Highlighting" is also enabled).
 <!-- Plugin description end -->

src/main/kotlin/com/github/phanthaiduong22/trailingspaces/actions/ToggleTrailingSpacesAction.kt

@@ -0,0 +1,59 @@
+package com.github.phanthaiduong22.trailingspaces.actions
+
+import com.github.phanthaiduong22.trailingspaces.settings.TrailingSpacesSettings
+import com.intellij.openapi.actionSystem.AnAction
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.actionSystem.CommonDataKeys
+import com.intellij.openapi.diagnostic.thisLogger
+import com.intellij.openapi.editor.EditorFactory
+import com.intellij.openapi.fileEditor.FileEditorManager
+import com.intellij.openapi.fileEditor.TextEditor
+
+class ToggleTrailingSpacesAction : AnAction() {
+    
+    override fun actionPerformed(e: AnActionEvent) {
+        val project = e.project ?: return
+        val settings = TrailingSpacesSettings.getInstance()
+        
+        settings.highlightingEnabled = !settings.highlightingEnabled
+        
+        thisLogger().info("Trailing spaces highlighting ${if (settings.highlightingEnabled) "enabled" else "disabled"}")
+        
+        val editors = FileEditorManager.getInstance(project)
+            .allEditors
+            .filterIsInstance<TextEditor>()
+            .map { it.editor }
+        
+        editors.forEach { editor ->
+            if (settings.highlightingEnabled) {
+                editor.project?.let { project ->
+                    val activity = project.getService(com.github.phanthaiduong22.trailingspaces.startup.TrailingSpacesActivity::class.java)
+                    activity?.refreshHighlighting(editor)
+                }
+            } else {
+                clearHighlighters(editor)
+            }
+        }
+    }
+    
+    override fun update(e: AnActionEvent) {
+        val editor = e.getData(CommonDataKeys.EDITOR)
+        e.presentation.isEnabledAndVisible = editor != null
+        
+        val settings = TrailingSpacesSettings.getInstance()
+        e.presentation.text = if (settings.highlightingEnabled) {
+            "Trailing Spaces: Disable Highlighting"
+        } else {
+            "Trailing Spaces: Enable Highlighting"
+        }
+    }
+    
+    private fun clearHighlighters(editor: com.intellij.openapi.editor.Editor) {
+        val markupModel = editor.markupModel
+        markupModel.allHighlighters.forEach { highlighter ->
+            if (highlighter.layer == com.github.phanthaiduong22.trailingspaces.config.PluginConfig.HIGHLIGHTER_LAYER) {
+                markupModel.removeHighlighter(highlighter)
+            }
+        }
+    }
+} 

src/main/kotlin/com/github/phanthaiduong22/trailingspaces/settings/TrailingSpacesConfigurable.kt

@@ -20,6 +20,12 @@ class TrailingSpacesConfigurable : Configurable {
     override fun createComponent(): JComponent {
         val panel = panel {
             group("Highlighting Options") {
+                row {
+                    checkBox("Enable highlighting")
+                        .bindSelected(settings::highlightingEnabled)
+                        .comment("When disabled, no trailing spaces will be highlighted in any file. " +
+                                "You can toggle this setting using the 'Toggle Trailing Spaces' action.")
+                }
                 row {
                     checkBox("Highlight current line")
                         .bindSelected(settings::highlightCurrentLine)

src/main/kotlin/com/github/phanthaiduong22/trailingspaces/settings/TrailingSpacesSettings.kt

@@ -22,7 +22,8 @@ class TrailingSpacesSettings : PersistentStateComponent<TrailingSpacesSettings.S
     private var state = State()
 
     data class State(
-        var highlightCurrentLine: Boolean = true
+        var highlightCurrentLine: Boolean = true,
+        var highlightingEnabled: Boolean = true
     )
 
     override fun getState(): State = state
@@ -39,6 +40,15 @@ class TrailingSpacesSettings : PersistentStateComponent<TrailingSpacesSettings.S
         set(value) {
             state.highlightCurrentLine = value
         }
+
+    /**
+     * Whether highlighting is globally enabled
+     */
+    var highlightingEnabled: Boolean
+        get() = state.highlightingEnabled
+        set(value) {
+            state.highlightingEnabled = value
+        }
 
     companion object {
         @JvmStatic

src/main/kotlin/com/github/phanthaiduong22/trailingspaces/startup/TrailingSpacesActivity.kt

@@ -2,12 +2,12 @@ package com.github.phanthaiduong22.trailingspaces.startup
 
 import com.github.phanthaiduong22.trailingspaces.config.PluginConfig
 import com.github.phanthaiduong22.trailingspaces.settings.TrailingSpacesSettings
+import com.intellij.openapi.components.Service
 import com.intellij.openapi.diagnostic.thisLogger
 import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.editor.EditorFactory
 import com.intellij.openapi.editor.event.DocumentEvent
 import com.intellij.openapi.editor.event.DocumentListener
-import com.intellij.openapi.editor.markup.HighlighterLayer
 import com.intellij.openapi.editor.markup.HighlighterTargetArea
 import com.intellij.openapi.editor.markup.RangeHighlighter
 import com.intellij.openapi.editor.markup.TextAttributes
@@ -18,10 +18,10 @@ import com.intellij.openapi.project.Project
 import com.intellij.openapi.startup.ProjectActivity
 import com.intellij.ui.JBColor
 import kotlinx.coroutines.*
-import java.awt.Color
 import java.util.concurrent.ConcurrentHashMap
 import java.util.regex.Pattern
 
+@Service(Service.Level.PROJECT)
 class TrailingSpacesActivity : ProjectActivity {
     private val trailingSpacePattern = Pattern.compile(PluginConfig.TRAILING_SPACE_PATTERN, PluginConfig.PATTERN_FLAGS)
     private val highlighters = mutableMapOf<Editor, MutableList<RangeHighlighter>>()
@@ -87,13 +87,14 @@ class TrailingSpacesActivity : ProjectActivity {
     private fun debounceHighlighting(editor: Editor) {
         // Cancel existing job for this editor
         debounceJobs[editor]?.cancel()
-        
+
         // Start new debounced job
-        val job = coroutineScope.launch {
-            delay(PluginConfig.HIGHLIGHTING_DEBOUNCE_DELAY_MS)
-            highlightTrailingSpaces(editor)
-        }
-        
+        val job =
+            coroutineScope.launch {
+                delay(PluginConfig.HIGHLIGHTING_DEBOUNCE_DELAY_MS)
+                highlightTrailingSpaces(editor)
+            }
+
         debounceJobs[editor] = job
     }
 
@@ -105,6 +106,10 @@ class TrailingSpacesActivity : ProjectActivity {
         val markupModel = editor.markupModel
         val settings = TrailingSpacesSettings.getInstance()
 
+        if (!settings.highlightingEnabled) {
+            return
+        }
+
         val caretModel = editor.caretModel
         val caretOffset = caretModel.offset
         val caretLine = document.getLineNumber(caretOffset)
@@ -143,7 +148,9 @@ class TrailingSpacesActivity : ProjectActivity {
 
         highlighters[editor] = editorHighlighters
 
-        thisLogger().debug("Added ${editorHighlighters.size} trailing space highlights (highlightCurrentLine: ${settings.highlightCurrentLine})")
+        thisLogger().debug(
+            "Added ${editorHighlighters.size} trailing space highlights (highlightCurrentLine: ${settings.highlightCurrentLine})",
+        )
     }
 
     private fun clearHighlighters(editor: Editor) {
@@ -152,4 +159,8 @@ class TrailingSpacesActivity : ProjectActivity {
         }
         highlighters.remove(editor)
     }
+
+    fun refreshHighlighting(editor: Editor) {
+        highlightTrailingSpaces(editor)
+    }
 }

src/main/resources/META-INF/plugin.xml

@@ -12,15 +12,26 @@
                                 id="com.github.phanthaiduong22.trailingspaces.settings.TrailingSpacesConfigurable" 
                                 displayName="Trailing Spaces"/>
         <applicationService serviceImplementation="com.github.phanthaiduong22.trailingspaces.settings.TrailingSpacesSettings"/>
+        <projectService serviceImplementation="com.github.phanthaiduong22.trailingspaces.startup.TrailingSpacesActivity"/>
     </extensions>
 
     <actions>
-        <action id="trailing-spaces.deleteTrailingSpaces"
-                class="com.github.phanthaiduong22.trailingspaces.actions.DeleteTrailingSpacesAction"
-                text="Trailing Spaces: Delete"
-                description="Delete all trailing spaces in the current document">
+        <group id="TrailingSpacesGroup" text="Trailing Spaces" popup="true">
             <add-to-group group-id="EditMenu" anchor="last"/>
-            <keyboard-shortcut keymap="$default" first-keystroke="alt shift T"/>
-        </action>
+            
+            <action id="trailing-spaces.toggleHighlighting"
+                    class="com.github.phanthaiduong22.trailingspaces.actions.ToggleTrailingSpacesAction"
+                    text="Toggle Highlighting"
+                    description="Toggle highlighting of trailing spaces">
+                <keyboard-shortcut keymap="$default" first-keystroke="alt shift D"/>
+            </action>
+            
+            <action id="trailing-spaces.deleteTrailingSpaces"
+                    class="com.github.phanthaiduong22.trailingspaces.actions.DeleteTrailingSpacesAction"
+                    text="Delete"
+                    description="Delete all trailing spaces in the current document">
+                <keyboard-shortcut keymap="$default" first-keystroke="alt shift T"/>
+            </action>
+        </group>
     </actions>
 </idea-plugin>