Customizing the IntentionHintComponent

IntelliJ Platform
1

Is there any documentation that relates to how we can create and insert our own LocalQuickFix action for some HighlightInfo in a file above a certain Severity ?
And when we do insert a Quick Fix, we would like to change the light bulb icon to a different icon.

I’m a bit confused because there are so many different components that touch these things:

  • intentionAction EP
  • IntentionHintComponent
  • IntentionManager
  • CachedIntentions
  • ShowIntentionsPass
  • LocalHintManager
  • …
2

From com.intellij.codeInspection.LocalQuickFix javadoc:

Implement com.intellij.codeInsight.intention.HighPriorityAction or com.intellij.codeInsight.intention.LowPriorityAction to change ordering.

From same javadoc:

Implement com.intellij.openapi.util.Iconable interface to change icon in quick fix popup menu.

4

Icon

Unfortunately, Iconable only changes the icon within the popup menu.
I want to change the light bulb icon itself which appears floating next to the caret line. I want to slightly change its appearance so that users know when it contains the QuickFix that my plugin will provide.
Concisely, this little guy is what I want to change:
image

Creating a Quick Fix

Also, it remains unclear how I can register construct and register a QuickFix from a HighlightInfo. It seems like I have to go through InspectionManager#createProblemDescriptor which itself points at registering a LocalInspectionTool, but seems wrong since I want to do something based on other inspection tools, not create my own.

Intention Action

Highlighting range

For now, I created an IntentionAction, but it doesn’t fulfill my requirements because it doesn’t allow me to highlight the scope I will apply the fix on (since it extends beyond the PsiElement which relates to the HighlightInfo).
I believe this is what LocalQuickFixAndIntentionActionOnPsiElement is for given it has startElement and endElement properties.

Forcing no preview

One quirk I’m having with the IntentionAction for now is that it keeps trying to generate a preview, even though I don’t want it to.
I’ve tried this:

  • override fun startInWriteAction(): Boolean = false

  • override fun generatePreview(
    project: Project,
    editor: Editor,
    file: PsiFile
): IntentionPreviewInfo = IntentionPreviewInfo.EMPTY
  • <skipBeforeAfter>true</skipBeforeAfter> in my EP

Directory name exception

Moreover, I get an Exception related to Directory Name URL being undefined. I’m not quite sure how I’m supposed to treat this, but it seems to relate to this part of the EP (it’s unclear what value I need to provide).

com.intellij.diagnostic.PluginException: Intention Description Dir URL is null
5

generatePreview(...) = IntentionPreviewInfo.EMPTY should have worked. startInWriteAction() should return true if the intention modifies things in-place, while <skipBeforeAfter> specifies that the intention does not have a before.ext.template and after.ext.template pair.

As for descriptionDirectoryName, that dictates the child directory of resources/intentionDescriptions in which description.html resides.

All of these can be found in the documentation pages for intentions and intention previews.

6

@insyncwithfoo thanks! This was very helpful. I think the documentation about descriptionDirectoryName could be improved (you mentioning the “child directory of” saved me some time).

I ended up setting a description and removing the IntentionPreviewInfo.EMPTY override. Now there is a simple HTML render, which is good enough :slight_smile:

Problems left

However, I’m still stuck with:

  1. Understanding how to properly setup a LocalQuickFix (to get a highlighting range on hover)
  2. Understanding how to customize the floating icon. :thinking:
  3. Moreover, my IntentionAction is placed after a LocalQuickFix even though I’ve set:
  override fun getPriority(): PriorityAction.Priority = PriorityAction.Priority.TOP