Skip to content

Commit

Permalink
fix(intellij): ensure inlay hints appear when appropriate, without du…
Browse files Browse the repository at this point in the history 
…plicates
  • Loading branch information
@fwouts
fwouts committed Jan 31, 2024
1 parent 2a4eadd commit 0d24f62
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 35 deletions.
77 changes: 46 additions & 31 deletions ...ons/intellij/src/main/kotlin/com/previewjs/intellij/plugin/inlays/InlayProviderFactory.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package com.previewjs.intellij.plugin.inlays
import com.intellij.codeInsight.hints.ChangeListener
import com.intellij.codeInsight.hints.FactoryInlayHintsCollector
import com.intellij.codeInsight.hints.ImmediateConfigurable
import com.intellij.codeInsight.hints.InlayHintsCollector
import com.intellij.codeInsight.hints.InlayHintsProvider
import com.intellij.codeInsight.hints.InlayHintsProviderFactory
import com.intellij.codeInsight.hints.InlayHintsSink
Expand All @@ -12,7 +13,6 @@ import com.intellij.codeInsight.hints.SettingsKey
import com.intellij.lang.Language
import com.intellij.openapi.components.service
import com.intellij.openapi.editor.Editor
import com.intellij.openapi.project.Project
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiFile
import com.previewjs.intellij.plugin.services.ProjectService
Expand All @@ -39,21 +39,18 @@ class InlayProviderFactory : InlayHintsProviderFactory {
// TOML, JSON, HgIgnore, InjectedFreeMarker, MySQL, AZURE, TypeScript, AIDL, AngularJS, PostCSS, Snowflake, Micronaut-MongoDB-JSON, Redis, XML, SQL92, TSQL, protobase, Angular2Svg, JSUnicodeRegexp, Nashorn JS, JVM, EL, Gherkin, AndroidDataBinding, SQLDateTime, SVG, , XHTML, RoomSql, DB2, Properties, XPath, DB2_ZOS, FTL>, JavaScript 1.8, ThymeleafSpringSecurityExtras, Renderscript, Angular2, prototext, ThymeleafTemplatesExpressions, H2, XsdRegExp, HTML, LESS, JQL, yaml, MongoJSExt, JSPX, Flow JS, PostgreSQL, JQuery-CSS, GitIgnore, Lombok.Config, Dockerfile, KND, CouchbaseQuery, Qute, JSRegexp, ThymeleafExpressions, VueExpr, SQLite, SparkSQL, GenericSQL, JSP, OracleSqlPlus, UastContextLanguage, Markdown, DTD, TEXT, DeviceSpec, UAST, ThymeleafUrlExpressions, EQL, Groovy, TypeScript JSX, SCSS, JSONPath, JSON5, Vue, Exasol, HSQLDB, protobuf, EditorConfig, ECMA Script Level 4, Greenplum, Cookie, kotlin, textmate, ClickHouse, HtmlCompatible, EJBQL, Derby, SPI, Cockroach, JavaScript, Angular2Html, MicronautDataQL, IntegrationPerformanceTest, VTL, GitExclude, MultiDexKeep, Shell Script, CassandraQL, RegExp, HiveQL, Smali, Manifest, SHRINKER_CONFIG, JAVA, LogcatFilter, VueJS, IgnoreLang, SQL, $XSLT, PointcutExpression, MariaDB, DB2_IS, AGSL, Oracle, SpEL, SpringDataQL, JSON Lines, FTL], BigQuery, MongoJS, YouTrack, CSS, MongoDB, Metadata JSON, Vertica, SASS, Sybase, ThymeleafIterateExpressions, ThymeleafTemplatesFragmentExpressions, ECMAScript 6, XPath2, HTTP Request, RELAX-NG, DockerIgnore, HttpClientHandlerJavaScriptDialect, FTL, JPAQL, HQL, JShellLanguage, VueTS, MySQL based, MongoDB-JSON, Spring-MongoDB-JSON, Redshift
}

@Deprecated("Use getProvidersInfo without project", replaceWith = ReplaceWith("getProvidersInfo()"))
override fun getProvidersInfo(project: Project): List<ProviderInfo<out Any>> {
return getLanguages().map { l -> ProviderInfo(l, InlayProvider()) }
}
private val inlayProvider = InlayProvider()

override fun getProvidersInfo(): List<ProviderInfo<out Any>> {
return getLanguages().map { l -> ProviderInfo(l, InlayProvider()) }
return getLanguages().map { l -> ProviderInfo(l, inlayProvider) }
}

