Merge pull request #13635 from woocommerce/13634-woo-pos-it-seems-tha…

…t-custom-detekt-rules-work-on-the-code-outside-of-woopos-package

[Woo POS] Custom detekt rules work on the code outside of woopos package

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/common/composeui/component/WooPosButtons.kt

@@ -1,3 +1,5 @@
+@file:Suppress("WooPosDesignSystemButtonUsageRule")
+
 package com.woocommerce.android.ui.woopos.common.composeui.component
 
 import androidx.compose.foundation.BorderStroke

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/woopos/common/composeui/component/WooPosTexts.kt

@@ -1,3 +1,5 @@
+@file:Suppress("WooPosDesignSystemTextUsageRule")
+
 package com.woocommerce.android.ui.woopos.common.composeui.component
 
 import androidx.compose.material3.Text

libs/detektrules/src/main/kotlin/com/woocommerce/android/detektrules/woopos/WooPosBaseDetektRule.kt

@@ -0,0 +1,15 @@
+package com.woocommerce.android.detektrules.woopos
+
+import io.gitlab.arturbosch.detekt.api.Config
+import io.gitlab.arturbosch.detekt.api.Rule
+import org.jetbrains.kotlin.psi.KtFile
+
+abstract class WooPosBaseDetektRule(config: Config) : Rule(config) {
+    private val targetPackagePrefix = "com.woocommerce.android.ui.woopos"
+
+    override fun visitKtFile(file: KtFile) {
+        if (file.packageFqName.asString().startsWith(targetPackagePrefix)) {
+            super.visitKtFile(file)
+        }
+    }
+}

libs/detektrules/src/main/kotlin/com/woocommerce/android/detektrules/woopos/WooPosDesignSystemButtonUsageRule.kt

@@ -5,16 +5,12 @@ import io.gitlab.arturbosch.detekt.api.Config
 import io.gitlab.arturbosch.detekt.api.Debt
 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 org.jetbrains.kotlin.psi.KtCallExpression
 import org.jetbrains.kotlin.psi.KtDotQualifiedExpression
-import org.jetbrains.kotlin.psi.KtFile
 import org.jetbrains.kotlin.psi.KtNameReferenceExpression
 
