Skip to content

Conversation

@aramirezj
Copy link
Contributor

@aramirezj aramirezj commented Dec 17, 2024

This PR includes:

  • documentation
  • Unit testing
    • Source Files are mocked
  • Integration tests
    • Test case for every audit in a small codebase
  • e2e
  • usage of the plugin in the repository

Closes #908

Report Summary

Overview of Audit Groups, Audit Counts, and Diagnostic Issue Types.

📁 Group Name 📋 Audits 🐞 Issues
documentation-coverage classes-coverage, methods-coverage, functions-coverage, interfaces-coverage, variables-coverage, properties-coverage, types-coverage, enums-coverage Missing documentation
------------------------ ------------------------------------------------- -------------------
1 Group Total 8 Audits Total 1 Issue Type Total

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

github-actions bot commented Dec 17, 2024

Code PushUp

😟 Code PushUp report has regressed – compared target commit 053d595 with source commit 053d595.

🏷️ Categories

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Performance 🟡 57 🔴 49 ↓ −8.6
Code coverage 🟢 91 🟢 91
Security 🟡 81 🟡 81
Updates 🟡 80 🟡 80
Accessibility 🟢 92 🟢 92
Best Practices 🟢 100 🟢 100
SEO 🟡 61 🟡 61
Bug prevention 🟢 100 🟢 100
Code style 🟢 100 🟢 100
👎 1 group regressed, 👎 5 audits regressed, 13 audits changed without impacting score

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
Lighthouse Performance 🟡 57 🔴 49 ↓ −8.6

16 other groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
Lighthouse Largest Contentful Paint 🟨 3.0 s 🟨 3.8 s ↑ +28.1 %
Lighthouse Speed Index 🟨 4.9 s 🟨 5.4 s ↑ +10.4 %
Lighthouse First Contentful Paint 🟨 2.9 s 🟥 3.1 s ↑ +5.7 %
Lighthouse Time to Interactive 🟥 12.5 s 🟥 14.3 s ↑ +14.6 %
Lighthouse Total Blocking Time 🟥 2,520 ms 🟥 4,440 ms ↑ +76 %
Lighthouse Minimizes main-thread work 🟥 11.8 s 🟥 15.1 s ↑ +27.7 %
Lighthouse JavaScript execution time 🟥 4.8 s 🟥 7.1 s ↑ +48.6 %
Lighthouse Metrics 🟩 100% 🟩 100% ↑ +14.6 %
Lighthouse Avoids enormous network payloads 🟩 Total size was 1,815 KiB 🟩 Total size was 1,814 KiB ↓ −0.1 %
Lighthouse Uses efficient cache policy on static assets 🟨 27 resources found 🟨 27 resources found ↓ −0.1 %
Lighthouse Eliminate render-blocking resources 🟥 Potential savings of 760 ms 🟥 Potential savings of 1,160 ms ↑ +52.3 %
Lighthouse Max Potential First Input Delay 🟥 2,030 ms 🟥 1,840 ms ↓ −9.4 %
Lighthouse Server Backend Latencies 🟩 110 ms 🟩 270 ms ↑ +152.7 %
Lighthouse Reduce unused CSS 🟥 Potential savings of 67 KiB 🟥 Potential savings of 67 KiB ↑ +50 %
Lighthouse Network Round Trip Times 🟩 60 ms 🟩 20 ms ↓ −63.1 %
Lighthouse Initial server response time was short 🟩 Root document took 320 ms 🟩 Root document took 340 ms ↑ +6.4 %
Lighthouse Avoid large layout shifts 🟩 0 🟩 1 layout shift found ↑ +∞ %
Lighthouse Cumulative Layout Shift 🟩 0 🟩 0.001 ↑ +∞ %

570 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

@matejchalk matejchalk left a comment

Choose a reason for hiding this comment

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

Thanks a lot for your contribution, this plugin looks really promising ❤️

My main quibble is with the outer namings, but also left some suggestions for the source code.

aramirezj and others added 9 commits January 11, 2025 23:03
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
@aramirezj
Copy link
Contributor Author

Hey @matejchalk ! Every comment has been reviewed, 99% of them just applied as u said, except one that I had to do differently. Thank you so much for the deep review! ^^

@aramirezj aramirezj changed the title feat(plugin-doc-coverage): add doc-coverage-plugin to analyze documentation in ts/js projects feat(plugin-jsdocs): add doc-coverage-plugin to analyze documentation in ts/js projects Jan 12, 2025
@aramirezj aramirezj changed the title feat(plugin-jsdocs): add doc-coverage-plugin to analyze documentation in ts/js projects feat(plugin-jsdocs): add plugin-jsdocs to analyze documentation in ts/js projects Jan 14, 2025
@aramirezj
Copy link
Contributor Author

@matejchalk Done for now, thanks again for the review ^^

Copy link
Collaborator

@matejchalk matejchalk left a comment

Choose a reason for hiding this comment

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

Great job 👏 Thanks for the updates 👍

@BioPhoton
Copy link
Collaborator

WONDERFUL!!!!!

@BioPhoton BioPhoton merged commit 1686dda into code-pushup:main Jan 17, 2025
16 checks passed
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 (jsdocs-plugin)

4 participants