override fun getLanguages(): Iterable<Language> {
return Language.getRegisteredLanguages().filter { l -> LANGUAGE_IDS.contains(l.id) }
}

override fun getProvidersInfoForLanguage(language: Language): List<InlayHintsProvider<out Any>> {
return listOf(InlayProvider())
return listOf(inlayProvider)
}

class InlayProvider : InlayHintsProvider<NoSettings> {
Expand All @@ -65,6 +62,8 @@ class InlayProviderFactory : InlayHintsProviderFactory {

override val isVisibleInSettings = false

private var fileToCollectorMap: MutableMap<PsiFile, FactoryInlayHintsCollector> = mutableMapOf()

override fun isLanguageSupported(language: Language): Boolean {
return LANGUAGE_IDS.contains(language.id)
}
Expand All @@ -74,31 +73,47 @@ class InlayProviderFactory : InlayHintsProviderFactory {
editor: Editor,
settings: NoSettings,
sink: InlayHintsSink,
) = object : FactoryInlayHintsCollector(editor) {
override fun collect(
element: PsiElement,
editor: Editor,
sink: InlayHintsSink,
): Boolean {
val projectService = file.project.service<ProjectService>()
val components = projectService.getPrecomputedComponents(file)
for (component in components) {
val previewableName = component.id.substring(component.id.indexOf(":") + 1)
sink.addBlockElement(
component.start,
relatesToPrecedingText = false,
showAbove = true,
priority = 0,
presentation =
factory.referenceOnHover(
factory.roundWithBackground(factory.smallText("Open $previewableName in Preview.js")),
) { _, _ ->
projectService.openPreview(file.virtualFile.path, component.id)
},
)
}
return false
): InlayHintsCollector {
val existing = this.fileToCollectorMap[file]
if (existing != null) {
return existing
}
val collector =
object : FactoryInlayHintsCollector(editor) {
private var lastSink: InlayHintsSink? = null

override fun collect(
element: PsiElement,
editor: Editor,
sink: InlayHintsSink,
): Boolean {
if (sink === lastSink) {
// Prevent a bug where duplicate inlay hints are shown.
return false
}
lastSink = sink
val projectService = file.project.service<ProjectService>()
val components = projectService.getPrecomputedComponents(file)
for (component in components) {
val previewableName = component.id.substring(component.id.indexOf(":") + 1)
sink.addBlockElement(
component.start,
relatesToPrecedingText = false,
showAbove = true,
priority = 0,
presentation =
factory.referenceOnHover(
factory.roundWithBackground(factory.smallText("Open $previewableName in Preview.js")),
) { _, _ ->
projectService.openPreview(file.virtualFile.path, component.id)
},
)
}
return false
}
}
this.fileToCollectorMap[file] = collector
return collector
}

override fun createConfigurable(settings: NoSettings): ImmediateConfigurable {
Expand Down
6 changes: 2 additions & 4 deletions ...rations/intellij/src/main/kotlin/com/previewjs/intellij/plugin/services/ProjectService.kt
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package com.previewjs.intellij.plugin.services

import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer
import com.intellij.codeInsight.daemon.impl.InlayHintsPassFactoryInternal
import com.intellij.execution.filters.TextConsoleBuilderFactory
import com.intellij.execution.ui.ConsoleView
import com.intellij.execution.ui.ConsoleViewContentType
Expand All @@ -20,7 +20,6 @@ import com.intellij.openapi.util.Disposer
import com.intellij.openapi.util.IconLoader
import com.intellij.openapi.vfs.VirtualFile
import com.intellij.openapi.vfs.VirtualFileManager
import com.intellij.openapi.vfs.findPsiFile
import com.intellij.openapi.vfs.newvfs.BulkFileListener
import com.intellij.openapi.vfs.newvfs.events.VFileEvent
import com.intellij.openapi.wm.StatusBarWidgetFactory
Expand Down Expand Up @@ -238,8 +237,7 @@ class ProjectService(private val project: Project) : Disposable {
crawlFile(file) { components ->
componentMap[file.path] = Pair(text, components)
app.invokeLater {
val psiFile = file.findPsiFile(project) ?: return@invokeLater
DaemonCodeAnalyzer.getInstance(project).restart(psiFile)
InlayHintsPassFactoryInternal.restartDaemonUpdatingHints(project)
}
}
}
Expand Down

0 comments on commit 0d24f62

Please sign in to comment.