-class WooPosDesignSystemButtonUsageRule(config: Config) : Rule(config) {
-    private val allowedPackagePrefix = "com.woocommerce.android.ui.woopos.common.composeui.component"
-
+class WooPosDesignSystemButtonUsageRule(config: Config) : WooPosBaseDetektRule(config) {
     private val disallowedButtonNames = setOf("Button")
 
     override val issue = Issue(
@@ -24,13 +20,6 @@ class WooPosDesignSystemButtonUsageRule(config: Config) : Rule(config) {
         Debt.FIVE_MINS
     )
 
-    override fun visitKtFile(file: KtFile) {
-        if (file.packageFqName.asString().startsWith(allowedPackagePrefix)) {
-            return
-        }
-        super.visitKtFile(file)
-    }
-
     override fun visitCallExpression(expression: KtCallExpression) {
         super.visitCallExpression(expression)
 

libs/detektrules/src/main/kotlin/com/woocommerce/android/detektrules/woopos/WooPosDesignSystemColorUsageRule.kt

@@ -5,14 +5,11 @@ import io.gitlab.arturbosch.detekt.api.Config
 import io.gitlab.arturbosch.detekt.api.Debt
 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 org.jetbrains.kotlin.com.intellij.psi.PsiElement
 import org.jetbrains.kotlin.psi.KtCallExpression
-import org.jetbrains.kotlin.psi.KtFile
 
-class WooPosDesignSystemColorUsageRule(config: Config) : Rule(config) {
-    private val targetPackagePrefix = "com.woocommerce.android.ui.woopos"
+class WooPosDesignSystemColorUsageRule(config: Config) : WooPosBaseDetektRule(config) {
     private val allowedColorSources = listOf("MaterialTheme.colorScheme", "WooPosTheme.colors")
     private val colorArguments = setOf(
         "background",
@@ -32,12 +29,6 @@ class WooPosDesignSystemColorUsageRule(config: Config) : Rule(config) {
         Debt.FIVE_MINS
     )
 
-    override fun visitKtFile(file: KtFile) {
-        if (file.packageFqName.asString().startsWith(targetPackagePrefix)) {
-            super.visitKtFile(file)
-        }
-    }
-
     override fun visitCallExpression(expression: KtCallExpression) {
         super.visitCallExpression(expression)
         expression.valueArguments.forEach { argument ->

libs/detektrules/src/main/kotlin/com/woocommerce/android/detektrules/woopos/WooPosDesignSystemCornerRadiusUsageRule.kt

@@ -5,14 +5,11 @@ import io.gitlab.arturbosch.detekt.api.Config
 import io.gitlab.arturbosch.detekt.api.Debt
 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 org.jetbrains.kotlin.psi.KtCallExpression
-import org.jetbrains.kotlin.psi.KtFile
 import org.jetbrains.kotlin.psi.KtNameReferenceExpression
 
-class WooPosDesignSystemCornerRadiusUsageRule(config: Config) : Rule(config) {
-    private val targetPackagePrefix = "com.woocommerce.android.ui.woopos"
+class WooPosDesignSystemCornerRadiusUsageRule(config: Config) : WooPosBaseDetektRule(config) {
     private val cornerRadiusFile = "WooPosCornerRadius"
 
     override val issue = Issue(
@@ -22,12 +19,6 @@ class WooPosDesignSystemCornerRadiusUsageRule(config: Config) : Rule(config) {
         Debt.FIVE_MINS
     )
 
-    override fun visitKtFile(file: KtFile) {
-        if (file.packageFqName.asString().startsWith(targetPackagePrefix)) {
-            super.visitKtFile(file)
-        }
-    }
-
     override fun visitCallExpression(expression: KtCallExpression) {
         super.visitCallExpression(expression)
 

libs/detektrules/src/main/kotlin/com/woocommerce/android/detektrules/woopos/WooPosDesignSystemSpacingUsageRule.kt

@@ -5,14 +5,11 @@ import io.gitlab.arturbosch.detekt.api.Config
 import io.gitlab.arturbosch.detekt.api.Debt
 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 org.jetbrains.kotlin.psi.KtCallExpression
-import org.jetbrains.kotlin.psi.KtFile
 import org.jetbrains.kotlin.psi.KtNameReferenceExpression
 
-class WooPosDesignSystemSpacingUsageRule(config: Config) : Rule(config) {
-    private val targetPackagePrefix = "com.woocommerce.android.ui.woopos"
+class WooPosDesignSystemSpacingUsageRule(config: Config) : WooPosBaseDetektRule(config) {
     private val dpRegex = Regex("\\d+\\.dp")
     private val dpWordRegex = Regex("\\b\\d+\\.dp\\b")
 
@@ -23,11 +20,6 @@ class WooPosDesignSystemSpacingUsageRule(config: Config) : Rule(config) {
         Debt.FIVE_MINS
     )
 
-    override fun visitKtFile(file: KtFile) {
-        if (!file.packageFqName.asString().startsWith(targetPackagePrefix)) return
-        super.visitKtFile(file)
-    }
-
     override fun visitCallExpression(expression: KtCallExpression) {
         super.visitCallExpression(expression)
         val callName = (expression.calleeExpression as? KtNameReferenceExpression)?.getReferencedName() ?: return

libs/detektrules/src/main/kotlin/com/woocommerce/android/detektrules/woopos/WooPosDesignSystemTextUsageRule.kt

@@ -5,30 +5,19 @@ import io.gitlab.arturbosch.detekt.api.Config
 import io.gitlab.arturbosch.detekt.api.Debt
 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 org.jetbrains.kotlin.psi.KtCallExpression
 import org.jetbrains.kotlin.psi.KtDotQualifiedExpression
-import org.jetbrains.kotlin.psi.KtFile
 import org.jetbrains.kotlin.psi.KtNameReferenceExpression
 
-class WooPosDesignSystemTextUsageRule(config: Config) : Rule(config) {
-    private val allowedPackagePrefix = "com.woocommerce.android.ui.woopos.common.composeui.component"
-
+class WooPosDesignSystemTextUsageRule(config: Config) : WooPosBaseDetektRule(config) {
     override val issue = Issue(
         javaClass.simpleName,
         Severity.Style,
         "Standard Compose Text should not be used. Use WooPosText instead.",
         Debt.FIVE_MINS
     )
 
-    override fun visitKtFile(file: KtFile) {
-        if (file.packageFqName.asString().startsWith(allowedPackagePrefix)) {
-            return
-        }
-        super.visitKtFile(file)
-    }
-
     override fun visitCallExpression(expression: KtCallExpression) {
         super.visitCallExpression(expression)