code-pushup / cli

A CLI to run all kinds of code quality measurements to align your team with company goals
https://code-pushup.dev
MIT License
208 stars 12 forks source link

refactor: style cli help #781

Closed BioPhoton closed 1 month ago

BioPhoton commented 1 month ago

This PR includes style adoptions on the CLI help output.

The following changes are included:

After Before
Screenshot 2024-08-04 at 16 04 10 Screenshot 2024-08-04 at 15 41 00
github-actions[bot] commented 1 month ago

Code PushUp

๐Ÿคจ Code PushUp report has both improvements and regressions โ€“ compared target commit 8526caf7d39af9f88a27118b5b00a73958eb298a with source commit abe4f4f830cb84e43af546cc97a6dc091d01cd7e.

๐Ÿ•ต๏ธ See full comparison in Code PushUp portal ๐Ÿ”

๐Ÿท๏ธ Categories

๐Ÿท๏ธ Category โญ Previous score โญ Current score ๐Ÿ”„ Score change
Performance ๐ŸŸก 55 ๐ŸŸก 51 โ†“ โˆ’4.3
Code coverage ๐ŸŸก 89 ๐ŸŸก 90 โ†‘ +0.1
Custom checks ๐ŸŸก 67 ๐ŸŸก 67 โ€“
Security ๐ŸŸข 100 ๐ŸŸข 100 โ€“
Updates ๐ŸŸก 78 ๐ŸŸก 78 โ€“
Accessibility ๐ŸŸข 91 ๐ŸŸข 91 โ€“
Best Practices ๐ŸŸข 100 ๐ŸŸข 100 โ€“
SEO ๐ŸŸก 61 ๐ŸŸก 61 โ€“
Bug prevention ๐ŸŸข 100 ๐ŸŸข 100 โ€“
Code style ๐ŸŸข 99 ๐ŸŸข 99 โ€“

๐Ÿ—ƒ๏ธ Groups

