Some reports are not generating

[venkatesh-nagineni]

I am testing this lib to get some metrics (great lib that generating different metrics) but some reports were not generated like code-duplication dashboard and code-coupling etc..

is there any reason that do not get some other folders

[helabenkhalfallah]

Hello, thank you so much for your feedback. Can you give me more details about your project structure? thank you :)

[venkatesh-nagineni]

actually i have a src folder which contains some.ts files and .spec.ts files where i want to execute .ts files and exclude .spec.ts so there is no exclude feature to do this with in the lib, what i am doing, i create a temp-src folder which having only .ts files and then i provide this folder to the code-health-meter cli

        // Resolve the paths to be relative before passing to the command
        const relativeTempDir = path.relative(process.cwd(), tempDir);
        const relativeOutputDir = path.relative(process.cwd(), outputDir);

        // Prepare the command
        const command = `npx code-health-meter --srcDir "${relativeTempDir}" --outputDir "${relativeOutputDir}" --format "html"`;

even providing only src folder without doing alterations, getting same output

[helabenkhalfallah]

Tests files are excluded by default to avoid excluding known patterns:
https://github.com/helabenkhalfallah/code-health-meter/blob/main/src/kernel/coupling/CodeCouplingAuditor.js#L11
https://github.com/helabenkhalfallah/code-health-meter/blob/main/src/kernel/duplication/CodeDuplicationAuditor.js#L19
https://github.com/helabenkhalfallah/code-health-meter/blob/main/src/kernel/complexity/CodeComplexityAuditor.js#L183
https://github.com/helabenkhalfallah/code-health-meter/blob/main/src/commons/AuditUtils.js#L235

Then, can I have a screenshot of how your folder is organized to emulate the case on my side.

I tried to execute the same script as you but I can got reports:

Thank you :)

[venkatesh-nagineni]

here it is reproducible example
https://codesandbox.io/p/devbox/purple-thunder-5wvdl4?workspaceId=15d255a3-27ac-4d18-b352-3f6457409c76
execute this command to see it output

npx code-health-meter --srcDir "./src/components/" --outputDir "./metrics/" --format "html"

.spec.ts and e2e.ts also very common extensions to exclude or better to give power with include or exclude flag for users

update: if i provide path second level like ./src/components/my-component then it is giving duplication-report

[helabenkhalfallah]

Thank you for the different information, I'll come back to you soon :)

[helabenkhalfallah]

I did not have access to your sandbox "Devbox not found". Can you give me the public link ? thank you!

[venkatesh-nagineni]

ohh, ok give me mint

[venkatesh-nagineni]

what about this link

[helabenkhalfallah]

It's working, perfect!

[helabenkhalfallah]

Hello, I download your project locally and I have the different reports:

However you are right about e2e test, I'll add this case to excluded files list and enable custom exclude config.

Then, the duplication analysis is done but your code does not contains any duplication:

Finally for security report, your code does not contains a security issue until now:

But I'll enhance the empty message.

[venkatesh-nagineni]

ok, cool but still not generating code duplication reports in the reproducible example, does any OS related issues, currently i have macos using for this generation and do not see this reports at all

example shows duplication audit where does not show it in my machine

but again this is great work and great lib that no other lib generating this much of metrics (tested couple of libs)

[helabenkhalfallah]

I also use macos. I'll give you a version with error console enabled, to be able to identify the issues. I'll come back soon to you. Thank you for your patience :)

[helabenkhalfallah]

Can you run the command and paste all logs here please? thank you

[venkatesh-nagineni]

here is logs from my complex project
log.txt

[helabenkhalfallah]

Aha, I have some valuables logs:

�[32minfo�[39m: [CodeCouplingAuditor - startAudit] error:  Graphviz could not be found. Ensure that "gvpr" is in your $PATH. Error: spawn gvpr ENOENT

This is needed to visualize graph, I should update the document. To install in macos:

brew install graphviz || port install graphviz

And this error:

�[32minfo�[39m: [CodeDuplicationAuditor - inspectDirectory] execSync error:  spawnSync /bin/sh ENOBUFS

I should update the code as follow:
https://stackoverflow.com/a/63796634/1532771

https://github.com/helabenkhalfallah/code-health-meter/blob/main/src/kernel/duplication/CodeDuplicationAuditor.js#L68
https://github.com/helabenkhalfallah/code-health-meter/blob/main/src/kernel/duplication/CodeDuplicationAuditor.js#L76

I'll work on these update and come back to you soon :) :)

[venkatesh-nagineni]

found another small issue, by providing --outputDir to the command, process get deleted existing files before creating new files which is not good, keep all files inside outputDir, just create new files

may be fs.ensureDir(outputDir) that make sure the output directory exists without removing any existing files

seems issue here
https://github.com/helabenkhalfallah/code-health-meter/blob/main/src/kernel/complexity/CodeComplexityUtils.js#L396
https://github.com/helabenkhalfallah/code-health-meter/blob/main/src/kernel/coupling/CodeCouplingUtils.js#L98

[helabenkhalfallah]

Hello I published a new version 3.0.1 to fix this issue #15 (comment) and to add new metrics. :) :)

[venkatesh-nagineni]

Thx for the fix, unfortunately this new version keep on hanging at middle and does not exit the process, need to look why whereas tested npx with 2.0.0 version and works like before

[helabenkhalfallah]

Thank you so much for your feedback, should I use the same project to reproduce? can you give me more information about your:

• OS
• Node version

Thank you :)

[venkatesh-nagineni]

thx for the quick reply, i can not reproduce it here

My CI Pipeline broken first then checked in my local setup

seems more related to my project where it is

Mac Os
Node: v20.9.0

process hangs at this step but reports were generated until codeCoupling, seems hangs at code duplication audit process

I will need to check more and give you logs soon