feat(cli-logger): Publish the CLI logger as @sentry/cli-logger by sentry-junior[bot] · Pull Request #1773 · getsentry/toolkit

sentry-junior · 2026-10-31T15:39:38Z

Moves the logger from #1771 out of packages/cli/src/lib/logger.ts into a new packages/cli-logger workspace package, published to npm as @sentry/cli-logger.

Package API

createLogger({ level, env, formatTime, prompt }) returns a root logger. Its withTag() loggers share the root's level and reporter list, as before. Each root has its own state, so the module-level singleton is gone from the package.
Exports parseLogLevel, LOG_LEVEL_NAMES, formatLocalTime, and the LogObject/LogReporter/Prompt types. Records still have consola's shape, so Sentry.createConsolaReporter() works with addReporter().
@sentry/cli-logger/prompt exports clackPrompt. @clack/prompts is an optional peer dependency, and the main entry never references it.

How the CLI-local pieces were split out

getEnv() → the env option, read on each log call. The CLI passes getEnv, so library mode's isolated env still controls colors and layout. A CLI test covers this with withEnv.
formatLogTime() → moved into the package as the default formatLocalTime, since only the logger used it. Its tests moved with it.
SENTRY_CLI_COMPLETION_BUILD → stays in the CLI. The CLI's askUser keeps the define guard and lazy-imports @sentry/cli-logger/prompt, so dist/complete.cjs still contains no @clack/prompts. The package itself has no build-time globals.

packages/cli/src/lib/logger.ts keeps every export it had, so its ~170 importers and the vi.mock calls in tests don't change.

Packaging and release

