refactor: introduce a FOOTER_SEPARATOR lexer token type

Author: lppedd

src/main/kotlin/com/github/lppedd/cc/editor/CommitTabAction.kt

@@ -56,7 +56,10 @@ internal class CommitTabAction : TabAction() {
         ) {
           editor.putUserData(moveCaretKey, 1)
           return true
-        } else if (elementAtCaret is ConventionalCommitSeparatorPsiElement) {
+        } else if (
+          elementAtCaret is ConventionalCommitSeparatorPsiElement ||
+          elementAtCaret is ConventionalCommitFooterSeparatorPsiElement
+        ) {
           // Let's find where the subject/footer value text begins,
           // or just place the cursor at the right place if it doesn't exist yet
           val nextSibling = elementAtCaret.nextSibling

src/main/kotlin/com/github/lppedd/cc/language/lexer/ConventionalCommitTokenType.kt

@@ -18,6 +18,7 @@ public class ConventionalCommitTokenType(debugName: String) : IElementType(debug
     @JvmField public val BODY: IElementType = ConventionalCommitTokenType("BODY")
     @JvmField public val FOOTER_TYPE: IElementType = ConventionalCommitTokenType("FOOTER_TYPE")
     @JvmField public val FOOTER_TYPE_BREAKING_CHANGE: IElementType = ConventionalCommitTokenType("FOOTER_TYPE_BREAKING_CHANGE")
+    @JvmField public val FOOTER_SEPARATOR: IElementType = ConventionalCommitTokenType("FOOTER_SEPARATOR")
     @JvmField public val FOOTER_VALUE: IElementType = ConventionalCommitTokenType("FOOTER_VALUE")
   }
 }

src/main/kotlin/com/github/lppedd/cc/language/lexer/conventionalCommit.flex

@@ -177,7 +177,7 @@ FooterType  = [^:\s]+ | BREAKING\ CHANGE
 
       : {
         yybegin(FOOTER_VALUE);
-        return ConventionalCommitTokenType.SEPARATOR;
+        return ConventionalCommitTokenType.FOOTER_SEPARATOR;
       }
 }
 

src/main/kotlin/com/github/lppedd/cc/language/parser/ConventionalCommitASTFactory.kt

@@ -2,6 +2,7 @@ package com.github.lppedd.cc.language.parser
 
 import com.github.lppedd.cc.language.lexer.ConventionalCommitTokenType.Companion.BODY
 import com.github.lppedd.cc.language.lexer.ConventionalCommitTokenType.Companion.BREAKING_CHANGE
+import com.github.lppedd.cc.language.lexer.ConventionalCommitTokenType.Companion.FOOTER_SEPARATOR
 import com.github.lppedd.cc.language.lexer.ConventionalCommitTokenType.Companion.FOOTER_TYPE
 import com.github.lppedd.cc.language.lexer.ConventionalCommitTokenType.Companion.FOOTER_TYPE_BREAKING_CHANGE
 import com.github.lppedd.cc.language.lexer.ConventionalCommitTokenType.Companion.FOOTER_VALUE
@@ -34,6 +35,7 @@ internal class ConventionalCommitASTFactory : ASTFactory() {
     tokensMap[BODY] = ::ConventionalCommitBodyPsiElement
     tokensMap[FOOTER_TYPE] = ::ConventionalCommitFooterTypePsiElement
     tokensMap[FOOTER_TYPE_BREAKING_CHANGE] = ::ConventionalCommitFooterTypePsiElement
+    tokensMap[FOOTER_SEPARATOR] = ::ConventionalCommitFooterSeparatorPsiElement
     tokensMap[FOOTER_VALUE] = ::ConventionalCommitFooterValuePsiElement
   }
 

src/main/kotlin/com/github/lppedd/cc/language/parser/ConventionalCommitPsiParser.kt

@@ -48,7 +48,7 @@ internal class ConventionalCommitPsiParser : PsiParser {
     val marker = builder.mark()
     var token = builder.advanceAndGet()
 
-    if (token == ConventionalCommitTokenType.SEPARATOR) {
+    if (token == ConventionalCommitTokenType.FOOTER_SEPARATOR) {
       token = builder.advanceAndGet()
     }
 

src/main/kotlin/com/github/lppedd/cc/language/psi/ConventionalCommitFooterSeparatorPsiElement.kt

@@ -0,0 +1,15 @@
+package com.github.lppedd.cc.language.psi
+
+import com.intellij.psi.impl.source.tree.LeafPsiElement
+import com.intellij.psi.tree.IElementType
+
+/**
+ * @author Edoardo Luppi
+ */
+public class ConventionalCommitFooterSeparatorPsiElement(
+  type: IElementType,
+  text: CharSequence,
+) : LeafPsiElement(type, text) {
+  override fun toString(): String =
+    "ConventionalCommitFooterSeparatorPsiElement"
+}