Turn on more detekt rules (#3272)

Author: rli

buildSrc/src/main/kotlin/toolkit-detekt.gradle.kts

@@ -17,7 +17,7 @@ dependencies {
 detekt {
     val rulesProject = project(":detekt-rules").projectDir
     source.setFrom("$projectDir")
-    buildUponDefaultConfig = false
+    buildUponDefaultConfig = true
     parallel = true
     allRules = false
     config = files("$rulesProject/detekt.yml")

core/detekt-baseline-main.xml

@@ -1,5 +1,11 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <SmellBaseline>
   <ManuallySuppressedIssues/>
-  <CurrentIssues/>
+  <CurrentIssues>
+    <ID>UseCheckOrError:LambdaRuntime.kt$LambdaRuntime$throw IllegalStateException("LambdaRuntime has no runtime or override string")</ID>
+    <ID>UseCheckOrError:ToolkitRegionProvider.kt$ToolkitRegionProvider$throw IllegalStateException("$serviceId in ${region.partitionId} lacks a partitionEndpoint")</ID>
+    <ID>UseCheckOrError:ToolkitRegionProvider.kt$ToolkitRegionProvider$throw IllegalStateException("$serviceId is not global in ${region.partitionId}")</ID>
+    <ID>UseCheckOrError:ToolkitRegionProvider.kt$ToolkitRegionProvider$throw IllegalStateException("Partition data is missing for ${region.partitionId}")</ID>
+    <ID>UseCheckOrError:ToolkitRegionProvider.kt$ToolkitRegionProvider$throw IllegalStateException("Unknown service $serviceId in ${region.partitionId}")</ID>
+  </CurrentIssues>
 </SmellBaseline>

core/detekt-baseline.xml

@@ -1,7 +1,11 @@
-<?xml version="1.0" ?>
+<?xml version='1.0' encoding='UTF-8'?>
 <SmellBaseline>
-  <ManuallySuppressedIssues></ManuallySuppressedIssues>
+  <ManuallySuppressedIssues/>
   <CurrentIssues>
-    <ID>AbsentOrWrongFileLicense:ExceptionUtils.kt$software.aws.toolkits.core.utils.ExceptionUtils.kt</ID>
+    <ID>UseCheckOrError:LambdaRuntime.kt$LambdaRuntime$throw IllegalStateException("LambdaRuntime has no runtime or override string")</ID>
+    <ID>UseCheckOrError:ToolkitRegionProvider.kt$ToolkitRegionProvider$throw IllegalStateException("$serviceId in ${region.partitionId} lacks a partitionEndpoint")</ID>
+    <ID>UseCheckOrError:ToolkitRegionProvider.kt$ToolkitRegionProvider$throw IllegalStateException("$serviceId is not global in ${region.partitionId}")</ID>
+    <ID>UseCheckOrError:ToolkitRegionProvider.kt$ToolkitRegionProvider$throw IllegalStateException("Partition data is missing for ${region.partitionId}")</ID>
+    <ID>UseCheckOrError:ToolkitRegionProvider.kt$ToolkitRegionProvider$throw IllegalStateException("Unknown service $serviceId in ${region.partitionId}")</ID>
   </CurrentIssues>
 </SmellBaseline>

core/tst/software/aws/toolkits/core/utils/LogUtilsTest.kt

@@ -175,5 +175,6 @@ class LogUtilsTest {
         "hello"
     }
 
+    @Suppress("FunctionOnlyReturningConstant")
     private fun willNeverBeNull(): String = "hello"
 }

detekt-rules/detekt.yml

@@ -27,6 +27,9 @@ comments:
     licenseTemplateFile: ./license.template
     licenseTemplateIsRegex: true
 
+complexity:
+  active: false
+
 coroutines:
   active: true
   GlobalCoroutineUsage:
@@ -38,6 +41,14 @@ coroutines:
   SuspendFunWithFlowReturnType:
     active: true
 
+empty-blocks:
+  EmptyFunctionBlock:
+    active: false
+
+exceptions:
+  # there might actually be some useful rules in here
+  active: false
+
 # unfortunately, does not respect .editorconfig in the project folder
 # also needs to be manually updated if there are new rules upstream
 formatting:
@@ -201,6 +212,11 @@ naming:
     parameterPattern: '[a-z][A-Za-z0-9]*'
     excludeClassPattern: '$^'
     ignoreOverridden: true
+  # prefer rule provided by ktlint
+  MatchingDeclarationName:
+    active: false
+  MemberNameEqualsClassName:
+    active: false
   NoNameShadowing:
     active: true
   ObjectPropertyNaming:
@@ -223,6 +239,10 @@ naming:
     excludeClassPattern: '$^'
     ignoreOverridden: true
 
+performance:
+  SpreadOperator:
+    active: false
+
 potential-bugs:
   active: true
   CastToNullableType:
@@ -287,22 +307,25 @@ potential-bugs:
     active: true
 
 style:
-  EqualsNullCall:
-    active: true
   ExpressionBodySyntax:
     active: true
     includeLineWrapping: true
-  MayBeConst:
-    active: true
-  ModifierOrder:
-    active: true
+  ForbiddenComment:
+    active: false
+  MagicNumber:
+    active: false
+  # prefer rule provided by ktlint in the formatting section
+  MaxLineLength:
+    active: false
   NoTabs:
     active: true
-  OptionalAbstractKeyword:
-    active: true
-  SafeCast:
-    active: true
-  UnusedPrivateClass:
-    active: true
+  ReturnCount:
+    active: false
+  ThrowsCount:
+    active: false
+  UnnecessaryAbstractClass:
+    active: false
+  UnusedPrivateMember:
+    allowedNames: '(_|ignored|expected|serialVersionUID|createUIComponents)'
   VarCouldBeVal:
     active: false

gradle/libs.versions.toml

@@ -3,7 +3,7 @@ apacheCommons = "2.8.0"
 assertJ = "3.20.2" # Upgrading leads to SAM errors: https://youtrack.jetbrains.com/issue/KT-17765
 awsSdk = "2.17.219"
 commonmark = "0.17.1"
-detekt = "1.20.0"
+detekt = "1.21.0"
 intellijGradle = "1.7.0"
 intellijRemoteRobot = "0.11.14"
 jackson = "2.13.3"

jetbrains-core/detekt-baseline-integrationTest.xml

@@ -1,6 +1,6 @@
-<?xml version="1.0" ?>
+<?xml version='1.0' encoding='UTF-8'?>
 <SmellBaseline>
-  <ManuallySuppressedIssues></ManuallySuppressedIssues>
+  <ManuallySuppressedIssues/>
   <CurrentIssues>
     <ID>UnsafeCallOnNullableType:CreateFunctionIntegrationTest.kt$CreateFunctionIntegrationTest$AwsRegionProvider.getInstance()[Region.US_WEST_2.id()]!!</ID>
     <ID>UnsafeCallOnNullableType:EcrPullIntegrationTest.kt$EcrPullIntegrationTest$dockerAdapter.buildLocalImage(dockerfile)!!</ID>
@@ -11,7 +11,6 @@
     <ID>UnsafeCallOnNullableType:JavaAwsConnectionExtensionIntegrationTest.kt$JavaAwsConnectionExtensionIntegrationTest$LocalFileSystem.getInstance().refreshAndFindFileByPath(jdkHome)!!</ID>
     <ID>UnsafeCallOnNullableType:JavaAwsConnectionExtensionIntegrationTest.kt$JavaAwsConnectionExtensionIntegrationTest$SdkConfigurationUtil.setupSdk(emptyArray(), jdkHomeDir, JavaSdk.getInstance(), false, null, jdkName)!!</ID>
     <ID>UnsafeCallOnNullableType:JavaLocalLambdaRunConfigurationIntegrationTest.kt$JavaLocalLambdaRunConfigurationIntegrationTest$projectRule.fixture.tempDirFixture.createFile("tmp", "\"Hello World\"").canonicalPath!!</ID>
-    <ID>UnsafeCallOnNullableType:PythonAwsConnectionExtensionIntegrationTest.kt$PythonAwsConnectionExtensionIntegrationTest$detectSystemWideSdks(null, emptyList()).first().homePath!!</ID>
     <ID>UnsafeCallOnNullableType:PythonLocalLambdaRunConfigurationIntegrationTest.kt$PythonLocalLambdaRunConfigurationIntegrationTest$FileDocumentManager.getInstance().getDocument(lambdaClass.virtualFile)!!</ID>
     <ID>UnsafeCallOnNullableType:PythonLocalLambdaRunConfigurationIntegrationTest.kt$PythonLocalLambdaRunConfigurationIntegrationTest$LambdaRuntime.fromValue(runtime)!!</ID>
     <ID>UnsafeCallOnNullableType:PythonLocalLambdaRunConfigurationIntegrationTest.kt$PythonLocalLambdaRunConfigurationIntegrationTest$projectRule.fixture.tempDirFixture.createFile("tmp", "Hello World").canonicalPath!!</ID>