How can I exclude/filter specific MagicNumber issues in detekt.yml

[xetra11]

I am using Jetbrain's Compose for Desktop and the code structure there is a little bit odd and unconventional.
Given the following snippet:

Modifier.preferredSize(70.dp, 25.dp),

Detekt spits out a MagicNumber issue. I understand the problem - however I have no other way than going "magical" here.
I read in the detekt.yml. that there are some options to customize the behaviour.
This is my configuration therefore:

  MagicNumber:
    active: false # inactive due my problem for now
    excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
    ignoreNumbers: ['-1', '0', '1', '2']
    ignoreHashCodeFunction: true
    ignorePropertyDeclaration: false
    ignoreLocalVariableDeclaration: false
    ignoreConstantDeclaration: true
    ignoreCompanionObjectPropertyDeclaration: true
    ignoreAnnotation: false
    ignoreNamedArgument: true
    ignoreEnums: false
    ignoreRanges: false

I found that ignoreNamedArgument = true might help but it does not work on the following:

Modifier.preferredSize(width = 70.dp, height = 25.dp)

So my question is how can I exclude the above numbers arguments that are plenty in my codebase?

(First Discussion Question 🥳 )

[BraisGabin]

Do those file names follow a regular expression? You could add to the exclude something like **/*ComposeView.kt. Other option is to disable the rule.

Usually I would say that other option is to create a copy of the rule and adapt it to your needs... But the use of compose is going to grow a lot so we should think about this. Disable the rule if it's used with an extension function? Create a script-configuration so the users can code when they want to ignore an issue to give maximum flexibility? Is this even possible?

[xetra11]

Well for me it would work if the "magic number" would appear with the .dp extension property and therefore a rule excluding exactly that would be sufficient for my case. However as I said I don't really know how to achieve that and if exclude is regex or just this... ehm forgot the name for having directory paths with * :D

[cortinico]

But the use of compose is going to grow a lot so we should think about this

We should consider adding a ignoreExtensionsReceivers or something along this line? Is it going to be too broad?

[arturbosch]

This sounds like a really good idea to me.
There are also some time libraries which allow you to write code like 2.days.from.now etc. The function name explains the number.

[BraisGabin]

I created #3299 to move this forward. I'm not sure about the flag's name. Any feedback is more than welcome.

[arturbosch]

I am using Jetbrain's Compose for Desktop and the code structure there is a little bit odd and unconventional.
Given the following snippet:

Modifier.preferredSize(70.dp, 25.dp),

Detekt spits out a MagicNumber issue. I understand the problem - however I have no other way than going "magical" here.
I read in the detekt.yml. that there are some options to customize the behaviour.
This is my configuration therefore:

  MagicNumber:
    active: false # inactive due my problem for now
    excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
    ignoreNumbers: ['-1', '0', '1', '2']
    ignoreHashCodeFunction: true
    ignorePropertyDeclaration: false
    ignoreLocalVariableDeclaration: false
    ignoreConstantDeclaration: true
    ignoreCompanionObjectPropertyDeclaration: true
    ignoreAnnotation: false
    ignoreNamedArgument: true
    ignoreEnums: false
    ignoreRanges: false

I found that ignoreNamedArgument = true might help but it does not work on the following:

Modifier.preferredSize(width = 70.dp, height = 25.dp)

I think this could be fixed by upgrading our code where we just check if parent is KtParameter

detekt/detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/MagicNumber.kt

Lines 190 to 196 in 3aee08d

	private fun KtConstantExpression.isPartOfConstructorOrFunctionConstant(): Boolean {
	return parent is KtParameter &&
	when (parent.parent.parent) {
	is KtNamedFunction, is KtPrimaryConstructor, is KtSecondaryConstructor -> true
	else -> false
	}
	}

getStrictParent before KtNamedFunction should solve such cases.

So my question is how can I exclude the above numbers arguments that are plenty in my codebase?

(First Discussion Question )