Merge pull request #440 from domaframework/fix/sql-format-comment-block

Fix: Unnecessary Space in Parser-Level Comments

Author: xterao

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/SqlFileBlock.kt

@@ -24,8 +24,11 @@ import com.intellij.formatting.Spacing
 import com.intellij.formatting.SpacingBuilder
 import com.intellij.formatting.Wrap
 import com.intellij.lang.ASTNode
+import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiWhiteSpace
 import com.intellij.psi.formatter.common.AbstractBlock
+import com.intellij.psi.util.PsiTreeUtil
+import com.intellij.psi.util.elementType
 import org.domaframework.doma.intellij.common.util.TypeUtil
 import org.domaframework.doma.intellij.formatter.block.comma.SqlCommaBlock
 import org.domaframework.doma.intellij.formatter.block.comment.SqlCommentBlock
@@ -262,15 +265,23 @@ open class SqlFileBlock(
                 child,
                 createBlockDirectiveCommentSpacingBuilder(),
             )
-        if (tempBlock !is SqlElConditionLoopCommentBlock) {
-            if (lastGroup is SqlWithQueryGroupBlock || lastGroupFilteredDirective is SqlWithQueryGroupBlock) {
-                return SqlWithCommonTableGroupBlock(child, defaultFormatCtx)
+        val commentType = PsiTreeUtil.getChildrenOfType(child.psi, PsiElement::class.java)?.get(1)?.elementType
+        val defaultBlockComment =
+            commentType == SqlTypes.EL_PARSER_LEVEL_COMMENT || commentType == SqlTypes.BLOCK_COMMENT_CONTENT ||
+                child.elementType == SqlTypes.LINE_COMMENT
+        if (!defaultBlockComment) {
+            if (tempBlock !is SqlElConditionLoopCommentBlock) {
+                if (lastGroup is SqlWithQueryGroupBlock || lastGroupFilteredDirective is SqlWithQueryGroupBlock) {
+                    return SqlWithCommonTableGroupBlock(child, defaultFormatCtx)
+                }
+            }
+            return if (lastGroup is SqlWithCommonTableGroupBlock) {
+                SqlWithCommonTableGroupBlock(child, defaultFormatCtx)
+            } else {
+                tempBlock
             }
-        }
-        return if (lastGroup is SqlWithCommonTableGroupBlock) {
-            SqlWithCommonTableGroupBlock(child, defaultFormatCtx)
         } else {
-            tempBlock
+            return tempBlock
         }
     }
 

src/main/kotlin/org/domaframework/doma/intellij/formatter/processor/SqlFormatPreProcessor.kt

@@ -116,11 +116,41 @@ class SqlFormatPreProcessor : PreFormatProcessor {
             }
         }
 
+        trimLeadingWhitespaceAtFileHead(document, source, rangeToReformat)
         docManager.commitDocument(document)
 
         return ProcessResult(document, rangeToReformat.grown(visitor.replaces.size))
     }
 
+    private fun trimLeadingWhitespaceAtFileHead(
+        document: Document,
+        source: PsiFile,
+        rangeToReformat: TextRange,
+    ) {
+        if (rangeToReformat.startOffset != 0) return
+        if (isInjectedSqlFile(source)) return
+
+        val chars = document.charsSequence
+        if (chars.isEmpty()) return
+
+        var start = 0
+        // Save Bom
+        if (chars[0] == '\uFEFF') start = 1
+
+        var i = start
+        while (i < chars.length) {
+            val c = chars[i]
+            if (c == ' ' || c == '\t' || c == '\r' || c == '\n') {
+                i++
+            } else {
+                break
+            }
+        }
+        if (i > start) {
+            document.deleteString(start, i)
+        }
+    }
+
     private fun processNonWhiteSpaceElement(
         current: PsiElement,
         document: Document,
@@ -145,7 +175,7 @@ class SqlFormatPreProcessor : PreFormatProcessor {
                 else -> getUpperText(current)
             }
 
-        return if (isFirstElementInFile(current)) getUpperText(current) else newKeyword
+        return newKeyword
     }
 
     private fun processKeyword(current: PsiElement): String {
@@ -164,11 +194,6 @@ class SqlFormatPreProcessor : PreFormatProcessor {
             getNewLineString(PsiTreeUtil.prevLeaf(current), getUpperText(current))
         }
 
-    private fun isFirstElementInFile(current: PsiElement): Boolean {
-        val prev = PsiTreeUtil.prevLeaf(current)
-        return prev == null || PsiTreeUtil.prevLeaf(prev) == null
-    }
-
     private fun removeSpacesAroundNewline(
         document: Document,
         element: PsiWhiteSpace,

src/test/testData/sql/formatter/BlockCommentParse.sql

@@ -1,8 +1,9 @@
-/*%! This is Parser Level Comment*/
+
+ /*%! This is Parser Level Comment*/
 select * from table1
 /*%!This is Parser Level Comment*/
 where column1 = /*# value1*/
 /*+
    * This is Block Comment
    */
-and column2 = /* value2 */ 'value2'     or column3 = /*^ value3 */ 'value3'
+and column2 = /* value2 */ 'value2' /** line break */    or column3 = /*^ value3 */ 'value3'

src/test/testData/sql/formatter/BlockCommentParse_format.sql

@@ -7,4 +7,5 @@ SELECT *
    * This is Block Comment
    */
    AND column2 = /* value2 */'value2'
+    /** line break */
     OR column3 = /*^ value3 */'value3'