Replace @active KDoc tag with @ActiveByDefault annotation (#3592)

* Add @ActiveByDefault annotation

* Add support for @ActiveByDefault annotation

* Use annotation for all activated in v1.2.0

* Use annotation for all activated after v1.2.0

* Use annotation for all activated in v1.0.0

* Update documentation with regard to RuleSetProvider

* Update documentation

* Remove leading 'v' from version in annotation

* Use named parameter 'since' for @ActiveByDefault

* check version matches semantic version pattern.

* Fix typo and correct version format

* Fix merge errors

Co-authored-by: Markus Schwarz <post@markus-schwarz.net>
Co-authored-by: Chao Zhang <zhangchao6865@gmail.com>
This commit is contained in:
marschwar
2021-03-28 20:21:09 +02:00
committed by GitHub
parent 92b6a01903
commit 36edd4c528
145 changed files with 399 additions and 289 deletions

View File

@@ -7,6 +7,7 @@ import io.gitlab.arturbosch.detekt.api.Entity
import io.gitlab.arturbosch.detekt.api.Issue
import io.gitlab.arturbosch.detekt.api.Rule
import io.gitlab.arturbosch.detekt.api.Severity
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.RequiresTypeResolution
import org.jetbrains.kotlin.builtins.KotlinBuiltIns
import org.jetbrains.kotlin.builtins.PrimitiveType
@@ -39,10 +40,9 @@ import org.jetbrains.kotlin.resolve.descriptorUtil.fqNameOrNull
*
* fun returningFunction(): DoubleArray { }
* </compliant>
*
* @active since v1.2.0
*/
@RequiresTypeResolution
@ActiveByDefault(since = "1.2.0")
class ArrayPrimitive(config: Config = Config.empty) : Rule(config) {
override val issue = Issue(
"ArrayPrimitive",

View File

@@ -7,6 +7,7 @@ import io.gitlab.arturbosch.detekt.api.Entity
import io.gitlab.arturbosch.detekt.api.Issue
import io.gitlab.arturbosch.detekt.api.Rule
import io.gitlab.arturbosch.detekt.api.Severity
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.rules.getIntValueForPsiElement
import org.jetbrains.kotlin.com.intellij.psi.PsiElement
import org.jetbrains.kotlin.psi.KtBinaryExpression
@@ -40,9 +41,8 @@ import org.jetbrains.kotlin.psi.psiUtil.getReceiverExpression
* println(i)
* }
* </compliant>
*
* @active since v1.0.0
*/
@ActiveByDefault(since = "1.0.0")
class ForEachOnRange(config: Config = Config.empty) : Rule(config) {
override val issue = Issue(

View File

@@ -2,13 +2,13 @@ package io.gitlab.arturbosch.detekt.rules.performance
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.RuleSet
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.DefaultRuleSetProvider
/**
* The performance rule set analyzes code for potential performance problems.
*
* @active since v1.0.0
*/
@ActiveByDefault(since = "1.0.0")
class PerformanceProvider : DefaultRuleSetProvider {
override val ruleSetId: String = "performance"

View File

@@ -7,6 +7,7 @@ import io.gitlab.arturbosch.detekt.api.Entity
import io.gitlab.arturbosch.detekt.api.Issue
import io.gitlab.arturbosch.detekt.api.Rule
import io.gitlab.arturbosch.detekt.api.Severity
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import org.jetbrains.kotlin.descriptors.ConstructorDescriptor
import org.jetbrains.kotlin.descriptors.ParameterDescriptor
import org.jetbrains.kotlin.psi.KtNamedFunction
@@ -48,9 +49,8 @@ import org.jetbrains.kotlin.resolve.calls.components.isVararg
* strs.forEach { println(it) }
* }
* </compliant>
*
* @active since v1.0.0
*/
@ActiveByDefault(since = "1.0.0")
class SpreadOperator(config: Config = Config.empty) : Rule(config) {
override val issue: Issue = Issue(

View File

@@ -7,6 +7,7 @@ import io.gitlab.arturbosch.detekt.api.Entity
import io.gitlab.arturbosch.detekt.api.Issue
import io.gitlab.arturbosch.detekt.api.Rule
import io.gitlab.arturbosch.detekt.api.Severity
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import org.jetbrains.kotlin.com.intellij.psi.PsiElement
import org.jetbrains.kotlin.psi.KtCallExpression
import org.jetbrains.kotlin.psi.KtExpression
@@ -23,9 +24,8 @@ import org.jetbrains.kotlin.psi.KtExpression
* <compliant>
* val i = Integer.toString(1)
* </compliant>
*
* @active since v1.0.0
*/
@ActiveByDefault(since = "1.0.0")
class UnnecessaryTemporaryInstantiation(config: Config = Config.empty) : Rule(config) {
override val issue: Issue = Issue(