Skip to content

feat: add report option to cli #1058

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 11 commits into from
Aug 12, 2025
Merged

feat: add report option to cli #1058

merged 11 commits into from
Aug 12, 2025

Conversation

BioPhoton
Copy link
Collaborator

@BioPhoton BioPhoton commented Aug 8, 2025 •
edited
Loading

This PR includes:

  • add persist.report to model
  • add persist.report to CLI options and logic
  • terminal output is perserved to be cached by Nx

Related:
#1048

@github-actions github-actions bot added 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🧩 cli 🧩 core 🧩 models 🧩 utils 🧩 ci labels Aug 8, 2025
@BioPhoton BioPhoton mentioned this pull request Aug 8, 2025
Closed
5 tasks
@BioPhoton BioPhoton mentioned this pull request Aug 8, 2025
Merged
@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 8, 2025 •
edited
Loading

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit 5773dbc with previous commit 7daf201.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Performance 🔴 31 🔴 30 ↓ −1.3
Code coverage 🟢 90 🟢 90 ↑ +0.1
Security 🔴 0 🔴 0 –
Updates 🟡 77 🟡 77 –
Accessibility 🟢 92 🟢 92 –
Best Practices 🟢 100 🟢 100 –
SEO 🟡 61 🟡 61 –
Type Safety 🟢 100 🟢 100 –
Bug prevention 🟢 100 🟢 100 –
Miscellaneous 🟢 100 🟢 100 –
Code style 🟢 100 🟢 100 –
Documentation 🔴 23 🔴 23 –
👍 1 group improved, 👎 1 group regressed, 👍 4 audits improved, 👎 3 audits regressed, 13 audits changed without impacting score

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
Lighthouse Performance 🔴 31 🔴 30 ↓ −1.3
Code coverage Code coverage metrics 🟢 90 🟢 90 ↑ +0.1

19 other groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
Lighthouse Initial server response time was short 🟩 Root document took 520 ms 🟥 Root document took 610 ms ↑ +16.7 %
Lighthouse Avoids enormous network payloads 🟨 Total size was 2,706 KiB 🟩 Total size was 2,656 KiB ↓ −1.9 %
Lighthouse First Contentful Paint 🟥 3.2 s 🟥 3.5 s ↑ +8 %
Lighthouse Speed Index 🟥 8.6 s 🟥 9.7 s ↑ +12 %
Code coverage Branch coverage 🟨 85 % 🟨 85 % ↑ +0.1 %
Code coverage Line coverage 🟨 86.8 % 🟨 86.8 % ↑ +0.1 %
Code coverage Function coverage 🟩 93.1 % 🟩 93.2 % ↑ +0.1 %
Lighthouse Minimizes main-thread work 🟥 21.5 s 🟥 23.5 s ↑ +9.3 %
Lighthouse Server Backend Latencies 🟩 1,570 ms 🟩 490 ms ↓ −68.9 %
Lighthouse JavaScript execution time 🟥 10.7 s 🟥 11.7 s ↑ +9.2 %
Lighthouse Total Blocking Time 🟥 6,870 ms 🟥 7,670 ms ↑ +11.6 %
Lighthouse Uses efficient cache policy on static assets 🟨 31 resources found 🟨 31 resources found ↑ +0.1 %
Lighthouse Largest Contentful Paint 🟥 13.4 s 🟥 12.6 s ↓ −5.3 %
Lighthouse Metrics 🟩 100% 🟩 100% ↑ +2.1 %
Lighthouse Time to Interactive 🟥 19.6 s 🟥 20.0 s ↑ +2.1 %
Lighthouse Max Potential First Input Delay 🟥 2,360 ms 🟥 2,630 ms ↑ +11.4 %
Lighthouse Reduce unused CSS 🟥 Potential savings of 102 KiB 🟥 Potential savings of 72 KiB ↓ −34.8 %
Lighthouse Reduce unused JavaScript 🟥 Potential savings of 549 KiB 🟥 Potential savings of 549 KiB ↓ −1.3 %
Lighthouse Remove duplicate modules in JavaScript bundles 🟥 Potential savings of 92 KiB 🟥 Potential savings of 98 KiB ↓ −3.2 %
Lighthouse Network Round Trip Times 🟩 70 ms 🟩 70 ms ↑ +0.1 %

590 other audits are unchanged.

@BioPhoton BioPhoton marked this pull request as ready for review August 8, 2025 23:47
@BioPhoton BioPhoton requested a review from matejchalk August 8, 2025 23:47
matejchalk
matejchalk reviewed Aug 11, 2025
View reviewed changes
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.

The implementation is good, but the naming doesn't feel right to me. Suggested a few alternatives.

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Aug 11, 2025 •
edited
Loading

Open in StackBlitz

@code-pushup/ci

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/ci@1058

@code-pushup/create-cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/create-cli@1058

@code-pushup/cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@1058

@code-pushup/models

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/models@1058

@code-pushup/core

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/core@1058

@code-pushup/nx-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/nx-plugin@1058

@code-pushup/coverage-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/coverage-plugin@1058

@code-pushup/eslint-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/eslint-plugin@1058

@code-pushup/js-packages-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/js-packages-plugin@1058

@code-pushup/jsdocs-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/jsdocs-plugin@1058

@code-pushup/lighthouse-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/lighthouse-plugin@1058

@code-pushup/typescript-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/typescript-plugin@1058

@code-pushup/utils

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@1058

commit: 62775ca

matejchalk
matejchalk reviewed Aug 11, 2025
View reviewed changes
@BioPhoton @matejchalk
Update packages/cli/README.md
246c780 
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
matejchalk
matejchalk previously approved these changes Aug 11, 2025
View reviewed changes
@BioPhoton BioPhoton merged commit 49adbf3 into main Aug 12, 2025
17 checks passed
@BioPhoton BioPhoton deleted the add-report-option-to-cli branch August 12, 2025 09:27
BioPhoton added a commit that referenced this pull request Aug 12, 2025
@BioPhoton @matejchalk
feat: add caching options to cli (#1059)
0aee085 
This PR depends on:
- #1058 
- #1057   

This PR includes: 
- docs on [`--cache` options and
caching](https://github.com/code-pushup/cli/pull/1059/files#diff-5357afeca9b96eccbc161aa37719ecf7668ac0ebae529e0695f2a9da5cf3b144)
- docs on [how to cache with
Nx](https://github.com/code-pushup/cli/pull/1059/files#diff-15986190ef9581ab59bcd5483b2c09e7fd0bd439d6f6cddbc94b0b1de094ee51)
  - docs on how to use with Turborepo
- logic to respect cache options
- e2e tests testing the full cache flow (inc `--skipReports`)

Suggested followup PR would be to implement Nx caching. This is
partially started here: #1035.

> [!note]
> Potential changes arrive after #1058 is merged

Closes #1048

---------

Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matejchalk matejchalk matejchalk approved these changes

Assignees

@BioPhoton BioPhoton

Labels
🧩 ci 🧩 cli 🧩 core 🧩 models 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🧩 utils
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@BioPhoton @matejchalk