MaibornWolff / codecharta

CodeCharta visualizes multiple code metrics using 3D tree maps.

https://maibornwolff.github.io/codecharta/

BSD 3-Clause "New" or "Revised" License

190 stars 29 forks source link

Add an alert when incompatible maps are compared in delta view #3771

Open ChristianHuehn opened 6 days ago

ChristianHuehn commented 6 days ago

Feature request

Description

As a user, I want to see an alert when comparing two maps which have different complexities (mcc and sonar_complexity), so that I can migrate them myself.

Acceptance criteria

[ ] Alert is only shown in delta mode when selecting a map
[ ] Alert contains information about the migration and links to the documentation
[ ] Alert has a close button and a checkbox for "don't remind me again", not opening the window again

BridgeAR commented 2 days ago

The migration might be useful for a few parsers but this is specific to a singular situation.

What about instead just showing the users what metrics do not match by highlighting them in a way that they are not clickable and indicate if map A or map B has the metric. On top of that (as a second step), add a functionality that allows to link the metric to one available in the other map.

That way it's always working for any combination and helps users to identify the issue fast.

ChristianHuehn commented 2 days ago

I agree with you in general, but we will change part of the cc.json format in the future. That would be a better place for this functionality. We spoke with some users and for them it was fine to do it like that right now. Thanks for your feedback.

BridgeAR commented 2 days ago

I fail to understand how the cc.json format matters in that case. Especially the indication that map A and B do not share the same metric names is something that we have in many situations and one input file has no knowledge about the other one until is it loaded.

I am certain most users are fine with the suggested implementation as it will resolve their immediate need. There are just different ways to resolve that need. One way is specific to that singular metric combination and the other solution is generic to any metric combination and will help future use cases.

CC is a general purpose tool and we have very different use cases (it is even used to visualize financial department data). Thus, generic solutions seem best to me.