feat: add caching options to cli

[BioPhoton]

This PR depends on:

• feat: add report option to cli #1058
• feat: add audit output caching for execute plugin #1057

This PR includes:

• docs on --cache options and caching
  • docs on how to cache with Nx
  • 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

[github-actions]

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit 4553888 with previous commit 49adbf3.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Performance	🔴 32	🔴 29
Code coverage	🟢 90	🟢 90
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	–

👎 2 groups regressed, 👍 1 audit improved, 👎 4 audits regressed, 15 audits changed without impacting score

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
Lighthouse	Performance	🔴 32	🔴 29
Code coverage	Code coverage metrics	🟢 90	🟢 90

19 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value	🔄 Value change
Lighthouse	Speed Index	🟥 7.7 s	🟥 10.8 s
Lighthouse	First Contentful Paint	🟥 3.1 s	🟥 3.4 s
Code coverage	Branch coverage	🟨 85 %	🟨 85 %
Code coverage	Line coverage	🟨 86.8 %	🟨 86.8 %
Code coverage	Function coverage	🟩 93.2 %	🟩 93.2 %
Lighthouse	Minimizes main-thread work	🟥 16.5 s	🟥 22.0 s
Lighthouse	Total Blocking Time	🟥 4,480 ms	🟥 6,960 ms
Lighthouse	JavaScript execution time	🟥 7.9 s	🟥 9.4 s
Lighthouse	Largest Contentful Paint	🟥 10.8 s	🟥 12.0 s
Lighthouse	Time to Interactive	🟥 17.0 s	🟥 17.9 s
Lighthouse	Metrics	🟩 100%	🟩 100%
Lighthouse	Initial server response time was short	🟥 Root document took 970 ms	🟥 Root document took 1,760 ms
Lighthouse	Max Potential First Input Delay	🟥 1,270 ms	🟥 2,030 ms
Lighthouse	Uses efficient cache policy on static assets	🟨 30 resources found	🟨 30 resources found
Lighthouse	Remove duplicate modules in JavaScript bundles	🟥 Potential savings of 99 KiB	🟥 Potential savings of 93 KiB
Lighthouse	Server Backend Latencies	🟩 1,070 ms	🟩 920 ms
Lighthouse	Avoids enormous network payloads	🟩 Total size was 2,660 KiB	🟩 Total size was 2,660 KiB
Lighthouse	Reduce unused JavaScript	🟥 Potential savings of 549 KiB	🟥 Potential savings of 549 KiB
Lighthouse	Reduce unused CSS	🟥 Potential savings of 102 KiB	🟥 Potential savings of 102 KiB
Lighthouse	Network Round Trip Times	🟩 70 ms	🟩 80 ms

590 other audits are unchanged.

[pkg-pr-new]

Open in StackBlitz

@code-pushup/ci

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

@code-pushup/core

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

@code-pushup/cli

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

@code-pushup/create-cli

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

@code-pushup/models

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

@code-pushup/nx-plugin

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

@code-pushup/coverage-plugin

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

@code-pushup/eslint-plugin

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

@code-pushup/js-packages-plugin

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

@code-pushup/jsdocs-plugin

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

@code-pushup/lighthouse-plugin

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

@code-pushup/typescript-plugin

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

@code-pushup/utils

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

commit: 612dcb8