Feature. Ktlint rule wrapper #744
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package org.cqfn.diktat.ruleset.rules | ||
|
|
||
| import org.cqfn.diktat.common.config.rules.RulesConfig | ||
| import org.cqfn.diktat.common.config.rules.isRuleEnabled | ||
| import org.cqfn.diktat.ruleset.constants.EmitType | ||
| import org.cqfn.diktat.ruleset.utils.log | ||
|
|
||
| import com.pinterest.ktlint.core.Rule | ||
| import org.jetbrains.kotlin.com.intellij.lang.ASTNode | ||
| import kotlin.system.exitProcess | ||
|
|
||
| private typealias DiktatConfigRule = org.cqfn.diktat.common.config.rules.Rule | ||
|
|
||
| /** | ||
| * This is a wrapper around Ktlint Rule | ||
| * | ||
| * @param id id of the rule | ||
| * @property configRules all rules from configuration | ||
| * @property inspections warnings that are used in the rule's code | ||
| */ | ||
| @Suppress("TooGenericExceptionCaught") | ||
| abstract class DiktatRule(id: String, | ||
| val configRules: List<RulesConfig>, | ||
| val inspections: List<DiktatConfigRule>) : Rule(id) { | ||
| /** | ||
| * Default value is false | ||
| */ | ||
| var isFixMode: Boolean = false | ||
|
|
||
| /** | ||
| * Will be initialized in visit | ||
| */ | ||
| lateinit var emitWarn: EmitType | ||
|
|
||
| override fun visit(node: ASTNode, | ||
| autoCorrect: Boolean, | ||
| emit: EmitType) { | ||
| emitWarn = emit | ||
| isFixMode = autoCorrect | ||
|
|
||
| if (areInspectionsDisabled()) { | ||
| return | ||
| } else { | ||
| try { | ||
| logic(node) | ||
| } catch (internalError: Throwable) { | ||
| log.error("Internal error has occurred in $id. Please make an issue on this bug at https://github.com/cqfn/diKTat/.", internalError) | ||
| log.error("As a workaround you can disable these inspections in yml config: $inspections") | ||
| exitProcess(1) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun areInspectionsDisabled(): Boolean = | ||
| inspections.none { configRules.isRuleEnabled(it) } | ||
|
|
||
| /** | ||
| * Logic of the rule | ||
| * | ||
| * @param node node that are coming from visit | ||
| */ | ||
| abstract fun logic(node: ASTNode) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
damn, catching all exceptions? I do not know if it is a good idea, @petertrr think about this here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean, isn't this what we were trying to achieve? Otherwise these exceptions are caught by ktlint and they just log a warning as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am saying that simply doing catch (Exception e) is a bad practice. May be there are different types of exceptions in ktlint to handle BEFORE we will catch all remaining exeptions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything that is thrown from
rule.visitis catched in Ktlint.kt withcatch (e: Exception). So their idea is that the visitor either handles all exceptions, or they are considered internal errors.