feat(utils): implement custom logger with groups and tasks by matejchalk · Pull Request #1129 · code-pushup/cli

matejchalk · 2025-10-17T15:43:16Z

Part of #888

This PR implements and tests a new custom Logger class, intended to replace our current logging with @poppinss/cliui, multi-progress-bars, etc. To minimize the scope of this PR, the new logger is unused. I've included a demo script and have tested the implementation manually in GitHub Actions and GitLab CI/CD. There's a comprehensive integration test suite and documentation.

Features

Standardized colors for log levels (ansis).
Automatically toggles debug logs depending on --verbose flag or CP_VERBOSE environment variable.
Renders spinners for asynchronous tasks (ora).
Render log groups, useful for executing plugins.
- Supports spinners within groups.
- Prefers native collapsible log groups if GITHUB_ACTIONS or GITLAB_CI environment detected.
Automatically logs durations for async spinners and groups.
Handles errors to ensure it's clear in which task an error was thrown. Also handles signal interruption.
Propagates state (group, verbosity) to other logger instances, so logs from plugins should be rendered properly.

Examples

🎥 Default (local) - colors, spinners, groups

screen-capture.-.2025-10-17T175651.556.webm

🎥 Verbose - debug logs

screen-capture.-.2025-10-17T175515.228.webm

🎥 CI - spinners disabled

screen-capture.-.2025-10-17T180140.476.webm

🖼️ GitHub Actions - groups log lines using workflow commands (always collapsed by default)

source: workflow run

🖼️ GitLab CI/CD - renders collapsible sections (collapsed by default, unless verbose)

source: pipeline run

🎥 Error handling in plugin - completes spinner and group before re-throw

screen-capture.-.2025-10-17T180300.976.webm

🎥 Error handling in core - completes spinner before re-throw

screen-capture.-.2025-10-17T180344.316.webm

🎥 Error handling for SIGINT cancellation - completes spinner before exiting

screen-capture.-.2025-10-17T180603.703.webm

…uration

… handling

nx-cloud · 2025-10-17T15:44:27Z

View your CI Pipeline Execution ↗ for commit d3ff1a9

Command	Status	Duration	Result
`nx code-pushup --nx-bail -- compare`	✅ Succeeded	49s	View ↗
`nx code-pushup --nx-bail --`	✅ Succeeded	1m 3s	View ↗
`nx code-pushup --nx-bail -- print-config --outp...`	✅ Succeeded	3m 49s	View ↗

☁️ Nx Cloud last updated this comment at 2025-10-17 17:55:21 UTC

nx-cloud · 2025-10-17T15:44:27Z

View your CI Pipeline Execution ↗ for commit 963eebd

Command	Status	Duration	Result
`nx affected -t unit-test --parallel=3`	❌ Failed	8s	View ↗
`nx affected -t int-test --parallel=3`	✅ Succeeded	6s	View ↗

☁️ Nx Cloud last updated this comment at 2025-10-17 15:44:27 UTC

pkg-pr-new · 2025-10-17T15:44:53Z

Open in StackBlitz

@code-pushup/ci

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

@code-pushup/cli

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

@code-pushup/core

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

@code-pushup/create-cli

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

@code-pushup/models

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

@code-pushup/nx-plugin

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

@code-pushup/coverage-plugin

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

@code-pushup/eslint-plugin

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

@code-pushup/js-packages-plugin

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

@code-pushup/jsdocs-plugin

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

@code-pushup/lighthouse-plugin

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

@code-pushup/typescript-plugin

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

@code-pushup/utils

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

@code-pushup/models-transformers

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

commit: d3ff1a9

github-actions · 2025-10-17T17:03:59Z

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit d073ab6 with previous commit 42fa531.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Documentation	🔴 24	🔴 36
Performance	🔴 35	🔴 34
Updates	🟡 81	🟡 81
Code coverage	🟡 90	🟢 90
Security	🟡 56	🟡 56	–
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	–

👍 3 groups improved, 👎 1 group regressed, 👍 9 audits improved, 👎 4 audits regressed, 15 audits changed without impacting score

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score
JSDoc coverage	Documentation coverage	🔴 24	🔴 36
Lighthouse	Performance	🔴 35	🔴 34
JS Packages	NPM outdated dependencies	🟡 81	🟡 81
Code coverage	Code coverage metrics	🟡 90	🟢 90

