add documentation builder (comments folder)

Author: xepozz

src/main/kotlin/com/github/xepozz/gitattributes/ide/documentation/AttributesDocumentationProvider.kt

@@ -0,0 +1,89 @@
+package com.github.xepozz.gitattributes.ide.documentation
+
+import com.github.xepozz.crontab.ide.documentation.AttributesDocumentationUtils
+import com.github.xepozz.gitattributes.language.AttributesFile
+import com.github.xepozz.gitattributes.language.psi.AttributesDefinition
+import com.github.xepozz.gitattributes.language.psi.AttributesPattern
+import com.intellij.extapi.psi.ASTDelegatePsiElement
+import com.intellij.lang.ASTNode
+import com.intellij.lang.documentation.DocumentationMarkup
+import com.intellij.lang.documentation.DocumentationProvider
+import com.intellij.lang.documentation.QuickDocHighlightingHelper
+import com.intellij.markdown.utils.doc.DocMarkdownToHtmlConverter
+import com.intellij.openapi.editor.Editor
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiComment
+import com.intellij.psi.PsiDocCommentBase
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiFile
+import com.intellij.psi.presentation.java.SymbolPresentationUtil
+import com.intellij.psi.util.PsiTreeUtil
+import java.util.function.Consumer
+
+class AttributesDocumentationProvider : DocumentationProvider {
+    override fun getUrlFor(element: PsiElement?, originalElement: PsiElement?): List<String>? {
+//        if (element !is AttributesSchedule) return null
+//        return listOf(AttributesGuruUtils.generateCrontabGuruUrl(element))
+        return null
+    }
+
+    override fun getCustomDocumentationElement(
+        editor: Editor,
+        file: PsiFile,
+        contextElement: PsiElement?,
+        targetOffset: Int
+    ): PsiElement? {
+        if (file !is AttributesFile) return null
+
+        return PsiTreeUtil.findFirstParent(contextElement) { it is AttributesDefinition }
+    }
+
+    /**
+     * Extracts the key, value, file and documentation comment of a Simple key/value entry and returns
+     * a formatted representation of the information.
+     */
+    override fun generateDoc(element: PsiElement?, originalElement: PsiElement?): String? = null
+
+    override fun getQuickNavigateInfo(element: PsiElement?, originalElement: PsiElement?): String? = null
+
+    override fun generateRenderedDoc(comment: PsiDocCommentBase) = markdownToHtml(comment.text, comment.project)
+
+    fun markdownToHtml(string: String, project: Project) = string
+        .split("\n")
+        .joinToString("\n") { it.replaceFirst(Regex("#+\\s+"), "") }
+        .let { DocMarkdownToHtmlConverter.convert(project, it) }
+
+    override fun findDocComment(file: PsiFile, range: TextRange): PsiDocCommentBase? {
+        val element = file.findElementAt(range.startOffset) as? PsiComment ?: return null
+
+        return object : PsiCommentDelegate(element), PsiDocCommentBase {
+            override fun getOwner() = element
+        }
+    }
+
+    override fun collectDocComments(file: PsiFile, sink: Consumer<in PsiDocCommentBase>) {
+        buildList {
+            addAll(PsiTreeUtil.findChildrenOfType(file, AttributesDefinition::class.java))
+        }
+            .forEach { expression ->
+                println("comments for $expression")
+                val comment = AttributesDocumentationUtils.findContextualDocumentationElement(expression) ?: return@forEach
+                println("$comment for $expression")
+                sink.accept(object : PsiCommentDelegate(comment), PsiDocCommentBase {
+                    override fun getOwner() = expression
+                })
+            }
+    }
+
+    override fun generateHoverDoc(element: PsiElement, originalElement: PsiElement?) =
+        generateDoc(element, originalElement)
+}
+
+open class PsiCommentDelegate(val myComment: PsiComment) : PsiComment, ASTDelegatePsiElement() {
+    override fun getTokenType() = myComment.tokenType
+
+    override fun getParent(): PsiElement? = myComment.parent
+
+    override fun getNode(): ASTNode = myComment.node
+}

src/main/kotlin/com/github/xepozz/gitattributes/ide/documentation/AttributesDocumentationUtils.kt

@@ -0,0 +1,26 @@
+package com.github.xepozz.crontab.ide.documentation
+
+import com.github.xepozz.gitattributes.language.psi.AttributesTypes
+import com.intellij.psi.PsiComment
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiWhiteSpace
+import com.intellij.psi.util.elementType
+
+object AttributesDocumentationUtils {
+    fun findCrontabElementDocumentation(element: PsiElement?): String =
+        findContextualDocumentationElement(element)?.text?.replaceFirst("[# ]+", "") ?: ""
+
+    fun findContextualDocumentationElement(element: PsiElement?): PsiComment? {
+        if (element == null) return null
+
+        var element = element.prevSibling
+        while (element is PsiComment || element is PsiWhiteSpace || element.elementType == AttributesTypes.EOL) {
+            if (element is PsiComment) {
+                return element
+            }
+            element = element.prevSibling
+        }
+
+        return null
+    }
+}

src/main/kotlin/com/github/xepozz/gitattributes/language/psi/AttributesTokenSets.kt

@@ -3,8 +3,6 @@ package com.github.xepozz.gitattributes.language.psi
 import com.intellij.psi.tree.TokenSet
 
 object AttributesTokenSets {
-    val EMPTY_SET = TokenSet.EMPTY
-
     val COMMENTS = TokenSet.create(AttributesTypes.COMMENT)
     val STRING_LITERALS = TokenSet.create(AttributesTypes.PATTERN)
     val WHITESPACES = TokenSet.WHITE_SPACE

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

@@ -31,9 +31,9 @@
         <!--        <lang.psiStructureViewFactory-->
         <!--                language="Gitattributes"-->
         <!--                implementationClass="com.github.xepozz.gitattributes.ide.structureView.AttributesStructureViewFactory"/>-->
-        <!--        <lang.documentationProvider-->
-        <!--                language="Gitattributes"-->
-        <!--                implementationClass="com.github.xepozz.gitattributes.ide.documentation.AttributesDocumentationProvider"/>-->
+        <lang.documentationProvider
+                language="Gitattributes"
+                implementationClass="com.github.xepozz.gitattributes.ide.documentation.AttributesDocumentationProvider"/>
         <codeInsight.lineMarkerProvider
                 language="Gitattributes"
                 implementationClass="com.github.xepozz.gitattributes.ide.AttributesLineMarkerProvider"/>
@@ -46,6 +46,7 @@
         <psi.referenceContributor
                 language="Gitattributes"
                 implementation="com.github.xepozz.gitattributes.ide.reference.AttributesReferenceContributor"/>
+
         <!--        <localInspection-->
         <!--                language="Gitattributes" enabledByDefault="true" level="ERROR"-->
         <!--                groupName="Gitattributes schedule" displayName="Gitattributes schedule"-->