fix(compodoc): correct `coverageTest` behavior

[HugoMendes98]

Hello @twittwer,

There was a misunderstanding in the previous implementation: The coverageTest flag runs a "coverage test" and do not generate the documentation. The disableCoverage removes the Documentation coverage page in the documentation (image).

I'm also reversing the order of the flags, before https://github.com/twittwer/nx-tools/pull/83, as the two flags don't have the same (exact) category.

[twittwer]

What do you mean by

The coverageTest flag runs a "coverage test

Is the coverage only calculated if thecoverageTest is set to a value above 0?

[HugoMendes98]

The comment coverage is always calculated, unless the disableCoverage flag is set.

Visible in the Documentation coverage page

The coverageTest option (when > 0) turns the command into a test:

• When sufficient: it exits with a code 0
• When insufficient: it exits with a code 1

I personally use it in CIs to ensure that the code is sufficiently commented.

I have not tested it, but the coverageMinimumPerFile flag may have the same behavior.

Have I made it clearer?

[HugoMendes98]

Hello @twittwer,

Any news on this?

[twittwer]

Except for the confusion about the description it looks clearer to me.

When you can clarify this one point, I'll try to release it during the weekend.