Property misspelled or does not exist, not sure what am I missing #5304

pr4bh4sh · 2022-09-15T16:33:47Z

pr4bh4sh
Sep 15, 2022

When I run ./gradlew detekt I get below error

❯ ./gradlew clean

BUILD SUCCESSFUL in 1s
2 actionable tasks: 2 executed
❯ ./gradlew detekt

> Task :detekt-custom-rules:detekt FAILED
Property 'formatting' is misspelled or does not exist.
Property 'detekt-custom-rules' is misspelled or does not exist.

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':detekt-custom-rules:detekt'.
> Run failed with 2 invalid config properties.
        - Property 'formatting' is misspelled or does not exist.
        - Property 'detekt-custom-rules' is misspelled or does not exist.

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 2s
3 actionable tasks: 3 executed
❯ ./gradlew detekt

> Task :detekt FAILED
Property 'detekt-custom-rules' is misspelled or does not exist.

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':detekt'.
> Run failed with 1 invalid config property.
        - Property 'detekt-custom-rules' is misspelled or does not exist.

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 2s
5 actionable tasks: 3 executed, 2 up-to-date

I'm not sure what am I doing wrong as I get a different error on the same command.

Could someone please have a look and help me?
https://github.com/pr4bh4sh/detekt-demo

Answered by humblerookie

Mar 11, 2023

If you're using the CLI and the formatting rule you'll have to include the formatting plugin manually (as per this discussion) using -p or --plugins parameter
./gradlew detekt -p "app/build/detekt-formatter.jar"
You may download this jar from github and place it in the corresponding path initially.

View full answer

cortinico · 2022-09-17T13:00:19Z

cortinico
Sep 17, 2022
Maintainer

Execution failed for task ':detekt-custom-rules:detekt'.
Run failed with 2 invalid config properties.
- Property 'formatting' is misspelled or does not exist.
- Property 'detekt-custom-rules' is misspelled or does not exist.

The error message says that you have two keys in your config which are not valid: formatting and detekt-custom-rules. The formatting one is most likely related to not importing the detekt formatting plugin correctly.

The 'detekt-custom-rules' similarly. Are you trying to develop a custom rule by any chance?

2 replies

adavis Oct 12, 2022

The formatting one is most likely related to not importing the detekt formatting plugin correctly.

How can we properly import this plugin? Thanks!

BraisGabin Oct 13, 2022
Maintainer

https://detekt.dev//docs/intro#adding-more-rule-sets here it is described. If it's not clear, please open an issue so we can improve our documentation :)

pr4bh4sh · 2022-09-20T14:42:38Z

pr4bh4sh
Sep 20, 2022
Author

Thanks for taking a look @cortinico. Really appreciate the work you have done on detekt and providing support here for noobs like me :) . I'm coming from https://github.com/sds/overcommit and https://github.com/rubocop/rubocop, migrating to kotlin and detekt for good.

I have imported the detekt formatting plugin here. Not sure what could be wrong with it.

As mentioned in the previous comment when I ran the ./gradlew detekt a second time the error about the 'formatting' misspelling went away. There was no change in the code/configuration between running the command.

Yes, I plan to develop some custom rules in future.
I have added the detektProject dependency for custom rules here and have included the custom rule module here.

About the odd behaviour inhibited in the log provided previously. I'm able to reproduce it consistently. Here are the steps.

./gradlew clean # cleans successfully
./gradlew detekt # shows two misspelt property formatting and detekt-custom-rule
./gradlew detekt # shows just 1 misspelt property error for detekt-custom-rule

Because of the above behaviour, I'm not sure what is the correct way to import the formatting plugin and custom rules module. Unless there's a specific order the import should be arranged in.

Please give the https://github.com/pr4bh4sh/detekt-demo a try if you are able to reproduce it.

3 replies

BraisGabin Sep 20, 2022
Maintainer

How did you generate your config.yml file?

The error is that you have configuration for the formatting plugin of detekt but you aren't appling that plugin so detekt doesn't know about what formatting is and it complains about it.

pr4bh4sh Sep 21, 2022
Author

Everything in config.yml is generated using the Gradle task ./gradlew detektGenerateConfig except for the custom rule config with was added later at https://github.com/pr4bh4sh/detekt-demo/blob/master/config/detekt/detekt.yml#L885

BraisGabin Sep 22, 2022
Maintainer

I cloned your repo and you are right, this is clearly strange. I mean, the issue with detekt-custom-rule is normal behaviour but I don't understand why the first run of detekt doesn't get the formatting but the second one does.

Also, another strange behaviour is that even with detektPlugins(project(":detekt-custom-rules")) the task :detekt is executed before :detekt-custom_rules is compiled... that should not happen, I think. @3flex could you take a look here? Maybe do you have any idea why this could be happening?

pr4bh4sh · 2022-09-26T10:52:48Z

pr4bh4sh
Sep 26, 2022
Author

I manage to run the custom rule. The issue was in ruleSetId value. Now the custom issue is getting reported.
However, the issue with running detekt task 2 times and getting different results is still remaining. Not sure if it's something to do with Gradle or the way detekt task is executed.

Steps to reproduce

