refactor: rename comment linter

unit-mesh · Jan 8, 2024 · 940a7de · 940a7de
1 parent 6a7d163
commit 940a7de
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 12 deletions.
diff --git a/...mesh/quality/documentation/CodeComment.kt → ...c/unitmesh/quality/comment/CodeComment.kt b/...mesh/quality/documentation/CodeComment.kt → ...c/unitmesh/quality/comment/CodeComment.kt
@@ -1,4 +1,4 @@
-package cc.unitmesh.quality.documentation
+package cc.unitmesh.quality.comment
 
 import chapi.domain.core.CodePosition
 import kotlinx.serialization.Serializable

diff --git a/...ality/documentation/DocCommentAnalyser.kt → ...itmesh/quality/comment/CommentAnalyser.kt b/...ality/documentation/DocCommentAnalyser.kt → ...itmesh/quality/comment/CommentAnalyser.kt
@@ -1,10 +1,10 @@
-package cc.unitmesh.quality.documentation
+package cc.unitmesh.quality.comment
 
 import cc.unitmesh.quality.QualityAnalyser
 import chapi.domain.core.CodeDataStruct
 import org.archguard.rule.core.Issue
 
-class DocCommentAnalyser(comments: List<CodeComment>, thresholds: Map<String, Int>) : QualityAnalyser {
+class CommentAnalyser(comments: List<CodeComment>, thresholds: Map<String, Int>) : QualityAnalyser {
     override fun analysis(nodes: List<CodeDataStruct>): List<Issue> {
         return listOf()
     }

diff --git a/...esh/quality/documentation/rule/DocRule.kt → ...tmesh/quality/comment/rule/CommentRule.kt b/...esh/quality/documentation/rule/DocRule.kt → ...tmesh/quality/comment/rule/CommentRule.kt
@@ -1,12 +1,12 @@
-package cc.unitmesh.quality.documentation.rule
+package cc.unitmesh.quality.comment.rule
 
 import chapi.domain.core.CodeDataStruct
 import chapi.domain.core.CodeFunction
 import org.archguard.rule.core.IssueEmit
 import org.archguard.rule.core.Rule
 import org.archguard.rule.core.RuleContext
 
-open class DocRule : Rule() {
+open class CommentRule : Rule() {
     override fun visit(rootNode: Any, context: RuleContext, callback: IssueEmit) {
 
     }

diff --git a/...entation/rule/MissingParameterDescRule.kt → .../comment/rule/MissingParameterDescRule.kt b/...entation/rule/MissingParameterDescRule.kt → .../comment/rule/MissingParameterDescRule.kt
@@ -1,4 +1,4 @@
-package cc.unitmesh.quality.documentation.rule
+package cc.unitmesh.quality.comment.rule
 
 /**
  * Parse the documentation of the code and check whether the documentation is complete.
@@ -17,6 +17,6 @@ package cc.unitmesh.quality.documentation.rule
  *
  * We can use this rule to check whether the documentation is complete.
  */
-class MissingParameterDescRule: DocRule() {
+class MissingParameterDescRule: CommentRule() {
 
 }
diff --git a/.../quality/documentation/CodeCommentTest.kt → ...itmesh/quality/comment/CodeCommentTest.kt b/.../quality/documentation/CodeCommentTest.kt → ...itmesh/quality/comment/CodeCommentTest.kt
@@ -1,4 +1,4 @@
-package cc.unitmesh.quality.documentation
+package cc.unitmesh.quality.comment
 
 import chapi.domain.core.CodePosition
 import org.junit.jupiter.api.Assertions.assertEquals

diff --git a/unit-picker/src/main/kotlin/cc/unitmesh/pick/builder/comment/CommentsExtractor.kt b/unit-picker/src/main/kotlin/cc/unitmesh/pick/builder/comment/CommentsExtractor.kt
@@ -1,7 +1,7 @@
 package cc.unitmesh.pick.builder.comment
 
 import cc.unitmesh.core.SupportedLang
-import cc.unitmesh.quality.documentation.CodeComment
+import cc.unitmesh.quality.comment.CodeComment
 
 /**
  * Extracts the documentation comments (KDoc) from the given code.

diff --git a/unit-picker/src/main/kotlin/cc/unitmesh/pick/builder/comment/JvmCommentBuilder.kt b/unit-picker/src/main/kotlin/cc/unitmesh/pick/builder/comment/JvmCommentBuilder.kt
@@ -1,7 +1,7 @@
 package cc.unitmesh.pick.builder.comment
 
 import cc.unitmesh.core.SupportedLang
-import cc.unitmesh.quality.documentation.CodeComment
+import cc.unitmesh.quality.comment.CodeComment
 import cc.unitmesh.core.comment.CommentBuilder
 import cc.unitmesh.core.comment.DocCommentInstruction
 import cc.unitmesh.core.comment.TypedCommentIns

diff --git a/unit-picker/src/main/kotlin/cc/unitmesh/pick/builder/comment/ins/ClassCommentIns.kt b/unit-picker/src/main/kotlin/cc/unitmesh/pick/builder/comment/ins/ClassCommentIns.kt
@@ -1,7 +1,7 @@
 package cc.unitmesh.pick.builder.comment.ins
 
 import cc.unitmesh.core.Instruction
-import cc.unitmesh.quality.documentation.CodeComment
+import cc.unitmesh.quality.comment.CodeComment
 import cc.unitmesh.core.comment.CommentBuilderType
 import cc.unitmesh.core.comment.DocCommentInstruction
 import cc.unitmesh.core.comment.TypedCommentIns

diff --git a/unit-picker/src/main/kotlin/cc/unitmesh/pick/builder/comment/ins/MethodCommentIns.kt b/unit-picker/src/main/kotlin/cc/unitmesh/pick/builder/comment/ins/MethodCommentIns.kt
@@ -1,7 +1,7 @@
 package cc.unitmesh.pick.builder.comment.ins
 
 import cc.unitmesh.core.Instruction
-import cc.unitmesh.quality.documentation.CodeComment
+import cc.unitmesh.quality.comment.CodeComment
 import cc.unitmesh.core.comment.CommentBuilderType
 import cc.unitmesh.core.comment.DocCommentInstruction
 import cc.unitmesh.core.comment.TypedCommentIns