Skip to content

chore(deps): depend on bun-types directly instead of @types/bun - #25

Merged
ugi-dev merged 2 commits into
mainfrom
chore/bun-types-direct
Nov 7, 2026
Merged

ugi-dev merged 2 commits into
mainfrom
chore/bun-types-direct

Conversation

@ugi-dev

@ugi-dev ugi-dev commented Nov 7, 2026 •

Copy link
Copy Markdown
Member

Closes #27

Summary

@types/bun is a stub package. Its whole index.d.ts is /// <reference types="bun-types" />, and it depends on bun-types, which holds the actual declarations. Socket scores the stub low:

Package Overall Quality License
@types/bun@1.4.4 47 47 100
bun-types@1.4.4 81 84 70

This replaces the root dev dependency @types/bun with bun-types@^1.4.4 and changes "types": ["bun"] to ["bun-types"] in every tsconfig.json that used it (six packages plus sites/docs). The resolved types are the same; only the indirection goes away.

The License score drops to 70 because of the copyleft flag on bun-types. The repo already depended on bun-types through @types/bun, so this exposure isn't new.

This is independent of #24. Whichever merges second needs a bun.lock rebase.

Testing

Removed the leftover node_modules/@types/bun before testing so it couldn't hide a missing reference. bun run typecheck, bun run test and bun run check all pass.


Summary by cubic

Swaps the @types/bun stub dependency for bun-types directly. @types/bun is a one-line reference stub (/// <reference types="bun-types" />) that Socket scores at 47 for quality, while bun-types holds the actual declarations and scores 84. The resolved types are unchanged; only the indirection is removed.

  • Updates the root devDependencies and the types array in seven tsconfig.json files from "bun" to "bun-types".
  • bun-types's copyleft flag drops the Socket license score to 70, but the repo already depended on it through @types/bun, so the exposure isn't new.

Written for commit 13d1623. Summary will update on new commits.

View guided diff Turn on auto-fix

Summary by CodeRabbit

  • Chores
    • Updated project TypeScript configurations to use the bun-types definitions consistently across packages and documentation.
    • No user-facing features or behavior changed.

@types/bun is a one-line stub (`/// <reference types="bun-types" />`)
that Socket scores at 47 for quality. bun-types holds the actual
declarations and scores 84, so depend on it directly and point the
tsconfig `types` arrays at it. The resolved types are unchanged.
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-07T23:14:45.647255Z 7264101 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Nov 7, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The root development dependency changes from @types/bun to bun-types at ^1.4.4. Seven TypeScript configurations now specify bun-types instead of bun.

Changes

Bun type package update

Layer / File(s) Summary
Dependency and TypeScript configuration
package.json, packages/*/tsconfig.json, sites/docs/tsconfig.json
The root development dependency changes to bun-types at ^1.4.4. The TypeScript types option changes to bun-types in seven package and documentation-site configurations.

Estimated code review effort: 2 (Simple) | ~7 minutes

Possibly related PRs

  • vortexkit/kirari#24: Changes the same root dependency entry. It updates @types/bun to ^1.4.4; this PR replaces that package with bun-types.
  • vortexkit/kirari#20: Adds three tsconfig.json files that this PR updates to use bun-types.
Merge Risk: Minimal · up to 13d16

The change replaces the Bun types stub with the direct package. No actionable merge-blocking risk is identified.

Pre-merge checks: Passed 5

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title states the main change: the root dependency moves from @types/bun to bun-types, and the tsconfig types arrays are updated to match. The raw summary and PR objectives both confirm this. The t…
Linked Issues check Passed Issue #27 has two coding requirements. (1) Depend on bun-types directly. The root package.json change replaces the devDependency @types/bun (^1.4.4) with bun-types (^1.4.4). (2) Point the tsconfig typ…
Out of Scope Changes check Passed Every listed change serves #27. The package.json change swaps the stub dependency for bun-types. The seven tsconfig.json changes update the types array to bun-types. No other source, test, or configur…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Full details: Title check

Explanation

The title states the main change: the root dependency moves from @types/bun to bun-types, and the tsconfig types arrays are updated to match. The raw summary and PR objectives both confirm this. The title does not name the tsconfig updates, but it is a specific and accurate summary of the primary change.

Full details: Linked Issues check

Explanation

Issue #27 has two coding requirements. (1) Depend on bun-types directly. The root package.json change replaces the devDependency @types/bun (^1.4.4) with bun-types (^1.4.4). (2) Point the tsconfig types arrays at bun-types. Seven tsconfig.json files change "bun" to "bun-types": packages/compat-react, packages/compat-rehype, packages/compat, packages/kirari, packages/react, packages/rehype, and sites/docs. The PR states that the resolved types are unchanged and that typecheck, test, and check pass after deleting node_modules/@types/bun. No requirement in #27 is unmet. bun.lock is excluded from review under the rule !**/*.lock, so the lockfile update is not assessed. This does not affect the result, because the issue requirements concern package.json and tsconfig.json. The evidence comes from the change summary and the PR description. No repository inspection was available to confirm that no other tsconfig.json still references "bun".

Full details: Out of Scope Changes check

Explanation

Every listed change serves #27. The package.json change swaps the stub dependency for bun-types. The seven tsconfig.json changes update the types array to bun-types. No other source, test, or configuration change appears in the summary. The bun.lock change is excluded from review and is not assessed. It is the expected lockfile result of the dependency swap. The PR description states that the change is independent of PR #24 and that a bun.lock rebase is needed if #24 merges first. That note is administrative and does not add code scope.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 7264101 and 13d1623.

Files ignored due to path filters: 1

  • bun.lock is excluded by !**/*.lock
Files selected for processing: 1

  • package.json

Included review availability: This review used your included allowance. 2 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 9 files

View guided diff | Turn on auto-fix | Re-trigger cubic

@ugi-dev
ugi-dev merged commit f68594e into main Nov 7, 2026
12 checks passed
@ugi-dev
ugi-dev deleted the chore/bun-types-direct branch November 7, 2026 23:25
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.

Replace @types/bun stub with bun-types

1 participant