JakubAndrysek / MkDoxy

📖 Automatically generates API documentation for your project based on Doxygen comments and code snippets in your markdown files.
https://mkdoxy.kubaandrysek.cz/
MIT License
60 stars 16 forks source link

Make sure only files are hashed #29

Closed Sebastian-0 closed 1 year ago

Sebastian-0 commented 1 year ago

Without this fix directories with . in the name will be matched and the script will crash when it tries to open them.

In my case we have a project where some of the sources are in the repo's root directory, and then the hashing computation matches the .git folder which is in the same folder.

Obviously this will cause problems for any folders with a dot in the name if it is within the source folder hierarchy.

sourcery-ai[bot] commented 1 year ago

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 3.43%.

Quality metrics Before After Change
Complexity 6.88 ⭐ 9.26 🙂 2.38 👎
Method Length 64.00 🙂 64.71 🙂 0.71 👎
Working memory 3.50 ⭐ 3.44 ⭐ -0.06 👍
Quality 68.31% 🙂 64.88% 🙂 -3.43% 👎
Other metrics Before After Change
Lines 95 96 1
Changed files Quality Before Quality After Quality Change
mkdoxy/doxyrun.py 68.31% 🙂 64.88% 🙂 -3.43% 👎

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation
mkdoxy/doxyrun.py DoxygenRun.hasChanged 18 🙂 146 😞 45.77% 😞 Try splitting into smaller methods

Legend and Explanation

The emojis denote the absolute quality of the code:

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.


Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!