./gradlew clean # cleanup happens
./gradlew detekt # reports misspelt formatting and detekt-custom-rule
./gradlew detekt # reports the custom rule violation without any misspelling error

❯ ./gradlew clean

BUILD SUCCESSFUL in 729ms
2 actionable tasks: 2 executed
❯ ./gradlew detekt

> Task :detekt-custom-rules:detekt FAILED
Property 'formatting' is misspelled or does not exist.
Property 'detekt-custom-rules' is misspelled or does not exist.

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':detekt-custom-rules:detekt'.
> Run failed with 2 invalid config properties.
        - Property 'formatting' is misspelled or does not exist.
        - Property 'detekt-custom-rules' is misspelled or does not exist.

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 2s
3 actionable tasks: 3 executed
❯ ./gradlew detekt

> Task :detekt FAILED
/Users/prabhashsingh/detekt-demo/src/test/kotlin/ruletest/InternalImport.kt:3:1: Importing 'ruletest.internal.InternalClass' which is an internal import. [NoInternalImportRule]


FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':detekt'.
> Analysis failed with 1 weighted issues.

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 1s
5 actionable tasks: 3 executed, 2 up-to-date

```

4 replies

pr4bh4sh Oct 5, 2022
Author

The issue is definitely with the order of Gradle task execution. I compared both cases of detekt --info Gradle task execution. Found that if I execute the tasks in the below order I don't see the issue anymore

./gradlew clean # cleanup happens
./gradlew :detekt-custom-rules:classes# shows build successful
./gradlew detekt # reports the custom rule violation without any misspelling error

I tried to find if I could force the order of the task execution in Gradle. I tried mustRunAfter and shouldRunAfter unsuccessfully.

cc @BraisGabin

BraisGabin Oct 5, 2022
Maintainer

Yes, that have sense... But I would expect gradle to take care of that. I really don't know what's going on here.

denisyordanp Mar 25, 2024

Hi @pr4bh4sh you mentioned that "I manage to run the custom rule. The issue was in ruleSetId value.". Would you please describe what is wrong? because currently I have this issue that my custom rule isn't detected.

pr4bh4sh Mar 25, 2024
Author

@denisyordanp The issue was with Gradle, it didn't compile the project first time properly, fixed after doing
./gradlew clean :detekt-custom-rules:classes detekt

humblerookie · 2023-03-11T14:40:48Z

humblerookie
Mar 11, 2023

If you're using the CLI and the formatting rule you'll have to include the formatting plugin manually (as per this discussion) using -p or --plugins parameter
./gradlew detekt -p "app/build/detekt-formatter.jar"
You may download this jar from github and place it in the corresponding path initially.

2 replies

MicDeDuiwel Mar 21, 2023

I'm getting an issue when updating from detekt-cli 1.21 to 1.22 where if I tun ./gradlew detekt I get the following error:

> Task :backend:detekt FAILED
Property 'libraries' is misspelled or does not exist.

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':backend:detekt'.
> Run failed with 1 invalid config property.
        - Property 'libraries' is misspelled or does not exist.

I tried with you suggestion but it does not work for me. Is this known issue?

Some more info:

./gradlew --version

------------------------------------------------------------
Gradle 6.9.3
------------------------------------------------------------


Kotlin:       1.4.20
Groovy:       2.5.12
Ant:          Apache Ant(TM) version 1.10.9 compiled on September 27 2020
JVM:          11.0.16.1 (Homebrew 11.0.16.1+0)
OS:           Mac OS X 13.2.1 x86_64

humblerookie Mar 22, 2023

Please provide your detekt config, also have you downloaded thelibraries plugin/jar and included it in the plugin path as shown?

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Property misspelled or does not exist, not sure what am I missing #5304

{{title}}

Replies: 4 comments 11 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Property misspelled or does not exist, not sure what am I missing #5304

pr4bh4sh Sep 15, 2022

Replies: 4 comments · 11 replies

cortinico Sep 17, 2022 Maintainer

adavis Oct 12, 2022

BraisGabin Oct 13, 2022 Maintainer

pr4bh4sh Sep 20, 2022 Author

BraisGabin Sep 20, 2022 Maintainer

pr4bh4sh Sep 21, 2022 Author

BraisGabin Sep 22, 2022 Maintainer

pr4bh4sh Sep 26, 2022 Author

pr4bh4sh Oct 5, 2022 Author

BraisGabin Oct 5, 2022 Maintainer

denisyordanp Mar 25, 2024

pr4bh4sh Mar 25, 2024 Author

humblerookie Mar 11, 2023

MicDeDuiwel Mar 21, 2023

humblerookie Mar 22, 2023

pr4bh4sh
Sep 15, 2022

Replies: 4 comments 11 replies

cortinico
Sep 17, 2022
Maintainer

BraisGabin Oct 13, 2022
Maintainer

pr4bh4sh
Sep 20, 2022
Author

BraisGabin Sep 20, 2022
Maintainer

pr4bh4sh Sep 21, 2022
Author

BraisGabin Sep 22, 2022
Maintainer

pr4bh4sh
Sep 26, 2022
Author

pr4bh4sh Oct 5, 2022
Author

BraisGabin Oct 5, 2022
Maintainer

pr4bh4sh Mar 25, 2024
Author

humblerookie
Mar 11, 2023