๐Ÿ‘ 1 group improved, ๐Ÿ‘Ž 1 group regressed | ๐Ÿ”Œ Plugin | ๐Ÿ—ƒ๏ธ Group | โญ Previous score | โญ Current score | ๐Ÿ”„ Score change | | :--------------------------------------------------------------------------- | :-------------------- | :--------------: | :-------------: | :------------------------------------------------------------------: | | Lighthouse | Performance | ๐ŸŸก 55 | ๐ŸŸก **51** | ![โ†“ โˆ’4.3](https://img.shields.io/badge/%E2%86%93%20%E2%88%924.3-red) | | [Code coverage](https://www.npmjs.com/package/@code-pushup/coverage-plugin/) | Code coverage metrics | ๐ŸŸก 89 | ๐ŸŸก **90** | ![โ†‘ +0.1](https://img.shields.io/badge/%E2%86%91%20%2B0.1-green) | 18 other groups are unchanged.

๐Ÿ›ก๏ธ Audits

๐Ÿ‘ 5 audits improved, ๐Ÿ‘Ž 3 audits regressed, 13 audits changed without impacting score | ๐Ÿ”Œ Plugin | ๐Ÿ›ก๏ธ Audit | ๐Ÿ“ Previous value | ๐Ÿ“ Current value | ๐Ÿ”„ Value change | | :--------------------------------------------------------------------------- | :------------------------------------------- | :------------------------------: | :----------------------------------: | :-------------------------------------------------------------------------------: | | Lighthouse | Largest Contentful Paint | ๐ŸŸจ 3.1ย s | ๐ŸŸจ **3.6ย s** | ![โ†‘ +15โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B15%E2%80%89%25-red) | | Lighthouse | Speed Index | ๐ŸŸจ 5.2ย s | ๐ŸŸฅ **6.0ย s** | ![โ†‘ +15โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B15%E2%80%89%25-red) | | Lighthouse | First Contentful Paint | ๐ŸŸจ 2.9ย s | ๐ŸŸจ **2.9ย s** | ![โ†“ โˆ’2โ€‰%](https://img.shields.io/badge/%E2%86%93%20%E2%88%922%E2%80%89%25-green) | | Lighthouse | First Meaningful Paint | ๐ŸŸจ 2.9ย s | ๐ŸŸจ **2.9ย s** | ![โ†“ โˆ’2โ€‰%](https://img.shields.io/badge/%E2%86%93%20%E2%88%922%E2%80%89%25-green) | | Lighthouse | Time to Interactive | ๐ŸŸฅ 15.9ย s | ๐ŸŸฅ **16.4ย s** | ![โ†‘ +3โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B3%E2%80%89%25-red) | | [Code coverage](https://www.npmjs.com/package/@code-pushup/coverage-plugin/) | Function coverage | ๐ŸŸฉ 91.9 % | ๐ŸŸฉ **92 %** | ![โ†‘ +0โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B0%E2%80%89%25-green) | | [Code coverage](https://www.npmjs.com/package/@code-pushup/coverage-plugin/) | Branch coverage | ๐ŸŸจ 84 % | ๐ŸŸจ **84 %** | ![โ†‘ +0โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B0%E2%80%89%25-green) | | [Code coverage](https://www.npmjs.com/package/@code-pushup/coverage-plugin/) | Line coverage | ๐ŸŸฉ 91.5 % | ๐ŸŸฉ **91.5 %** | ![โ†‘ +0โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B0%E2%80%89%25-green) | | Lighthouse | Avoids enormous network payloads | ๐ŸŸฉ Total size was 1,792ย KiB | ๐ŸŸฉ **Total size was 1,788ย KiB** | ![โ†“ +0โ€‰%](https://img.shields.io/badge/%E2%86%93%20%2B0%E2%80%89%25-gray) | | Lighthouse | Minimizes main-thread work | ๐ŸŸฅ 19.3ย s | ๐ŸŸฅ **19.9ย s** | ![โ†‘ +3โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B3%E2%80%89%25-gray) | | Lighthouse | JavaScript execution time | ๐ŸŸฅ 9.5ย s | ๐ŸŸฅ **10.1ย s** | ![โ†‘ +6โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B6%E2%80%89%25-gray) | | Lighthouse | Metrics | ๐ŸŸฉ 15949 | ๐ŸŸฉ **16376** | ![โ†‘ +3โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B3%E2%80%89%25-gray) | | Lighthouse | Max Potential First Input Delay | ๐ŸŸฅ 2,450ย ms | ๐ŸŸฅ **2,700ย ms** | ![โ†‘ +10โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B10%E2%80%89%25-gray) | | Lighthouse | Total Blocking Time | ๐ŸŸฅ 7,450ย ms | ๐ŸŸฅ **7,310ย ms** | ![โ†“ โˆ’2โ€‰%](https://img.shields.io/badge/%E2%86%93%20%E2%88%922%E2%80%89%25-gray) | | Lighthouse | Eliminate render-blocking resources | ๐ŸŸฅ Potential savings of 1,270ย ms | ๐ŸŸฅ **Potential savings of 1,150ย ms** | ![โ†“ โˆ’9โ€‰%](https://img.shields.io/badge/%E2%86%93%20%E2%88%929%E2%80%89%25-gray) | | Lighthouse | Uses efficient cache policy on static assets | ๐ŸŸจ 27 resources found | ๐ŸŸจ **27 resources found** | ![โ†‘ +0โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B0%E2%80%89%25-gray) | | Lighthouse | Reduce unused CSS | ๐ŸŸฅ Potential savings of 105ย KiB | ๐ŸŸฅ **Potential savings of 105ย KiB** | ![โ†‘ +2โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B2%E2%80%89%25-gray) | | Lighthouse | Initial server response time was short | ๐ŸŸฉ Root document took 360ย ms | ๐ŸŸฉ **Root document took 360ย ms** | ![โ†‘ +2โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B2%E2%80%89%25-gray) | | Lighthouse | Network Round Trip Times | ๐ŸŸฉ 20ย ms | ๐ŸŸฉ **10ย ms** | ![โ†“ โˆ’42โ€‰%](https://img.shields.io/badge/%E2%86%93%20%E2%88%9242%E2%80%89%25-gray) | | Lighthouse | Server Backend Latencies | ๐ŸŸฉ 80ย ms | ๐ŸŸฉ **70ย ms** | ![โ†“ โˆ’8โ€‰%](https://img.shields.io/badge/%E2%86%93%20%E2%88%928%E2%80%89%25-gray) | | Lighthouse | Avoids an excessive DOM size | ๐ŸŸฅ 2,209 elements | ๐ŸŸฅ **2,210 elements** | ![โ†‘ +0โ€‰%](https://img.shields.io/badge/%E2%86%91%20%2B0%E2%80%89%25-gray) | 488 other audits are unchanged.