Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(plugin-doc-coverage): add doc-coverage-plugin to analyze documentation in ts/js projects #896

Open
wants to merge 39 commits into
base: main
Choose a base branch
from

Conversation

aramirezj
Copy link

@aramirezj aramirezj commented Dec 17, 2024

This PR includes:

  • documentation
  • unit/integration tests
  • usage of the plugin in the repository

E2e test will be in a followup PR

Closes #900

@github-actions github-actions bot added 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🛠️ tooling labels Dec 17, 2024
Copy link

github-actions bot commented Dec 17, 2024

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared target commit c219602 with source commit c219602.

🏷️ Categories

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Performance 🔴 49 🔴 49 ↑ +0.1
Code coverage 🟢 91 🟢 91
Security 🟡 81 🟡 81
Updates 🟡 80 🟡 80
Accessibility 🟢 91 🟢 91
Best Practices 🟢 100 🟢 100
SEO 🟡 61 🟡 61
Bug prevention 🟢 100 🟢 100
Code style 🟢 100 🟢 100
👍 1 group improved, 👍 2 audits improved, 👎 3 audits regressed, 10 audits changed without impacting score

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
Lighthouse Performance 🔴 49 🔴 49 ↑ +0.1

16 other groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
Lighthouse Speed Index 🟥 6.0 s 🟥 6.7 s ↑ +13.2 %
Lighthouse Largest Contentful Paint 🟨 3.8 s 🟨 3.6 s ↓ −5.5 %
Lighthouse First Contentful Paint 🟨 2.9 s 🟨 2.9 s ↓ −2 %
Lighthouse Time to Interactive 🟥 13.5 s 🟥 14.5 s ↑ +7 %
Lighthouse Total Blocking Time 🟥 3,290 ms 🟥 4,840 ms ↑ +47 %
Lighthouse Minimizes main-thread work 🟥 13.3 s 🟥 16.4 s ↑ +23.6 %
Lighthouse JavaScript execution time 🟥 5.8 s 🟥 7.4 s ↑ +25.8 %
Lighthouse Metrics 🟩 100% 🟩 100% ↑ +7 %
Lighthouse Max Potential First Input Delay 🟥 2,540 ms 🟥 2,020 ms ↓ −20.3 %
Lighthouse Avoids enormous network payloads 🟩 Total size was 1,820 KiB 🟩 Total size was 1,820 KiB ↑ +0.1 %
Lighthouse Server Backend Latencies 🟩 350 ms 🟩 160 ms ↓ −55.2 %
Lighthouse Uses efficient cache policy on static assets 🟨 28 resources found 🟨 28 resources found ↑ +0.1 %
Lighthouse Initial server response time was short 🟩 Root document took 460 ms 🟩 Root document took 420 ms ↓ −8.8 %
Lighthouse Eliminate render-blocking resources 🟥 Potential savings of 800 ms 🟥 Potential savings of 770 ms ↓ −3.8 %
Lighthouse Network Round Trip Times 🟩 80 ms 🟩 70 ms ↓ −10.2 %

573 other audits are unchanged.

@aramirezj aramirezj changed the title feat(plugin-doc-coverage): add mvp version of a plugin doc coverage based on compodoc feat(plugin-doc-coverage): add mvp version of a plugin doc coverage based on typedoc and TBD Dec 17, 2024
@aramirezj aramirezj marked this pull request as ready for review December 20, 2024 18:53
@aramirezj aramirezj changed the title feat(plugin-doc-coverage): add mvp version of a plugin doc coverage based on typedoc and TBD feat(plugin-doc-coverage): add doc-coverage-plugin to analyze documentation in ts/js projects Dec 21, 2024
Copy link
Collaborator

@BioPhoton BioPhoton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really good polished tests! 🧪
I made some suggestions to improve naming and other small things.

aramirezj and others added 15 commits December 23, 2024 11:29
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
…test.ts

Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
…gration.test.ts

Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
code-pushup.config.ts Outdated Show resolved Hide resolved
Copy link
Collaborator

@BioPhoton BioPhoton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the tests.

Last thing I found was a outdated readme. After that we are good to go.

Copy link
Collaborator

@BioPhoton BioPhoton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WONDERFUL!

cc @vmasek and @matejchalk

BioPhoton
BioPhoton previously approved these changes Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🛠️ tooling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation coverage plugin
2 participants