chore: don't perform checks like missing description on deprecated bl…

…ocks closes #57
shreyashsaitwal · Jan 11, 2024 · d3d34b6 · d3d34b6
1 parent 9e307e8
commit d3d34b6
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/lib/src/commands/create/templates/intellij_files.dart b/lib/src/commands/create/templates/intellij_files.dart
@@ -68,7 +68,7 @@ $sources
 
 const String ijLocalDepsXml = '''
 <component name="libraryTable">
-    <library name="deps">
+    <library name="local-deps">
         <CLASSES>
             <root url="file://\$PROJECT_DIR\$/deps" />
         </CLASSES>

diff --git a/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Block.kt b/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Block.kt
@@ -49,7 +49,7 @@ abstract class Block(val element: ExecutableElement, val messager: Messager, val
     open fun runChecks() {
         val type = this::class.java.simpleName.toString()
 
-        if (!Utils.isPascalCase(name)) {
+        if (!Utils.isPascalCase(name) && !deprecated) {
             messager.printMessage(
                 Diagnostic.Kind.WARNING,
                 "$type should follow `PascalCase` naming convention.",

diff --git a/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Event.kt b/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Event.kt
@@ -43,7 +43,7 @@ class Event(
     override fun runChecks() {
         super.runChecks()
 
-        if (description.isBlank()) {
+        if (description.isBlank() && !deprecated) {
             messager.printMessage(Kind.WARNING, "Event has no description.", element)
         }
     }

diff --git a/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Function.kt b/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Function.kt
@@ -51,12 +51,12 @@ class Function(
     override fun runChecks() {
         super.runChecks()
 
-        if (description.isBlank()) {
+        if (description.isBlank() && !deprecated) {
             messager.printMessage(Kind.WARNING, "Function has no description.", element)
         }
 
         val continuations = params.filter { it.type == "continuation" }
-        if (continuations.size > 1) {
+        if (continuations.size > 1 && !deprecated) {
             messager.printMessage(
                 Kind.WARNING, "Function should not have more than one continuation parameter.", element
             )
@@ -66,7 +66,7 @@ class Function(
             if (typeArgs.isEmpty()) {
                 messager.printMessage(
                     Kind.ERROR,
-                    "Continuation parameter must be specialized with a type, like `Continuation<Boolean>`.",
+                    "Continuation parameter must be specialized with a type, for e.g. `Continuation<Boolean>`.",
                     element
                 )
             }

diff --git a/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Property.kt b/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Property.kt
@@ -36,7 +36,7 @@ class Property(
     override fun runChecks() {
         super.runChecks()
 
-        if (description.isBlank()) {
+        if (description.isBlank() && !deprecated) {
             messager.printMessage(Kind.WARNING, "Property has no description.", element)
         }