In the workspace, exports point at src/*.ts, like toolkit-core, so the CLI's esbuild bundle, vitest, and tsc need no build step. publishConfig.exports points the packed tarball at the tsdown ESM/CJS dist/, with .d.ts/.d.cts types.
New cli-logger craft workspace (tag prefix cli-logger@, release branch release/cli-logger/*) and a cli-logger option in the Release workflow. Post-merge jobs now also pack the tarball into the commit's artifact.
New CLI Logger Package workflow: it packs the package, installs it into a clean npm project, typechecks ESM and CJS consumers, and runs both.

Decisions to confirm

Name: @sentry/cli-logger. It's free on npm. I avoided @sentry/logger because it reads like the SDK's logger.
License: FSL-1.1-Apache-2.0, same as the CLI and the repo. Say so if this should be a more permissive license for a reusable library.
Version starts at 0.1.0. The first npm publish happens when someone runs Release with cli-logger.

via @BYK.

--

View Session in Sentry

Move the logger from packages/cli/src/lib/logger.ts into a new packages/cli-logger workspace package, published to npm as @sentry/cli-logger. createLogger() takes the CLI-specific pieces as options: env (the CLI passes getEnv for library mode) and prompt (the CLI keeps its completion-build guard around clackPrompt). formatLogTime moves into the package as the default formatLocalTime. The CLI's logger.ts keeps its exports, so callers and test mocks do not change. Releases go through the Release workflow's new cli-logger product. Fixes #1772 Co-Authored-By: BYK <126780+BYK@users.noreply.github.com>

vercel · 2026-10-31T15:39:44Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
sentry-local	Ready	Preview	Oct 31, 2026 3:41pm UTC

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 3b25814. Configure here.}

cursor · 2026-10-31T15:44:47Z

          end
+  packages/cli-logger:
+    changelog:
+      policy: auto


Craft auto changelog lacks CHANGELOG

Medium Severity

The new cli-logger Craft workspace sets changelog.policy to auto, but packages/cli-logger has no CHANGELOG.md. The CLI workspace that uses the same policy keeps that file next to the package. Craft’s prepare step reads and updates it, so the first cli-logger release can fail before npm publish.

^{Reviewed by Cursor Bugbot for commit 3b25814. Configure here.}

Checked this against Craft: with changelog.policy: auto, prepareChangelog creates the missing file instead of failing (src/commands/prepare.ts: if (!existsSync(relativePath)) { if (changelogPolicy === ChangelogPolicy.Auto) { ... safeFs.writeFile(relativePath, "# Changelog\n") } ...}). That code is in the v3 tag release.yml uses. For a workspace, the default path is <workspace>/CHANGELOG.md (getDefaultChangelogFilePath in src/config.ts), so the first cli-logger release creates packages/cli-logger/CHANGELOG.md and commits it on the release branch. Leaving the config as is.

BYK · 2026-11-01T14:07:48Z

+          echo '{ "private": true, "type": "module" }' > package.json
+          npm install --ignore-scripts --no-audit --no-fund "$RUNNER_TEMP"/sentry-cli-logger-*.tgz @clack/prompts@0.11.0 typescript@^5.8.3 @types/node@^22
+
+          cat > tsconfig.json <<'EOF'


Why not make these actual files on the disk??

BYK · 2026-11-01T14:08:09Z

@@ -0,0 +1,100 @@
+name: CLI Logger Package


Why CLI logger? Is this not a general-purpose Node/Bun etc logger?

BYK · 2026-11-01T14:08:58Z

+          - cli-logger
          - mcp
      bump:
        description: Version bump type


Do you think we can make Craft do this without a script? If yes, let's file an issue there?

BYK · 2026-11-01T14:09:31Z

 For package-specific rules, see the root [AGENTS.md](../AGENTS.md) and the
 [CLI AGENTS.md](../packages/cli/AGENTS.md). `packages/toolkit-core/` contains
-shared primitives used by both products.
+shared primitives used by both products. `packages/cli-logger/` is the CLI's


The reason I want to publish this logger as a standalone package is because I think it can be useful to others so naming it cli-logger feels unnecessarily specific.

BYK · 2026-11-01T14:11:53Z

+ * 1. **The stderr reporter** (built in) — renders consola's "fancy" layout
+ *    (icons, colors, `WARN`/`ERROR` badges, a right-aligned `tag HH:MM:SS`) and
+ *    falls back to plain `[type] [tag] message` lines in CI and tests.
+ * 2. **Any reporter passed to `addReporter()`**, such as


I wonder if we can architecture this in a better way:

Start with structured logs with built-in Sentry support (not required and it should not directly depend on any Sentry package -- can be optional peer dependencies or just use debug channels), then add reporters. One being the consola-style fancy, one JSON, and one logfmt.

BYK · 2026-11-01T14:12:59Z

Not sure prompting should be part of a logging package. I think this needs to live outside, especially because it also requires an external dependency. Ideally, our logger package will be tiny, type-safe, and dependency-free.

BYK · 2026-11-01T14:13:24Z

@@ -0,0 +1,105 @@
+# Functional Source License, Version 1.1, Apache 2.0 Future License


I think we can make this one Apache-2 or MIT.

BYK · 2026-11-01T14:13:37Z

@@ -0,0 +1,88 @@
+{
+  "name": "@sentry/cli-logger",
+  "version": "0.1.0",


Let's start with v1

BYK · 2026-11-01T14:13:58Z

@@ -0,0 +1,140 @@
+# @sentry/cli-logger
+
+A small terminal logger for Node.js command-line tools: log levels, tag scoping,


Don't forget to update this README based on my other feedback. We should also explain our rationale for coming up with yet another logging library.

sentry-junior Bot assigned BYK Oct 31, 2026

github-actions Bot added the risk: medium PR risk score: medium label Oct 31, 2026

vercel Bot deployed to Preview October 31, 2026 15:41

View deployment

cursor Bot reviewed Oct 31, 2026

View reviewed changes

BYK requested changes Nov 1, 2026

View reviewed changes

		@@ -0,0 +1,105 @@
		# Functional Source License, Version 1.1, Apache 2.0 Future License

		@@ -0,0 +1,140 @@
		# @sentry/cli-logger

		A small terminal logger for Node.js command-line tools: log levels, tag scoping,

Conversation

sentry-junior Bot commented Oct 31, 2026

Uh oh!

vercel Bot commented Oct 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor Bot Oct 31, 2026

Choose a reason for hiding this comment

Craft auto changelog lacks CHANGELOG

Uh oh!

sentry-junior Bot Oct 31, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This branch was successfully deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

vercel Bot commented Oct 31, 2026 •

edited

Loading