Skip to content

Added typings for debug/logging/pretty-stream packages#819

Merged
acburdine merged 1 commit into
mainfrom
feat/typings
Jul 15, 2026
Merged

Added typings for debug/logging/pretty-stream packages#819
acburdine merged 1 commit into
mainfrom
feat/typings

Conversation

@acburdine

Copy link
Copy Markdown
Member

no ref
these will eventually be fully re-written in TS, but these are core packages and to avoid any potential breakages this just adds basic typings files instead

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@acburdine, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 47 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8d03f1d8-ff3e-4b0d-bfee-232f81a740d1

📥 Commits

Reviewing files that changed from the base of the PR and between de9b87a and e7fa37e.

📒 Files selected for processing (10)
  • packages/debug/index.d.ts
  • packages/debug/lib/debug.d.ts
  • packages/debug/package.json
  • packages/logging/index.d.ts
  • packages/logging/lib/GhostLogger.d.ts
  • packages/logging/lib/logging.d.ts
  • packages/logging/package.json
  • packages/pretty-stream/index.d.ts
  • packages/pretty-stream/lib/PrettyStream.d.ts
  • packages/pretty-stream/package.json

Walkthrough

TypeScript declarations and package metadata were added for the debug, logging, and pretty-stream packages. The changes define public APIs for debug initialization, GhostLogger configuration and methods, and PrettyStream construction and options. Each package now has a TypeScript entrypoint using CommonJS export assignments, with package manifests configured to publish or reference index.d.ts.

Estimated code review effort: 3 (Moderate) | ~20 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding typings for the debug, logging, and pretty-stream packages.
Description check ✅ Passed The description is related to the changeset and explains that basic typings were added to core packages to avoid breakages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/typings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov-commenter

codecov-commenter commented Jul 15, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.14%. Comparing base (632d1d5) to head (e7fa37e).
⚠️ Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
packages/debug/lib/debug.d.ts 0.00% 1 Missing ⚠️
packages/logging/lib/GhostLogger.d.ts 0.00% 1 Missing ⚠️
packages/logging/lib/logging.d.ts 0.00% 1 Missing ⚠️
packages/pretty-stream/lib/PrettyStream.d.ts 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #819      +/-   ##
==========================================
- Coverage   97.94%   97.14%   -0.81%     
==========================================
  Files          98       42      -56     
  Lines        3359     1541    -1818     
  Branches      598      297     -301     
==========================================
- Hits         3290     1497    -1793     
+ Misses         18       12       -6     
+ Partials       51       32      -19     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/debug/lib/debug.d.ts`:
- Around line 17-24: Update the DebugModule interface to expose the public
formatters property as a typed formatter map, alongside the existing names and
skips members. Use the established formatter type or map shape from the debug
declarations so TypeScript users can register custom formatters through
debug.formatters.
- Line 8: Update the Debugger.color declaration to accept both browser string
values and Node numeric ANSI codes returned by selectColor(). Extend the _base
type declaration to include the real debug module’s formatters property,
preserving the existing module shape.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5095f734-3459-4007-af87-9f61c790033f

📥 Commits

Reviewing files that changed from the base of the PR and between 632d1d5 and de9b87a.

📒 Files selected for processing (10)
  • packages/debug/index.d.ts
  • packages/debug/lib/debug.d.ts
  • packages/debug/package.json
  • packages/logging/index.d.ts
  • packages/logging/lib/GhostLogger.d.ts
  • packages/logging/lib/logging.d.ts
  • packages/logging/package.json
  • packages/pretty-stream/index.d.ts
  • packages/pretty-stream/lib/PrettyStream.d.ts
  • packages/pretty-stream/package.json

Comment thread packages/debug/lib/debug.d.ts Outdated
Comment thread packages/debug/lib/debug.d.ts
no ref
these will eventually be fully re-written in TS, but these are core packages and to avoid any potential breakages this just adds basic typings files instead
@acburdine
acburdine enabled auto-merge (squash) July 15, 2026 13:04
@acburdine
acburdine merged commit 7c70c9b into main Jul 15, 2026
7 checks passed
@acburdine
acburdine deleted the feat/typings branch July 15, 2026 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants