Custom Rules never called #5047

methob · 2022-07-07T14:34:37Z

methob
Jul 7, 2022

I tried many things to call the custom rule to be called but nothing works

My Rule:

`class MyRule(config: Config= Config.empty) : Rule(config) {

    override val issue = Issue(
        "DatabaseImplLeak",
        Severity.CodeSmell,
        "Custom rule",
        Debt.FIVE_MINS,
    )

    override fun visitClass(kclass: KtClass) {
        super.visitClass(kclass)
        report(CodeSmell(issue, Entity.from(kclass), "Let me see if this hit here"))
    }
}`

`class MyRuleSetProvider : RuleSetProvider {
    override val ruleSetId: String = "clean-arch-rules"

    override fun instance(config: Config) = RuleSet(ruleSetId, listOf(MyRule(config)))
}`

config:

build:
    maxIssues: 0
    excludeCorrectable: false

config:
    validation: true
    # when writing own rules with new properties, exclude the property path e.g.: "my_rule_set,.*>.*>[my_property]"
    excludes: "clean-arch-rules,.*>.*"

processors:
    active: true
    exclude:
        - 'DetektProgressListener'

console-reports:
    active: true
    exclude:
        - 'ProjectStatisticsReport'
        - 'ComplexityReport'
        - 'NotificationReport'
        - 'FileBasedFindingsReport'

style:
    WildcardImport:
        active: false
        excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

clean-arch-rules:
  DatabaseImplLeak:
    active: true

i added this file: com.btg.pactual.banking.detekt_custom_rules.detekt.MyRuleSetProvider

my detekt version é 1.19.0

My Gradle version is 7.3.3
My kotlin version is 1.6.0

schalkms · 2022-07-08T21:38:12Z

schalkms
Jul 8, 2022
Maintainer

Why is class MyRule not called DatabaseImplLeak as defined in the yml configuration?

I'd encourage you to start with the official template here and then customize further.

3 replies

methob Jul 12, 2022
Author

Hello! thank you @schalkms

I didn't understand the difference between what you sent and what I did

I created two projects, but in my project it didn't work, but in the test project it worked.

schalkms Jul 12, 2022
Maintainer

That’s the code you posted. Why is this rule called MyRule and not DatabaseImplLeak as specified in the config?

class MyRule(config: Config= Config.empty)

methob Jul 13, 2022
Author

@schalkms I was thinking that in the config what should be there is the id, but... I tried to leave the class with the same name as the ruleId, but it didn't work

cortinico · 2022-07-13T23:46:11Z

cortinico
Jul 13, 2022
Maintainer

Hi @methob

i added this file: com.btg.pactual.banking.detekt_custom_rules.detekt.MyRuleSetProvider

What do you mean with this specifically? I'm wondering if you're referring to the META-INF/services file you need to create like this one here: https://github.com/detekt/detekt-custom-rule-template/blob/main/src/main/resources/META-INF/services/io.gitlab.arturbosch.detekt.api.RuleSetProvider

As @schalkms suggested, please make sure to use the template as it will set up everything for you.

2 replies

methob Jul 14, 2022
Author

Hello @cortinico,

I have two projects, one that I build from scratch, using the template, in which the code worked perfectly, and another that is my main project that for some reason doesn't work.

I'm not able to identify why the RuleSetProvider is not being called

cortinico Jul 14, 2022
Maintainer

It's hard to help without a reproducer at this stage then :/ The reasons could be either:

You're not consuming the plugin correctly.
You forgot some file like the META-INF/services I mentioned
You're not enabling the rule correctly

methob · 2022-07-15T16:40:01Z

methob
Jul 15, 2022
Author

Hello, After I try different things I am getting this error

ps: i have two productFlavor(uat e prd) in my project and i create a custom module called custom-rules, which holds my rules

I'm importing the module like this: detekt project(':custom-rules')

