1
0
mirror of https://github.com/chylex/IntelliJ-Inspection-Lens.git synced 2025-09-14 05:32:17 +02:00

7 Commits

18 changed files with 168 additions and 35 deletions

View File

@@ -6,7 +6,7 @@ plugins {
}
group = "com.chylex.intellij.inspectionlens"
version = "1.5.1"
version = "1.5.2.902"
repositories {
mavenCentral()
@@ -18,11 +18,8 @@ repositories {
dependencies {
intellijPlatform {
intellijIdeaUltimate("2023.3.3")
rustRover("2025.1.2", useInstaller = false)
bundledPlugin("tanvd.grazi")
// https://plugins.jetbrains.com/plugin/12175-grazie-lite/versions
// plugin("tanvd.grazi", "233.13135.14")
}
testImplementation("org.junit.jupiter:junit-jupiter:5.9.2")
@@ -42,16 +39,12 @@ kotlin {
compilerOptions {
freeCompilerArgs = listOf(
"-X" + "jvm-default=all"
"-X" + "jvm-default=all",
"-X" + "lambdas=indy"
)
}
}
tasks.withType<Test>().configureEach {
tasks.test {
useJUnitPlatform()
}
val testSnapshot by intellijPlatformTesting.testIde.registering {
version = "LATEST-EAP-SNAPSHOT"
useInstaller = false
}

View File

@@ -2,7 +2,7 @@ rootProject.name = "InspectionLens"
pluginManagement {
plugins {
kotlin("jvm") version "1.9.21"
id("org.jetbrains.intellij.platform") version "2.2.1"
kotlin("jvm") version "2.1.0"
id("org.jetbrains.intellij.platform") version "2.6.0"
}
}

View File

@@ -3,6 +3,7 @@ package com.chylex.intellij.inspectionlens
import com.chylex.intellij.inspectionlens.editor.EditorLensFeatures
import com.intellij.openapi.application.ApplicationManager
import com.intellij.openapi.components.service
import com.intellij.openapi.diagnostic.logger
import com.intellij.openapi.fileEditor.FileEditorManager
import com.intellij.openapi.fileEditor.TextEditor
import com.intellij.openapi.project.ProjectManager
@@ -13,6 +14,8 @@ import com.intellij.openapi.project.ProjectManager
internal object InspectionLens {
const val PLUGIN_ID = "com.chylex.intellij.inspectionlens"
val LOG = logger<InspectionLens>()
/**
* Installs lenses into [editor].
*/

View File

@@ -11,6 +11,8 @@ import com.intellij.openapi.vfs.VirtualFile
*/
class InspectionLensFileOpenedListener : FileOpenedSyncListener {
override fun fileOpenedSync(source: FileEditorManager, file: VirtualFile, editorsWithProviders: List<FileEditorWithProvider>) {
InspectionLens.LOG.info("File opened: $file (editor count: ${editorsWithProviders.size})")
for (editorWrapper in editorsWithProviders) {
val fileEditor = editorWrapper.fileEditor
if (fileEditor is TextEditor) {

View File

@@ -0,0 +1,9 @@
package com.chylex.intellij.inspectionlens.debug
import com.intellij.codeInsight.daemon.impl.HighlightInfo
import com.intellij.lang.annotation.HighlightSeverity
import com.intellij.openapi.editor.markup.RangeHighlighter
data class Highlighter(val hashCode: Int, val layer: Int, val severity: HighlightSeverity, val description: String) {
constructor(highlighter: RangeHighlighter, info: HighlightInfo) : this(System.identityHashCode(highlighter), highlighter.layer, info.severity, info.description)
}

View File

@@ -0,0 +1,5 @@
package com.chylex.intellij.inspectionlens.debug
import java.time.Instant
data class LensEvent(val time: Instant, val data: LensEventData)

View File

@@ -0,0 +1,7 @@
package com.chylex.intellij.inspectionlens.debug
sealed interface LensEventData {
data class MarkupModelAfterAdded(val lens: Highlighter) : LensEventData
data class MarkupModelAttributesChanged(val lens: Highlighter) : LensEventData
data class MarkupModelBeforeRemoved(val lens: Highlighter) : LensEventData
}

View File

@@ -0,0 +1,14 @@
package com.chylex.intellij.inspectionlens.debug
import com.intellij.openapi.editor.Editor
import java.time.Instant
object LensEventManager {
val fileNameToEventsMap = mutableMapOf<String, MutableList<LensEvent>>()
@Synchronized
fun addEvent(editor: Editor, event: LensEventData) {
val path = editor.virtualFile?.path ?: return
fileNameToEventsMap.getOrPut(path, ::mutableListOf).add(LensEvent(Instant.now(), event))
}
}

View File

@@ -1,5 +1,6 @@
package com.chylex.intellij.inspectionlens.editor
import com.chylex.intellij.inspectionlens.InspectionLens
import com.intellij.openapi.Disposable
import com.intellij.openapi.editor.Editor
import com.intellij.openapi.editor.ex.FoldingModelEx
@@ -19,7 +20,7 @@ internal class EditorLensFeatures private constructor(
) {
private val lensManager = EditorLensManager(editor)
private val lensManagerDispatcher = EditorLensManagerDispatcher(lensManager)
private val markupModelListener = LensMarkupModelListener(lensManagerDispatcher)
private val markupModelListener = LensMarkupModelListener(editor, lensManagerDispatcher)
init {
markupModel.addMarkupModelListener(disposable, markupModelListener)
@@ -38,19 +39,28 @@ internal class EditorLensFeatures private constructor(
fun install(editor: Editor, disposable: Disposable) {
if (editor.getUserData(EDITOR_KEY) != null) {
InspectionLens.LOG.info("Skipped installation to: $editor")
return
}
InspectionLens.LOG.info("Installing to: $editor")
val markupModel = DocumentMarkupModel.forDocument(editor.document, editor.project, false) as? MarkupModelEx ?: return
val foldingModel = editor.foldingModel as? FoldingModelEx
val features = EditorLensFeatures(editor, markupModel, foldingModel, disposable)
editor.putUserData(EDITOR_KEY, features)
Disposer.register(disposable) { editor.putUserData(EDITOR_KEY, null) }
Disposer.register(disposable) {
InspectionLens.LOG.info("Installation disposed: $editor", Exception("DISPOSE STACK TRACE"))
editor.putUserData(EDITOR_KEY, null)
}
}
fun refresh(editor: Editor) {
editor.getUserData(EDITOR_KEY)?.refresh()
val userData = editor.getUserData(EDITOR_KEY)
InspectionLens.LOG.info("Refreshing: $editor ($userData)")
userData?.refresh()
}
}
}

View File

@@ -1,7 +1,9 @@
package com.chylex.intellij.inspectionlens.editor
import com.chylex.intellij.inspectionlens.debug.Highlighter
import com.chylex.intellij.inspectionlens.editor.lens.EditorLens
import com.chylex.intellij.inspectionlens.settings.LensSettingsState
import com.intellij.codeInsight.daemon.impl.HighlightInfo
import com.intellij.openapi.components.service
import com.intellij.openapi.editor.Editor
import com.intellij.openapi.editor.markup.RangeHighlighter
@@ -14,6 +16,9 @@ internal class EditorLensManager(private val editor: Editor) {
private val lenses = IdentityHashMap<RangeHighlighter, EditorLens>()
private val settings = service<LensSettingsState>()
private val highlighters
get() = lenses.keys.map { Highlighter(it, HighlightInfo.fromRangeHighlighter(it)!!) }
private fun show(highlighterWithInfo: HighlighterWithInfo) {
val (highlighter, info) = highlighterWithInfo

View File

@@ -1,8 +1,13 @@
package com.chylex.intellij.inspectionlens.editor
import com.chylex.intellij.inspectionlens.InspectionLens
import com.chylex.intellij.inspectionlens.debug.Highlighter
import com.chylex.intellij.inspectionlens.debug.LensEventData
import com.chylex.intellij.inspectionlens.debug.LensEventManager
import com.chylex.intellij.inspectionlens.settings.LensSettingsState
import com.intellij.codeInsight.daemon.impl.HighlightInfo
import com.intellij.openapi.components.service
import com.intellij.openapi.editor.Editor
import com.intellij.openapi.editor.ex.RangeHighlighterEx
import com.intellij.openapi.editor.impl.event.MarkupModelListener
import com.intellij.openapi.editor.markup.RangeHighlighter
@@ -10,20 +15,36 @@ import com.intellij.openapi.editor.markup.RangeHighlighter
/**
* Listens for inspection highlights and reports them to [EditorLensManager].
*/
internal class LensMarkupModelListener(private val lensManagerDispatcher: EditorLensManagerDispatcher) : MarkupModelListener {
internal class LensMarkupModelListener(private val editor: Editor, private val lensManagerDispatcher: EditorLensManagerDispatcher) : MarkupModelListener {
private val settings = service<LensSettingsState>()
override fun afterAdded(highlighter: RangeHighlighterEx) {
showIfValid(highlighter)
try {
getFilteredHighlightInfo(highlighter)?.let { LensEventManager.addEvent(editor, LensEventData.MarkupModelAfterAdded(Highlighter(highlighter, it))) }
showIfValid(highlighter)
} catch (e: Exception) {
InspectionLens.LOG.error("Error showing inspection", e)
}
}
override fun attributesChanged(highlighter: RangeHighlighterEx, renderersChanged: Boolean, fontStyleOrColorChanged: Boolean) {
showIfValid(highlighter)
try {
getFilteredHighlightInfo(highlighter)?.let { LensEventManager.addEvent(editor, LensEventData.MarkupModelAttributesChanged(Highlighter(highlighter, it))) }
showIfValid(highlighter)
} catch (e: Exception) {
InspectionLens.LOG.error("Error updating inspection", e)
}
}
override fun beforeRemoved(highlighter: RangeHighlighterEx) {
if (getFilteredHighlightInfo(highlighter) != null) {
lensManagerDispatcher.hide(highlighter)
try {
val filteredHighlightInfo = getFilteredHighlightInfo(highlighter)
if (filteredHighlightInfo != null) {
LensEventManager.addEvent(editor, LensEventData.MarkupModelBeforeRemoved(Highlighter(highlighter, filteredHighlightInfo)))
lensManagerDispatcher.hide(highlighter)
}
} catch (e: Exception) {
InspectionLens.LOG.error("Error hiding inspection", e)
}
}

View File

@@ -32,6 +32,10 @@ internal class EditorLens private constructor(private var inlay: EditorLensInlay
lineBackground.hide(inlay.editor)
}
override fun toString(): String {
return "$inlay"
}
companion object {
fun show(editor: Editor, info: HighlightInfo, settings: LensSettingsState): EditorLens? {
val inlay = EditorLensInlay.show(editor, info, settings) ?: return null

View File

@@ -2,7 +2,6 @@ package com.chylex.intellij.inspectionlens.editor.lens
import com.intellij.codeInsight.daemon.impl.IntentionsUI
import com.intellij.codeInsight.hint.HintManager
import com.intellij.codeInsight.intention.actions.ShowIntentionActionsAction
import com.intellij.codeInsight.intention.impl.ShowIntentionActionsHandler
import com.intellij.lang.LangBundle
import com.intellij.openapi.actionSystem.ActionManager
@@ -26,7 +25,7 @@ internal object IntentionsPopup {
// If the IDE uses the default Show Intentions action and handler,
// use the handler directly to bypass additional logic from the action.
val action = ActionManager.getInstance().getAction(IdeActions.ACTION_SHOW_INTENTION_ACTIONS)
if (action.javaClass === ShowIntentionActionsAction::class.java) {
if (action.javaClass.name === DEFAULT_ACTION_CLASS) {
return tryShowWithDefaultHandler(editor)
}
else {
@@ -46,6 +45,11 @@ internal object IntentionsPopup {
return true
}
/**
* New IDEA versions mark this class as internal, so the plugin verifier flags references to it as errors.
*/
const val DEFAULT_ACTION_CLASS = "com.intellij.codeInsight.intention.actions.ShowIntentionActionsAction"
private val HANDLER = object : ShowIntentionActionsHandler() {
public override fun showIntentionHint(project: Project, editor: Editor, file: PsiFile, showFeedbackOnEmptyMenu: Boolean) {
super.showIntentionHint(project, editor, file, showFeedbackOnEmptyMenu)

View File

@@ -44,7 +44,7 @@ class LensRenderer(private var info: HighlightInfo, private val settings: LensSe
fun setPropertiesFrom(info: HighlightInfo) {
this.info = info
val description = getValidDescriptionText(info.description)
val description = getValidDescriptionText(info.description, settings.maxDescriptionLength)
text = description
attributes = LensSeverity.from(info.severity).textAttributes
@@ -155,15 +155,13 @@ class LensRenderer(private var info: HighlightInfo, private val settings: LensSe
private const val HOVER_HORIZONTAL_PADDING = TEXT_HORIZONTAL_PADDING - 2
private const val UNDERLINE_WIDTH_REDUCTION = (TEXT_HORIZONTAL_PADDING * 2) - 1
private const val MAX_DESCRIPTION_LENGTH = 120
/**
* Kotlin compiler inspections have an `[UPPERCASE_TAG]` at the beginning.
*/
private val UPPERCASE_TAG_REGEX = Pattern.compile("^\\[[A-Z_]+] ")
private fun getValidDescriptionText(text: String?): String {
return if (text.isNullOrBlank()) " " else addEllipsisOrMissingPeriod(unescapeHtmlEntities(stripUppercaseTag(text)))
private fun getValidDescriptionText(text: String?, maxLength: Int): String {
return if (text.isNullOrBlank()) " " else addEllipsisOrMissingPeriod(unescapeHtmlEntities(stripUppercaseTag(text)), maxLength)
}
private fun stripUppercaseTag(text: String): String {
@@ -181,11 +179,11 @@ class LensRenderer(private var info: HighlightInfo, private val settings: LensSe
return if (text.contains('&')) StringUtil.unescapeXmlEntities(text) else text
}
private fun addEllipsisOrMissingPeriod(text: String): String {
private fun addEllipsisOrMissingPeriod(text: String, maxLength: Int): String {
return when {
text.length > MAX_DESCRIPTION_LENGTH -> text.take(MAX_DESCRIPTION_LENGTH).trimEnd { it.isWhitespace() || it == '.' } + ""
!text.endsWith('.') -> "$text."
else -> text
text.length > maxLength -> text.take(maxLength).trimEnd { it.isWhitespace() || it == '.' } + ""
!text.endsWith('.') -> "$text."
else -> text
}
}

View File

@@ -10,6 +10,7 @@ import com.intellij.openapi.editor.markup.TextAttributes
import com.intellij.openapi.options.BoundConfigurable
import com.intellij.openapi.options.ConfigurableWithId
import com.intellij.openapi.ui.DialogPanel
import com.intellij.openapi.ui.MessageDialogBuilder
import com.intellij.openapi.util.Disposer
import com.intellij.ui.DisabledTraversalPolicy
import com.intellij.ui.EditorTextFieldCellRenderer.SimpleRendererComponent
@@ -19,6 +20,7 @@ import com.intellij.ui.dsl.builder.Cell
import com.intellij.ui.dsl.builder.RightGap
import com.intellij.ui.dsl.builder.Row
import com.intellij.ui.dsl.builder.RowLayout
import com.intellij.ui.dsl.builder.bindIntText
import com.intellij.ui.dsl.builder.bindItem
import com.intellij.ui.dsl.builder.bindSelected
import com.intellij.ui.dsl.builder.panel
@@ -75,16 +77,21 @@ class LensApplicationConfigurable : BoundConfigurable("Inspection Lens"), Config
override fun createPanel(): DialogPanel {
val settings = settingsService.state
return panel {
lateinit var panel: DialogPanel
panel = panel {
group("Appearance") {
row {
checkBox("Use editor font").bindSelected(settings::useEditorFont)
}
row("Max description length:") {
intTextField(LensSettingsState.MAX_DESCRIPTION_LENGTH_RANGE, keyboardStep = 10).bindIntText(settings::maxDescriptionLength)
}
}
group("Behavior") {
row("Hover mode:") {
val items = LensHoverMode.values().toList()
val items = LensHoverMode.entries
val renderer = SimpleListCellRenderer.create("", LensHoverMode::description)
comboBox(items, renderer).bindItem(settings::lensHoverMode) { settings.lensHoverMode = it ?: LensHoverMode.DEFAULT }
}
@@ -105,7 +112,20 @@ class LensApplicationConfigurable : BoundConfigurable("Inspection Lens"), Config
checkBox("Other").bindSelected(settings::showUnknownSeverities)
}
}
group("Actions") {
row {
button("Reset to Default") {
if (MessageDialogBuilder.yesNo("Reset to Default", "Are you sure you want to reset settings to default?").ask(panel)) {
settingsService.resetState()
reset()
}
}
}
}
}
return panel
}
private fun <K, V> Cell<JBCheckBox>.bindSelectedToNotIn(collection: MutableMap<K, V>, key: K, value: V): Cell<JBCheckBox> {

View File

@@ -21,9 +21,14 @@ class LensSettingsState : SimplePersistentStateComponent<LensSettingsState.State
var showUnknownSeverities by property(true)
var useEditorFont by property(true)
var maxDescriptionLength by property(120)
var lensHoverMode by enum(LensHoverMode.DEFAULT)
}
companion object {
val MAX_DESCRIPTION_LENGTH_RANGE = 20..1000
}
@get:Synchronized
@set:Synchronized
var severityFilter = createSeverityFilter()
@@ -32,11 +37,27 @@ class LensSettingsState : SimplePersistentStateComponent<LensSettingsState.State
val useEditorFont
get() = state.useEditorFont
val maxDescriptionLength
get() = state.maxDescriptionLength
val lensHoverMode
get() = state.lensHoverMode
override fun loadState(state: State) {
super.loadState(state)
state.maxDescriptionLength = state.maxDescriptionLength.coerceIn(MAX_DESCRIPTION_LENGTH_RANGE)
update()
}
fun resetState() {
val default = State()
state.hiddenSeverities.apply { clear(); putAll(default.hiddenSeverities) }
state.showUnknownSeverities = default.showUnknownSeverities
state.useEditorFont = default.useEditorFont
state.maxDescriptionLength = default.maxDescriptionLength
state.lensHoverMode = default.lensHoverMode
update()
}

View File

@@ -14,6 +14,11 @@
]]></description>
<change-notes><![CDATA[
<b>Version 1.5.2</b>
<ul>
<li>Added option to change maximum description length.</li>
<li>Added button to <b>Settings | Tools | Inspection Lens</b> that resets all settings to default.</li>
</ul>
<b>Version 1.5.1</b>
<ul>
<li>Added option to change the behavior of clicking on inspections.</li>

View File

@@ -0,0 +1,12 @@
package com.chylex.intellij.inspectionlens.editor.lens
import com.intellij.codeInsight.intention.actions.ShowIntentionActionsAction
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Test
class IntentionsPopupTest {
@Test
fun showIntentionActionsActionClassHasNotChanged() {
assertEquals(IntentionsPopup.DEFAULT_ACTION_CLASS, ShowIntentionActionsAction::class.java.name)
}
}