feat(bridge): add StylingViewFunctionProvider for CSS file handling #319

phodal · phodal · commit e4351873c231 · 2025-02-26T10:49:42.000+08:00
Introduce StylingViewFunctionProvider to manage CSS and SCSS file structures. Refactor StructureCommandUtil for better code reuse and maintainability. Add necessary CSS plugins to the build configuration.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -494,12 +494,26 @@ project(":java") {
     }
 }
 
+
+val cssPlugins = listOf(
+    "com.intellij.css",
+    "org.jetbrains.plugins.sass",
+    "org.jetbrains.plugins.less",
+    // Needed for tests-only
+    //"org.jetbrains.plugins.stylus:233.11799.172",
+    "org.intellij.plugins.postcss",
+    // Needed for tests-only
+    //"com.jetbrains.plugins.Jade:$targetVersion",
+)
+
 project(":javascript") {
     dependencies {
         intellijPlatform {
             intellijIde(prop("ideaVersion"))
             intellijPlugins(ideaPlugins)
             intellijPlugins(javaScriptPlugins)
+            intellijPlugins(cssPlugins)
+//            intellijPlugins("intellij.webpack")
             testFramework(TestFrameworkType.Plugin.JavaScript)
         }
 
@@ -618,6 +632,7 @@ project(":exts:ext-vue") {
         implementation(project(":core"))
     }
 }
+
 project(":exts:ext-dependencies") {
     dependencies {
         intellijPlatform {
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/bridge/BridgeCommandProvider.kt b/core/src/main/kotlin/cc/unitmesh/devti/bridge/BridgeCommandProvider.kt
@@ -67,9 +67,13 @@ sealed class Security(override val name: String) : BridgeCommandProvider {
 sealed class ArchViewCommand(override val name: String) : BridgeCommandProvider {
     object WebApi : ArchViewCommand("/webapi")
     object ModuleView : ArchViewCommand("/moduleView")
-    object ComponentView : ArchViewCommand("/componentView")
+
+    /**
+     * /componentView
+     */
+    object ComponentView : ArchViewCommand("componentView")
     object Structure : ArchViewCommand("/structure")
-    object Styling : ArchViewCommand("/styling")
+    object StylingView : ArchViewCommand("stylingView")
 }
 
 /**
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/bridge/utils/StructureCommandUtil.kt b/core/src/main/kotlin/cc/unitmesh/devti/bridge/utils/StructureCommandUtil.kt
@@ -0,0 +1,93 @@
+package cc.unitmesh.devti.bridge.utils
+
+import com.intellij.ide.structureView.StructureView
+import com.intellij.ide.structureView.StructureViewTreeElement
+import com.intellij.lang.LanguageStructureViewBuilder
+import com.intellij.openapi.editor.Document
+import com.intellij.openapi.fileEditor.FileEditor
+import com.intellij.openapi.fileEditor.FileEditorManager
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.psi.PsiDocumentManager
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiFile
+
+object StructureCommandUtil {
+    /**
+     * ```
+     * (1000-9999)
+     * ```
+     */
+    private val maxLineWith = 11
+    private val maxDepth = 5
+    private val maxLinesForShowLinNO = 60
+
+    fun getFileStructure(project: Project, file: VirtualFile, psiFile: PsiFile): String {
+        val viewFactory = LanguageStructureViewBuilder.INSTANCE.forLanguage(psiFile.language)
+        val fileEditor: FileEditor = FileEditorManager.getInstance(project).getEditors(file).firstOrNull()
+            ?: return "No FileEditor found."
+
+        if (viewFactory != null) {
+            val view: StructureView = viewFactory.getStructureViewBuilder(psiFile)
+                ?.createStructureView(fileEditor, project)
+                ?: return "No StructureView found."
+
+            val root: StructureViewTreeElement = view.treeModel.root
+            return traverseStructure(root, 0, StringBuilder()).toString()
+        }
+
+        return "No StructureViewModel found."
+    }
+
+    /**
+     * Display format
+     * ```
+     * elementName (location) - line number or navigate to element ?
+     * ```
+     */
+    private fun traverseStructure(element: StructureViewTreeElement, depth: Int, sb: StringBuilder): StringBuilder {
+        val indent = formatBeforeCode(element, depth)
+        var str = element.presentation.presentableText
+//        if (!str.isNullOrBlank() && !element.presentation.locationString.isNullOrBlank()) {
+//            str += " (${element.presentation.locationString})"
+//        }
+        if (!str.isNullOrBlank()) {
+            sb.append(indent).append(str).append("\n")
+        }
+
+        for (child in element.children) {
+            if (child is StructureViewTreeElement) {
+                traverseStructure(child, depth + 1, sb)
+            }
+        }
+
+        return sb
+    }
+
+    private fun formatBeforeCode(element: StructureViewTreeElement, depth: Int): String {
+        return if (element.value is PsiElement) {
+            val psiElement = element.value as PsiElement
+            val line = formatLine(psiElement)
+            if (line.length < maxLineWith) {
+                line + " ".repeat(maxLineWith - line.length) + "  ".repeat(depth)
+            } else {
+                line + "  ".repeat(depth)
+            }
+        } else {
+            " ".repeat(maxLineWith) + "  ".repeat(depth)
+        }
+    }
+
+    private fun formatLine(psiElement: PsiElement): String {
+        val psiFile: PsiFile = psiElement.containingFile
+        val document: Document = PsiDocumentManager.getInstance(psiFile.project).getDocument(psiFile) ?: return ""
+        val start = document.getLineNumber(psiElement.textRange.startOffset)
+        val end = document.getLineNumber(psiElement.textRange.endOffset)
+
+        if (end - start > maxLinesForShowLinNO) {
+            return "(${start + 1}-${end + 1})"
+        }
+
+        return " ".repeat(maxDepth)
+    }
+}
diff --git a/core/src/main/kotlin/cc/unitmesh/devti/provider/toolchain/ToolchainFunctionProvider.kt b/core/src/main/kotlin/cc/unitmesh/devti/provider/toolchain/ToolchainFunctionProvider.kt
@@ -21,11 +21,5 @@ interface ToolchainFunctionProvider {
                 it.javaClass.simpleName == providerName
             }
         }
-
-        fun provide(project: Project, funcName: String): ToolchainFunctionProvider? {
-            return EP_NAME.extensionList.firstOrNull {
-                it.isApplicable(project, funcName)
-            }
-        }
     }
 }
diff --git a/exts/devins-lang/src/main/kotlin/cc/unitmesh/devti/language/compiler/exec/StructureShireCommand.kt b/exts/devins-lang/src/main/kotlin/cc/unitmesh/devti/language/compiler/exec/StructureShireCommand.kt
@@ -1,22 +1,15 @@
 package cc.unitmesh.devti.language.compiler.exec
 
+import cc.unitmesh.devti.bridge.utils.StructureCommandUtil
 import cc.unitmesh.devti.devin.InsCommand
 import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand
 import cc.unitmesh.devti.language.utils.lookupFile
-import com.intellij.ide.structureView.StructureView
-import com.intellij.ide.structureView.StructureViewTreeElement
-import com.intellij.lang.LanguageStructureViewBuilder
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.application.runReadAction
 import com.intellij.openapi.diagnostic.logger
-import com.intellij.openapi.editor.Document
-import com.intellij.openapi.fileEditor.FileEditor
-import com.intellij.openapi.fileEditor.FileEditorManager
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.project.guessProjectDir
 import com.intellij.openapi.vfs.VirtualFile
-import com.intellij.psi.PsiDocumentManager
-import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiFile
 import com.intellij.psi.PsiManager
 import kotlinx.coroutines.Dispatchers
@@ -26,15 +19,6 @@ import kotlinx.coroutines.withContext
 class StructureInCommand(val myProject: Project, val prop: String) : InsCommand {
     override val commandName: BuiltinCommand = BuiltinCommand.STRUCTURE
 
-    /**
-     * ```
-     * (1000-9999)
-     * ```
-     */
-    private val maxLineWith = 11
-    private val maxDepth = 5
-    private val maxLinesForShowLinNO = 60
-
     private val logger = logger<StructureInCommand>()
     override suspend fun execute(): String? {
         val virtualFile = file(myProject, prop)
@@ -51,79 +35,10 @@ class StructureInCommand(val myProject: Project, val prop: String) : InsCommand
             }.get()
         } ?: return null
 
-        val structure = getFileStructure(myProject, virtualFile, psiFile)
+        val structure = StructureCommandUtil.getFileStructure(myProject, virtualFile, psiFile)
         val baseDir = myProject.guessProjectDir().toString()
         val filepath = virtualFile.path.removePrefix(baseDir)
-        return "// $filepath\n```\n" + structure + "\n```"
-    }
-
-    fun getFileStructure(project: Project, file: VirtualFile, psiFile: PsiFile): String {
-        val viewFactory = LanguageStructureViewBuilder.INSTANCE.forLanguage(psiFile.language)
-        val fileEditor: FileEditor = FileEditorManager.getInstance(project).getEditors(file).firstOrNull()
-            ?: return "No FileEditor found."
-
-        if (viewFactory != null) {
-            val view: StructureView = viewFactory.getStructureViewBuilder(psiFile)
-                ?.createStructureView(fileEditor, project)
-                ?: return "No StructureView found."
-
-            val root: StructureViewTreeElement = view.treeModel.root
-            return traverseStructure(root, 0, StringBuilder()).toString()
-        }
-
-        return "No StructureViewModel found."
-    }
-
-    /**
-     * Display format
-     * ```
-     * elementName (location) - line number or navigate to element ?
-     * ```
-     */
-    private fun traverseStructure(element: StructureViewTreeElement, depth: Int, sb: StringBuilder): StringBuilder {
-        val indent = formatBeforeCode(element, depth)
-        var str = element.presentation.presentableText
-//        if (!str.isNullOrBlank() && !element.presentation.locationString.isNullOrBlank()) {
-//            str += " (${element.presentation.locationString})"
-//        }
-        if (!str.isNullOrBlank()) {
-            sb.append(indent).append(str).append("\n")
-        }
-
-        for (child in element.children) {
-            if (child is StructureViewTreeElement) {
-                traverseStructure(child, depth + 1, sb)
-            }
-        }
-
-        return sb
-    }
-
-    private fun formatBeforeCode(element: StructureViewTreeElement, depth: Int): String {
-        return if (element.value is PsiElement) {
-            val psiElement = element.value as PsiElement
-            val line = formatLine(psiElement)
-            if (line.length < maxLineWith) {
-                line + " ".repeat(maxLineWith - line.length) + "  ".repeat(depth)
-            } else {
-                line + "  ".repeat(depth)
-            }
-        } else {
-            " ".repeat(maxLineWith) + "  ".repeat(depth)
-        }
-    }
-
-    private fun formatLine(psiElement: PsiElement): String {
-        val psiFile: PsiFile = psiElement.containingFile
-        val document: Document = PsiDocumentManager.getInstance(psiFile.project).getDocument(psiFile) ?: return ""
-        val start = document.getLineNumber(psiElement.textRange.startOffset)
-        val end = document.getLineNumber(psiElement.textRange.endOffset)
-
-        if (end - start > maxLinesForShowLinNO) {
-            return "(${start + 1}-${end + 1})"
-        }
-
-        return " ".repeat(maxDepth)
+        return "// $filepath\n```\n$structure\n```"
     }
 
     fun file(project: Project, path: String): VirtualFile? {
diff --git a/javascript/src/main/kotlin/cc/unitmesh/ide/javascript/bridge/StylingViewFunctionProvider.kt b/javascript/src/main/kotlin/cc/unitmesh/ide/javascript/bridge/StylingViewFunctionProvider.kt
@@ -0,0 +1,46 @@
+package cc.unitmesh.ide.javascript.bridge
+
+import cc.unitmesh.devti.bridge.ArchViewCommand
+import cc.unitmesh.devti.bridge.utils.StructureCommandUtil
+import cc.unitmesh.devti.provider.toolchain.ToolchainFunctionProvider
+import com.intellij.openapi.application.runReadAction
+import com.intellij.openapi.fileTypes.ex.FileTypeManagerEx
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.psi.PsiManager
+import com.intellij.psi.css.CssFileType
+import com.intellij.psi.search.FileTypeIndex
+import com.intellij.psi.search.GlobalSearchScope
+import com.intellij.psi.search.ProjectScope
+
+class StylingViewFunctionProvider : ToolchainFunctionProvider {
+    override fun isApplicable(project: Project, funcName: String) = funcName == ArchViewCommand.StylingView.name
+
+    override fun execute(
+        project: Project,
+        funcName: String,
+        args: List<Any>,
+        allVariables: Map<String, Any?>
+    ): Any {
+        val searchScope: GlobalSearchScope = ProjectScope.getContentScope(project)
+        val scssType = FileTypeManagerEx.getInstanceEx().getFileTypeByExtension("scss")
+        var files = FileTypeIndex.getFiles(scssType, searchScope)
+        if (files.isNotEmpty()) {
+            files = FileTypeIndex.getFiles(CssFileType.INSTANCE, searchScope)
+
+        }
+
+        val result = files
+            .filter(::skipVendorCss)
+            .mapNotNull { virtualFile ->
+                val psiFile = runReadAction { PsiManager.getInstance(project).findFile(virtualFile) } ?: return@mapNotNull null
+                StructureCommandUtil.getFileStructure(project, virtualFile, psiFile)
+            }
+
+        return result
+    }
+
+    /// skip all .module.css files and min,css files and under vendors
+    private fun skipVendorCss(file: VirtualFile): Boolean =
+        file.name.contains(".module.css") || file.name.contains(".min.css") || file.path.contains("vendors")
+}
diff --git a/javascript/src/main/resources/cc.unitmesh.javascript.xml b/javascript/src/main/resources/cc.unitmesh.javascript.xml
@@ -46,5 +46,6 @@
         <buildSystemProvider implementation="cc.unitmesh.ide.javascript.provider.JavaScriptBuildSystemProvider" />
 
         <uiComponentProvider implementation="cc.unitmesh.ide.javascript.bridge.ReactUIComponentProvider"/>
+        <toolchainFunctionProvider implementation="cc.unitmesh.ide.javascript.bridge.StylingViewFunctionProvider"/>
     </extensions>
 </idea-plugin>

Original file line number	Diff line number	Diff line change
`@@ -21,11 +21,5 @@ interface ToolchainFunctionProvider {`
`21`	`21`	`it.javaClass.simpleName == providerName`
`22`	`22`	`}`
`23`	`23`	`}`
`24`		`-`
`25`		`- fun provide(project: Project, funcName: String): ToolchainFunctionProvider? {`
`26`		`- return EP_NAME.extensionList.firstOrNull {`
`27`		`- it.isApplicable(project, funcName)`
`28`		`- }`
`29`		`- }`
`30`	`24`	`}`
`31`	`25`	`}`