MaibornWolff / codecharta

CodeCharta is a visualization tool that transforms complex software architecture and code metrics into interactive, customizable visual maps, empowering everyone to communicate and analyze your codebase. Improve code quality, maintainability, and architectural decisions

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

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

191 stars 30 forks source link

Improving ccsh check behaviour #3734

Open Nereboss opened 1 month ago

Nereboss commented 1 month ago

Question

Preparation

Please check these resources first before posting a question

[x] I searched for answers in older issues
[x] I looked into the README.md
[x] I read the website

Question

Should we improve the behaviour of ccsh check? I find it to be not the most intuitive right now:

When the input is a valid file, it simply runs and exits without any additional information. This can leave the user guessing if it even ran correctly as there is no feedback
When the input is an invalid file, it prints an exception containing what was wrong. At first sight this looks like the program ran into an error and not, that it successfully ran and concluded that the file is invalid.

How often is this functionality used? Would it be worth it to improve its output to more clearly state its findings?

ChristianHuehn commented 1 month ago

I can say that in the last two audits I attended, there werent any usages of ccsh check. I will ask around 👍 thanks