17 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value
JSDoc coverage	Methods coverage	🟥 1 undocumented methods	🟨 9 undocumented methods
JSDoc coverage	Classes coverage	🟥 8 undocumented classes	🟥 8 undocumented classes
Lighthouse	First Contentful Paint	🟥 3.3 s	🟥 3.1 s
Lighthouse	Total Blocking Time	🟥 1,870 ms	🟥 2,420 ms
Lighthouse	Speed Index	🟥 7.2 s	🟥 7.3 s
Lighthouse	Time to Interactive	🟥 13.5 s	🟥 13.3 s
JS Packages	Outdated NPM prod dependencies.	🟨 16 outdated package versions (4 major, 8 minor, 4 patch)	🟨 16 outdated package versions (4 major, 8 minor, 4 patch)
JSDoc coverage	Variables coverage	🟥 292 undocumented variables	🟥 293 undocumented variables
Code coverage	Branch coverage	🟨 85.5 %	🟨 85.8 %
Code coverage	Line coverage	🟨 86.3 %	🟨 86.6 %
Code coverage	Function coverage	🟩 92.5 %	🟩 92.8 %
JSDoc coverage	Types coverage	🟥 241 undocumented types	🟥 243 undocumented types
JSDoc coverage	Functions coverage	🟥 520 undocumented functions	🟥 525 undocumented functions
Lighthouse	Avoids enormous network payloads	🟩 Total size was 2,033 KiB	🟩 Total size was 2,029 KiB
Lighthouse	Minimizes main-thread work	🟥 12.6 s	🟥 14.0 s
Lighthouse	Uses efficient cache policy on static assets	🟨 30 resources found	🟨 30 resources found
Lighthouse	Server Backend Latencies	🟩 2,070 ms	🟩 1,230 ms
Lighthouse	JavaScript execution time	🟥 5.0 s	🟥 5.6 s
Lighthouse	Largest Contentful Paint	🟥 12.0 s	🟥 11.4 s
Lighthouse	Initial server response time was short	🟥 Root document took 660 ms	🟥 Root document took 800 ms
Lighthouse	Metrics	🟩 100%	🟩 100%
Lighthouse	Remove duplicate modules in JavaScript bundles	🟥 Potential savings of 99 KiB	🟥 Potential savings of 99 KiB
Lighthouse	Reduce unused JavaScript	🟥 Potential savings of 180 KiB	🟥 Potential savings of 180 KiB
Lighthouse	Reduce unused CSS	🟥 Potential savings of 102 KiB	🟥 Potential savings of 102 KiB
Lighthouse	Max Potential First Input Delay	🟥 1,410 ms	🟥 1,430 ms
Lighthouse	Network Round Trip Times	🟩 50 ms	🟩 70 ms
JSDoc coverage	Properties coverage	🟥 4 undocumented properties	🟥 14 undocumented properties
Lighthouse	Cumulative Layout Shift	🟩 0	🟩 0

582 other audits are unchanged.

package.json

vmasek

awesome work 👏🏻

matejchalk added 10 commits October 16, 2025 12:34

feat(utils): add utility for rounding to max decimals, use in formatD…

7b29052

…uration

feat(utils): add settlePromise helper for convenient rejected promise…

4c40923

… handling

feat(utils): add unix timestamp conversion

1368c77

feat(utils): implement custom logger with groups and tasks

0568a94

test(utils): test log levels and log groups

034319c

test(utils): test logger's spinners

8c4ecfb

fix(utils): ensure multiline logs during spinner are indented properly

a7d7975

test(utils): test spinners combined with groups

46cf102

feat(utils): throw if invalid group/spinner combinations used in logger

ef748e5

feat(utils): export shared logger instance

5815f82

github-actions bot assigned matejchalk Oct 17, 2025

github-actions bot added 🔬 testing writing tests 🧩 utils 🧩 lighthouse-plugin 🛠️ tooling labels Oct 17, 2025

matejchalk added 3 commits October 17, 2025 18:34

chore(utils): add logger demo script

df56f5b

fix(utils): avoid formatting milliseconds with decimals

e1db0f2

docs(utils): add jsdocs descriptions to public logger methods

cb83b9e

matejchalk force-pushed the logger-implementation branch from 963eebd to f525e5c Compare October 17, 2025 16:57

matejchalk force-pushed the logger-implementation branch 3 times, most recently from 1b97d8c to 4fd1e6c Compare October 17, 2025 17:23

test(utils): make spinner symbols os-indepedent in tests

d3ff1a9

matejchalk force-pushed the logger-implementation branch from 4fd1e6c to d3ff1a9 Compare October 17, 2025 17:40

matejchalk marked this pull request as ready for review October 17, 2025 17:55

matejchalk requested a review from BioPhoton as a code owner October 17, 2025 17:55

matejchalk requested review from hanna-skryl and vmasek October 17, 2025 17:56

matejchalk added the ➕ enhancement new feature or request label Oct 17, 2025

vmasek reviewed Oct 17, 2025

View reviewed changes

package.json Show resolved Hide resolved

vmasek approved these changes Oct 17, 2025

View reviewed changes

matejchalk merged commit a0057fe into main Oct 22, 2025
22 checks passed

matejchalk deleted the logger-implementation branch October 22, 2025 07:13

matejchalk mentioned this pull request Oct 30, 2025

feat(ci): use new shared logger #1132

Merged

matejchalk mentioned this pull request Nov 18, 2025

feat(core): replace progress bar with log groups #1149

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(utils): implement custom logger with groups and tasks#1129

feat(utils): implement custom logger with groups and tasks#1129
matejchalk merged 14 commits intomainfrom
logger-implementation

matejchalk commented Oct 17, 2025 •

edited

Loading

Uh oh!

nx-cloud bot commented Oct 17, 2025 •

edited

Loading

Uh oh!

nx-cloud bot commented Oct 17, 2025

Uh oh!

pkg-pr-new bot commented Oct 17, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 17, 2025 •

edited

Loading

🗃️ Groups

🛡️ Audits

Uh oh!

Uh oh!

vmasek left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

matejchalk commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Features

Examples

Uh oh!

nx-cloud bot commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nx-cloud bot commented Oct 17, 2025

Uh oh!

pkg-pr-new bot commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code PushUp

🏷️ Categories

🗃️ Groups

🛡️ Audits

Uh oh!

Uh oh!

vmasek left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

matejchalk commented Oct 17, 2025 •

edited

Loading

nx-cloud bot commented Oct 17, 2025 •

edited

Loading

pkg-pr-new bot commented Oct 17, 2025 •

edited

Loading

github-actions bot commented Oct 17, 2025 •

edited

Loading