Suppress in individual files (#255)

### What's done: * Warn method remade * Added suppress check * Added tests * Added to README.md
saveourtool · Sep 15, 2020 · e60f271 · e60f271 · 0pdd · Sep 15, 2020
1 parent b2d6ac6
commit e60f271
Show file tree

Hide file tree

Showing 34 changed files with 321 additions and 127 deletions.
diff --git a/README.md b/README.md
@@ -196,6 +196,19 @@ Note, that you can specify and put `diktat-analysis.yml` that contains configura
 See default configuration in [diktat-analysis.yml](diktat-rules/src/main/resources/diktat-analysis.yml) \
 Also see [the list of all rules supported by diKTat](info/available-rules.md).
 
+## Suppress warnings on individual code blocks
+In addition to enabling/disabling warning globally via config file, you can suppress warnings by adding `@Suppress` annotation on individual code blocks
+
+For example:
+
+``` kotlin
+@Suppress("FUNCTION_NAME_INCORRECT_CASE")
+class SomeClass {
+    fun methODTREE(): String {
+
+    }
+}
+``` 
 ## How to contribute?
 
 Main components are:

diff --git a/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/constants/Warnings.kt b/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/constants/Warnings.kt
@@ -3,6 +3,8 @@ package org.cqfn.diktat.ruleset.constants
 import org.cqfn.diktat.common.config.rules.Rule
 import org.cqfn.diktat.common.config.rules.RulesConfig
 import org.cqfn.diktat.common.config.rules.isRuleEnabled
+import org.cqfn.diktat.ruleset.utils.hasSuppress
+import org.jetbrains.kotlin.com.intellij.lang.ASTNode
 
 /**
  * This class represent individual inspections of diktat code style.
@@ -104,27 +106,31 @@ enum class Warnings(private val canBeAutoCorrected: Boolean, private val warn: S
                    isFixMode: Boolean,
                    freeText: String,
                    offset: Int,
+                   node: ASTNode,
                    canBeAutoCorrected: Boolean = this.canBeAutoCorrected,
                    autoFix: () -> Unit) {
-        warn(configRules, emit, canBeAutoCorrected, freeText, offset)
-        fix(configRules, autoFix, isFixMode)
+        warn(configRules, emit, canBeAutoCorrected, freeText, offset, node)
+        fix(configRules, autoFix, isFixMode, node)
     }
 
+    @Suppress("LongParameterList")
     fun warn(configs: List<RulesConfig>,
              emit: ((offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit),
              autoCorrected: Boolean,
              freeText: String,
-             offset: Int) {
-        if (configs.isRuleEnabled(this)) {
+             offset: Int,
+             node: ASTNode) {
+
+        if (configs.isRuleEnabled(this) && !node.hasSuppress(name)) {
             emit(offset,
                     "${this.warnText()} $freeText",
                     autoCorrected
             )
         }
     }
 
-    private inline fun fix(configs: List<RulesConfig>, autoFix: () -> Unit, isFix: Boolean) {
-        if (configs.isRuleEnabled(this) && isFix) {
+    private inline fun fix(configs: List<RulesConfig>, autoFix: () -> Unit, isFix: Boolean, node: ASTNode) {
+        if (configs.isRuleEnabled(this) && isFix && !node.hasSuppress(name)) {
             autoFix()
         }
     }

diff --git a/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/AnnotationNewLineRule.kt b/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/AnnotationNewLineRule.kt
@@ -59,7 +59,7 @@ class AnnotationNewLineRule(private val configRules: List<RulesConfig>) : Rule("
 
     private fun deleteSpaces(node: ASTNode, rightSide: Boolean, leftSide: Boolean) {
         Warnings.ANNOTATION_NEW_LINE.warnAndFix(configRules, emitWarn, isFixMode, "${node.text} not on a single line",
-                node.startOffset) {
+                node.startOffset, node) {
             if (rightSide) {
                 if (node.treeNext?.isWhiteSpace() == true) {
                     node.removeChild(node.treeNext)

diff --git a/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/BlockStructureBraces.kt b/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/BlockStructureBraces.kt
@@ -157,7 +157,7 @@ class BlockStructureBraces(private val configRules: List<RulesConfig>) : Rule("b
         val braceSpace = nodeBefore?.treePrev
         if (braceSpace == null || checkBraceNode(braceSpace, true)) {
             BRACES_BLOCK_STRUCTURE_ERROR.warnAndFix(configRules, emitWarn, isFixMode, "incorrect newline before opening brace",
-                    (braceSpace ?: node).startOffset) {
+                    (braceSpace ?: node).startOffset, node) {
                 if (braceSpace == null || braceSpace.elementType != WHITE_SPACE) {
                     node.addChild(PsiWhiteSpaceImpl(" "), nodeBefore)
                 } else {
@@ -173,7 +173,7 @@ class BlockStructureBraces(private val configRules: List<RulesConfig>) : Rule("b
             node.findChildByType(beforeType) else node)?.findLBrace()?.treeNext ?: return
         if (checkBraceNode(newNode)) {
             BRACES_BLOCK_STRUCTURE_ERROR.warnAndFix(configRules, emitWarn, isFixMode, "incorrect same line after opening brace",
-                    newNode.startOffset) {
+                    newNode.startOffset, newNode) {
                 if (newNode.elementType != WHITE_SPACE) {
                     node.addChild(PsiWhiteSpaceImpl("\n"), newNode)
                 } else {
@@ -187,7 +187,7 @@ class BlockStructureBraces(private val configRules: List<RulesConfig>) : Rule("b
         allMiddleSpace.forEach {
             if (checkBraceNode(it, true)) {
                 BRACES_BLOCK_STRUCTURE_ERROR.warnAndFix(configRules, emitWarn, isFixMode, "incorrect new line after closing brace",
-                        it.startOffset) {
+                        it.startOffset, it) {
                     if (it.elementType != WHITE_SPACE) {
                         node.addChild(PsiWhiteSpaceImpl(" "), node.findChildByType(keyword))
                     } else {
@@ -203,7 +203,7 @@ class BlockStructureBraces(private val configRules: List<RulesConfig>) : Rule("b
         val space = node.findChildByType(RBRACE)!!.treePrev
         if (checkBraceNode(space))
             BRACES_BLOCK_STRUCTURE_ERROR.warnAndFix(configRules, emitWarn, isFixMode, "no newline before closing brace",
-                    (space.treeNext ?: node.findChildByType(RBRACE))!!.startOffset) {
+                    (space.treeNext ?: node.findChildByType(RBRACE))!!.startOffset, node) {
                 if (space.elementType != WHITE_SPACE) {
                     node.addChild(PsiWhiteSpaceImpl("\n"), node.findChildByType(RBRACE))
                 } else {

diff --git a/...t-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/BracesInConditionalsAndLoopsRule.kt b/...t-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/BracesInConditionalsAndLoopsRule.kt
@@ -69,7 +69,7 @@ class BracesInConditionalsAndLoopsRule(private val configRules: List<RulesConfig
 
         if (thenNode?.elementType != BLOCK) {
             NO_BRACES_IN_CONDITIONALS_AND_LOOPS.warnAndFix(configRules, emitWarn, isFixMode, "IF",
-                    (thenNode?.prevSibling { it.elementType == IF_KEYWORD } ?: node).startOffset) {
+                    (thenNode?.prevSibling { it.elementType == IF_KEYWORD } ?: node).startOffset, node) {
                 if (thenNode != null) {
                     ifPsi.then!!.replaceWithBlock(indent)
                     if (elseNode != null) {
@@ -84,7 +84,7 @@ class BracesInConditionalsAndLoopsRule(private val configRules: List<RulesConfig
 
         if (hasElseBranch && elseNode?.elementType != IF && elseNode?.elementType != BLOCK) {
             NO_BRACES_IN_CONDITIONALS_AND_LOOPS.warnAndFix(configRules, emitWarn, isFixMode, "ELSE",
-                    (elseNode?.treeParent?.prevSibling { it.elementType == ELSE_KEYWORD } ?: node).startOffset) {
+                    (elseNode?.treeParent?.prevSibling { it.elementType == ELSE_KEYWORD } ?: node).startOffset, node) {
                 if (elseNode != null) {
                     ifPsi.`else`!!.replaceWithBlock(indent)
                 } else {
@@ -99,7 +99,7 @@ class BracesInConditionalsAndLoopsRule(private val configRules: List<RulesConfig
         val loopBody = (node.psi as KtLoopExpression).body
         val loopBodyNode = loopBody?.node
         if (loopBodyNode == null || loopBodyNode.elementType != BLOCK) {
-            NO_BRACES_IN_CONDITIONALS_AND_LOOPS.warnAndFix(configRules, emitWarn, isFixMode, node.elementType.toString(), node.startOffset) {
+            NO_BRACES_IN_CONDITIONALS_AND_LOOPS.warnAndFix(configRules, emitWarn, isFixMode, node.elementType.toString(), node.startOffset, node) {
                 // fixme proper way to calculate indent? or get step size (instead of hardcoded 4)
                 val indent = node.prevSibling { it.elementType == WHITE_SPACE }!!.text.lines().last().count { it == ' ' }
                 if (loopBody != null) {
@@ -122,7 +122,7 @@ class BracesInConditionalsAndLoopsRule(private val configRules: List<RulesConfig
                 .map { it.expression as KtBlockExpression }
                 .filter { it.statements.size == 1 }
                 .forEach {
-                    NO_BRACES_IN_CONDITIONALS_AND_LOOPS.warnAndFix(configRules, emitWarn, isFixMode, "WHEN", it.node.startOffset) {
+                    NO_BRACES_IN_CONDITIONALS_AND_LOOPS.warnAndFix(configRules, emitWarn, isFixMode, "WHEN", it.node.startOffset, it.node) {
                         it.astReplace(it.firstStatement!!.node.psi)
                     }
                 }

diff --git a/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/ClassLikeStructuresOrderRule.kt b/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/ClassLikeStructuresOrderRule.kt
@@ -81,7 +81,7 @@ class ClassLikeStructuresOrderRule(private val configRules: List<RulesConfig>) :
                 unusedClasses)
 
         blocks.allBlockFlattened().reversed().handleIncorrectOrder(blocks::getSiblingBlocks) { astNode, beforeThisNode ->
-            WRONG_ORDER_IN_CLASS_LIKE_STRUCTURES.warnAndFix(configRules, emitWarn, isFixMode, astNode.elementType.toString() + ": " + astNode.text, astNode.startOffset) {
+            WRONG_ORDER_IN_CLASS_LIKE_STRUCTURES.warnAndFix(configRules, emitWarn, isFixMode, astNode.elementType.toString() + ": " + astNode.text, astNode.startOffset, astNode) {
                 val replacement = node.moveChildBefore(astNode, beforeThisNode, true)
                 replacement.oldNodes.forEachIndexed { idx, oldNode ->
                     blocks.allBlocks().find { oldNode in it }?.apply {
@@ -100,7 +100,7 @@ class ClassLikeStructuresOrderRule(private val configRules: List<RulesConfig>) :
             val whiteSpaceBefore = previousProperty.nextSibling { it.elementType == WHITE_SPACE }!!
             val nRequiredNewLines = if (commentOnThis == null) 1 else 2
             if (whiteSpaceBefore.text.count { it == '\n' } != nRequiredNewLines)
-                BLANK_LINE_BETWEEN_PROPERTIES.warnAndFix(configRules, emitWarn, isFixMode, node.getIdentifierName()!!.text, node.startOffset) {
+                BLANK_LINE_BETWEEN_PROPERTIES.warnAndFix(configRules, emitWarn, isFixMode, node.getIdentifierName()!!.text, node.startOffset, node) {
                     whiteSpaceBefore.leaveExactlyNumNewLines(nRequiredNewLines)
                 }
         }

diff --git a/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/ConsecutiveSpacesRule.kt b/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/ConsecutiveSpacesRule.kt
@@ -65,7 +65,7 @@ class ConsecutiveSpacesRule(private val configRules: List<RulesConfig>) : Rule("
         if (spaces > configuration.numberOfSpaces && !node.isWhiteSpaceWithNewline()
                 && !node.hasEolComment()) {
             TOO_MANY_CONSECUTIVE_SPACES.warnAndFix(configRules, emitWarn, isFixMode,
-                    "found: $spaces. need to be: ${configuration.numberOfSpaces}", node.startOffset) {
+                    "found: $spaces. need to be: ${configuration.numberOfSpaces}", node.startOffset, node) {
                 node.squeezeSpaces()
             }
         }

diff --git a/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/EmptyBlock.kt b/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/EmptyBlock.kt
@@ -41,21 +41,22 @@ class EmptyBlock(private val configRules: List<RulesConfig>) : Rule("empty-block
         if (node.isBlockEmpty()) {
             if (!configuration.emptyBlockExist) {
                 EMPTY_BLOCK_STRUCTURE_ERROR.warn(configRules, emitWarn, isFixMode, "empty blocks are forbidden unless it is function with override keyword",
-                        node.startOffset)
+                        node.startOffset, node)
             } else {
                 val space = node.findChildByType(RBRACE)!!.treePrev
                 if (configuration.emptyBlockNewline && !space.text.contains("\n")) {
                     EMPTY_BLOCK_STRUCTURE_ERROR.warnAndFix(configRules, emitWarn, isFixMode, "different style for empty block",
-                            node.startOffset) {
+                            node.startOffset, node) {
                         if (space.elementType == WHITE_SPACE) {
                             (space.treeNext as LeafPsiElement).replaceWithText("\n")
-                        } else {
+                        }
+                        else {
                             node.addChild(PsiWhiteSpaceImpl("\n"), space.treeNext)
                         }
                     }
                 } else if (!configuration.emptyBlockNewline && space.text.contains("\n")) {
                     EMPTY_BLOCK_STRUCTURE_ERROR.warnAndFix(configRules, emitWarn, isFixMode, "different style for empty block",
-                            node.startOffset) {
+                            node.startOffset, node) {
                         node.removeChild(space)
                     }
                 }

diff --git a/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/EnumsSeparated.kt b/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/EnumsSeparated.kt
@@ -51,7 +51,7 @@ class EnumsSeparated(private val configRules: List<RulesConfig>) : Rule("enum-se
         enumEntries.forEach {
             if (!it.treeNext.isWhiteSpaceWithNewline())
                 ENUMS_SEPARATED.warnAndFix(configRules, emitWarn, isFixMode, "enum entries must end with a line break",
-                        it.startOffset) {
+                        it.startOffset, it) {
                     it.appendNewlineMergingWhiteSpace(it.treeNext, it.treeNext)
                 }
         }
@@ -72,19 +72,19 @@ class EnumsSeparated(private val configRules: List<RulesConfig>) : Rule("enum-se
     private fun checkLastEnum(node: ASTNode) {
         if (!node.hasChildOfType(SEMICOLON)) {
             ENUMS_SEPARATED.warnAndFix(configRules, emitWarn, isFixMode, "enums must end with semicolon",
-                    node.startOffset) {
+                    node.startOffset, node) {
                 node.addChild(LeafPsiElement(SEMICOLON, ";"), null)
                 node.addChild(PsiWhiteSpaceImpl("\n"), node.findChildByType(SEMICOLON)!!)
             }
         } else if (!node.findChildByType(SEMICOLON)!!.treePrev.isWhiteSpaceWithNewline()) {
             ENUMS_SEPARATED.warnAndFix(configRules, emitWarn, isFixMode, "semicolon must be on a new line",
-                    node.startOffset) {
+                    node.startOffset, node) {
                 node.appendNewlineMergingWhiteSpace(node.findChildByType(SEMICOLON)!!, node.findChildByType(SEMICOLON)!!)
             }
         }
         if (!node.hasChildOfType(COMMA)) {
             ENUMS_SEPARATED.warnAndFix(configRules, emitWarn, isFixMode, "last enum entry must end with a comma",
-                    node.startOffset) {
+                    node.startOffset, node) {
                 node.addChild(LeafPsiElement(COMMA, ","), node.findChildByType(SEMICOLON)!!.treePrev)
             }
         }

diff --git a/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/FileNaming.kt b/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/FileNaming.kt
@@ -42,16 +42,16 @@ class FileNaming(private val configRules: List<RulesConfig>) : Rule("file-naming
 
         if (node.elementType == FILE) {
             fileName = node.getUserData(KtLint.FILE_PATH_USER_DATA_KEY)!!
-            checkFileNaming()
+            checkFileNaming(node)
             checkClassNameMatchesWithFile(node)
         }
     }
 
-    private fun checkFileNaming() {
+    private fun checkFileNaming(node: ASTNode) {
         if (fileName != null) {
             val (name, extension) = getFileParts()
             if (!name.isPascalCase() || !VALID_EXTENSIONS.contains(extension)) {
-                FILE_NAME_INCORRECT.warnAndFix(configRules, emitWarn, isFixMode, "$name$extension", 0) {
+                FILE_NAME_INCORRECT.warnAndFix(configRules, emitWarn, isFixMode, "$name$extension", 0, node) {
                     // FixMe: we can add an autocorrect here in future, but is there any purpose to change file or class name?
                 }
             }
@@ -65,7 +65,7 @@ class FileNaming(private val configRules: List<RulesConfig>) : Rule("file-naming
             if (classes.size == 1) {
                 val className = classes[0].getFirstChildWithType(IDENTIFIER)!!.text
                 if (className != fileNameWithoutSuffix) {
-                    FILE_NAME_MATCH_CLASS.warnAndFix(configRules, emitWarn, isFixMode, "$fileNameWithoutSuffix$fileNameSuffix vs $className", 0) {
+                    FILE_NAME_MATCH_CLASS.warnAndFix(configRules, emitWarn, isFixMode, "$fileNameWithoutSuffix$fileNameSuffix vs $className", 0, fileLevelNode) {
 
                         // FixMe: we can add an autocorrect here in future, but is there any purpose to change file name?
                     }