Skip to content

Conversation

@taj54
Copy link
Member

@taj54 taj54 commented Aug 5, 2025

This commit migrates the tsup build and dev configurations from package.json scripts to a dedicated
tsup.config.ts file. This centralizes the build configuration and improves maintainability.

Summary by CodeRabbit

  • Chores
    • Simplified build and development scripts for improved maintainability.
    • Updated TypeScript configuration for enhanced module resolution compatibility.
    • Introduced a new build configuration file to streamline and standardize the build process, including automatic banner injection in build outputs.

  This commit migrates the tsup build and dev configurations from package.json scripts to a dedicated
  tsup.config.ts file. This centralizes the build configuration and improves maintainability.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 5, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update the project's build configuration by introducing a dedicated tsup.config.ts file, shifting detailed build options away from package.json scripts. The TypeScript module resolution strategy is switched to "bundler" in tsconfig.json. Build scripts in package.json are simplified to rely on the new config file.

Changes

Cohort / File(s) Change Summary
Build Script Simplification
package.json
Simplified build and dev scripts to use tsup without explicit entry or format arguments, delegating configuration to the new config file.
TypeScript Config Update
tsconfig.json
Changed moduleResolution from "Node" to "bundler" for module import resolution.
Tsup Configuration Introduction
tsup.config.ts
Added a new config file exporting a defineConfig setup for tsup, specifying entry, formats, watch mode, cleaning output, TypeScript declarations, and a dynamic banner with package info.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant npm/yarn
    participant tsup
    participant tsup.config.ts
    participant Output

    Developer->>npm/yarn: Run "npm run build" or "npm run dev"
    npm/yarn->>tsup: Execute tsup (no explicit args)
    tsup->>tsup.config.ts: Load configuration
    tsup.config.ts-->>tsup: Provide build options (entry, formats, dts, banner, etc.)
    tsup->>Output: Bundle files, generate outputs, inject banner
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

Poem

A rabbit hops through configs anew,
Scripts now simple, clear, and true.
With tsup’s wisdom in a file apart,
Bundler paths give builds a start.
A banner waves with author’s cheer—
These tidy changes bring us near
To builds that sparkle, swift and smart! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 15f6f91 and 99fc6ba.

📒 Files selected for processing (1)
  • tsup.config.ts (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Nitpick comments (1)
tsup.config.ts (1)

10-16: Minor: banner string contains leading indentation that will appear in the output files.

The four-space indent inside the template literal is preserved verbatim. Dropping it yields a cleaner header:

-    banner: {
-        js: `/**
- * ${pkg.name} v${pkg.version}
- * Author: ${pkg.author}
- */
-    `,
-    },
+    banner: {
+        js: `/**\n * ${pkg.name} v${pkg.version}\n * Author: ${pkg.author}\n */`,
+    },
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aea2070 and 15f6f91.

📒 Files selected for processing (3)
  • package.json (1 hunks)
  • tsconfig.json (1 hunks)
  • tsup.config.ts (1 hunks)
🔇 Additional comments (1)
tsconfig.json (1)

5-5: Switching to moduleResolution: "bundler" can break editor / test tooling – double-check downstream consumers.

"bundler" opts-in to TypeScript 5’s new resolution algorithm. Tools that still rely on classic/Node resolution (e.g. ts-node, older ESLint configs, Vitest when using threads: false) may suddenly fail to locate declaration files or stubbed modules.

Before merging, please run the full test suite and a cold-start IDE type-check to ensure no regressions. If issues surface, consider conditionally overriding the setting in a dedicated tsconfig.build.json.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@taj54 taj54 merged commit 6860d20 into interactive-video-labs:main Aug 5, 2025
0 of 2 checks passed
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.

1 participant