`Could not determine the dependencies of task ':app:detekt'.
> Could not resolve all task dependencies for configuration ':app:detekt'.
   > Could not resolve project :custom-rules.
     Required by:
         project :app
      > Cannot choose between the following variants of project :custom-rules:
          - prdDebugRuntimeElements
          - prdReleaseRuntimeElements
          - uatDebugRuntimeElements
          - uatReleaseRuntimeElements
        All of them match the consumer attributes:
          - Variant 'prdDebugRuntimeElements' capability btg-android:custom-rules:unspecified:
              - Unmatched attributes:
                  - Provides com.android.build.api.attributes.AgpVersionAttr '7.2.1' but the consumer didn't ask for it
                  - Provides com.android.build.api.attributes.BuildTypeAttr 'debug' but the consumer didn't ask for it
                  - Provides com.android.build.api.attributes.ProductFlavor:enviroment 'prd' but the consumer didn't ask for it
                  - Provides com.android.build.gradle.internal.attributes.VariantAttr 'prdDebug' but the consumer didn't ask for it
                  - Provides enviroment 'prd' but the consumer didn't ask for it
                  - Provides org.gradle.category 'library' but the consumer didn't ask for it
                  - Provides org.gradle.jvm.environment 'android' but the consumer didn't ask for it
                  - Provides org.gradle.usage 'java-runtime' but the consumer didn't ask for it
                  - Provides org.jetbrains.kotlin.platform.type 'androidJvm' but the consumer didn't ask for it
          - Variant 'prdReleaseRuntimeElements' capability btg-android:custom-rules:unspecified:
              - Unmatched attributes:
                  - Provides com.android.build.api.attributes.AgpVersionAttr '7.2.1' but the consumer didn't ask for it
                  - Provides com.android.build.api.attributes.BuildTypeAttr 'release' but the consumer didn't ask for it
                  - Provides com.android.build.api.attributes.ProductFlavor:enviroment 'prd' but the consumer didn't ask for it
                  - Provides com.android.build.gradle.internal.attributes.VariantAttr 'prdRelease' but the consumer didn't ask for it
                  - Provides enviroment 'prd' but the consumer didn't ask for it
                  - Provides org.gradle.category 'library' but the consumer didn't ask for it
                  - Provides org.gradle.jvm.environment 'android' but the consumer didn't ask for it
                  - Provides org.gradle.usage 'java-runtime' but the consumer didn't ask for it
                  - Provides org.jetbrains.kotlin.platform.type 'androidJvm' but the consumer didn't ask for it
          - Variant 'uatDebugRuntimeElements' capability btg-android:custom-rules:unspecified:
              - Unmatched attributes:
                  - Provides com.android.build.api.attributes.AgpVersionAttr '7.2.1' but the consumer didn't ask for it
                  - Provides com.android.build.api.attributes.BuildTypeAttr 'debug' but the consumer didn't ask for it
                  - Provides com.android.build.api.attributes.ProductFlavor:enviroment 'uat' but the consumer didn't ask for it
                  - Provides com.android.build.gradle.internal.attributes.VariantAttr 'uatDebug' but the consumer didn't ask for it
                  - Provides enviroment 'uat' but the consumer didn't ask for it
                  - Provides org.gradle.category 'library' but the consumer didn't ask for it
                  - Provides org.gradle.jvm.environment 'android' but the consumer didn't ask for it
                  - Provides org.gradle.usage 'java-runtime' but the consumer didn't ask for it
                  - Provides org.jetbrains.kotlin.platform.type 'androidJvm' but the consumer didn't ask for it
          - Variant 'uatReleaseRuntimeElements' capability btg-android:custom-rules:unspecified:
              - Unmatched attributes:
                  - Provides com.android.build.api.attributes.AgpVersionAttr '7.2.1' but the consumer didn't ask for it
                  - Provides com.android.build.api.attributes.BuildTypeAttr 'release' but the consumer didn't ask for it
                  - Provides com.android.build.api.attributes.ProductFlavor:enviroment 'uat' but the consumer didn't ask for it
                  - Provides com.android.build.gradle.internal.attributes.VariantAttr 'uatRelease' but the consumer didn't ask for it
                  - Provides enviroment 'uat' but the consumer didn't ask for it
                  - Provides org.gradle.category 'library' but the consumer didn't ask for it
                  - Provides org.gradle.jvm.environment 'android' but the consumer didn't ask for it
                  - Provides org.gradle.usage 'java-runtime' but the consumer didn't ask for it
                  - Provides org.jetbrains.kotlin.platform.type 'androidJvm' but the consumer didn't ask for it`

2 replies

methob Jul 15, 2022
Author

i fixed it by modifying some things but now i am getting this error

What went wrong:
Execution failed for task ':app:detekt'.

java.lang.ClassNotFoundException: io.gitlab.arturbosch.detekt.cli.Main

schalkms Jul 18, 2022
Maintainer

Seems to be a Gradle config issue. You might want to browse through the following issues for potential solutions.
https://github.com/detekt/detekt/issues?q=is%3Aissue+ClassNotFoundException

Furthermore, I think the pitfalls section might be helpful as well.
https://detekt.dev/docs/introduction/extensions#pitfalls

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom Rules never called #5047

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 3 comments 7 replies

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

Select a reply

Custom Rules never called #5047

methob Jul 7, 2022

Replies: 3 comments · 7 replies

schalkms Jul 8, 2022 Maintainer

methob Jul 12, 2022 Author

schalkms Jul 12, 2022 Maintainer

methob Jul 13, 2022 Author

cortinico Jul 13, 2022 Maintainer

methob Jul 14, 2022 Author

cortinico Jul 14, 2022 Maintainer

methob Jul 15, 2022 Author

methob Jul 15, 2022 Author

schalkms Jul 18, 2022 Maintainer

methob
Jul 7, 2022

Replies: 3 comments 7 replies

schalkms
Jul 8, 2022
Maintainer

methob Jul 12, 2022
Author

schalkms Jul 12, 2022
Maintainer

methob Jul 13, 2022
Author

cortinico
Jul 13, 2022
Maintainer

methob Jul 14, 2022
Author

cortinico Jul 14, 2022
Maintainer

methob
Jul 15, 2022
Author

methob Jul 15, 2022
Author

schalkms Jul 18, 2022
Maintainer