feat(plugin-doc-coverage): add doc-coverage-plugin to analyze documentation in ts/js projects #896
Conversation
github-actions
bot
added
📖 Project documentation
Code PushUp😟 Code PushUp report has regressed – compared target commit c219602 with source commit c219602. 🏷️ Categories
👎 1 group regressed, 👎 5 audits regressed, 12 audits changed without impacting score🗃️ Groups
16 other groups are unchanged. 🛡️ Audits
571 other audits are unchanged. |
aramirezj
changed the title
…anced and some code improved
…ls. Solid version working
…te unit test for runner file
aramirezj
changed the title
… unused dependency, new test
|
@aramirezj thank you for putting this plugin together, we did discuss it on refinement today and we are exited to adopt it as one of the plugins that should live in this monorepo (there are plugins that we purposely do not maintain here as they do not meet the JS/TS tech stack). We are also looking forward to setup automated docs generation, so it makes even more sense to start tracking it with plugin. There are some things we need to figure out before we merge, mainly related to testing. We are thinking if there should already be a simple e2e tests similar to for the ESLint e2e exaple, is it something you'd also like to contribute? |
I am glad to hear that! And sure! I will work into that ^^ |
| nodesCount: 1, | ||
| issues: [ | ||
| { | ||
| file: expect.stringContaining('classes-coverage'), |
There was a problem hiding this comment.
| file: expect.stringContaining('classes-coverage'), | |
| file: expect.stringContaining('classes-coverage.ts'), |
To make sure it is at the end of the file, and not a different file with same path segment.
This is applicable to multiple places.
There was a problem hiding this comment.
I'd even say it could be stringEndingWith('classes-coverage.ts')
There was a problem hiding this comment.
I have added expect.stringMatching(/properties-coverage\.ts$/) that it should do the trick
There was a problem hiding this comment.
@aramirezj with the latest merge we have OS agnostic path helpers in the codebase:
https://github.com/code-pushup/cli/blob/main/testing/test-setup/src/lib/extend/path.matcher.unit.test.ts
Let's use them.
This PR includes:
Closes #908
Report Summary
Overview of Audit Groups, Audit Counts, and Diagnostic Issue Types.
classes-coverage,methods-coverage,functions-coverage,interfaces-coverage,variables-coverage,properties-coverage,types-coverage,enums-coverage