Skip to content

Conversation

@taj54
Copy link
Member

@taj54 taj54 commented Aug 5, 2025

This commit introduces a tsup.config.ts file to centralize the build configuration for the project.
The build and dev scripts in package.json have been updated to simply invoke tsup,
leveraging the new configuration file for detailed build settings.

Summary by CodeRabbit

  • Chores
    • Simplified build and development scripts for improved maintainability.
    • Introduced a new build configuration file to centralize and streamline build settings.
    • Output files now include a banner with package information.

  This commit introduces a tsup.config.ts file to centralize the build configuration for the project.
  The build and dev scripts in package.json have been updated to simply invoke tsup,
  leveraging the new configuration file for detailed build settings.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 5, 2025

Walkthrough

The build process was refactored by moving detailed tsup configuration from inline package.json scripts to a new tsup.config.ts file. The scripts in package.json now invoke tsup with default arguments, while the new config file centralizes entry points, output formats, declaration generation, and output banners.

Changes

Cohort / File(s) Change Summary
Build Script Simplification
package.json
Simplified build and dev scripts to use default tsup config, removing explicit arguments.
Tsup Configuration Introduction
tsup.config.ts
Added new config file specifying entry, formats, dts, clean, banner, and conditional watch mode for tsup.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant NPM Scripts
    participant tsup
    participant tsup.config.ts
    participant Output Files

    Developer->>NPM Scripts: Run "npm run build" or "npm run dev"
    NPM Scripts->>tsup: Invoke tsup (no explicit args)
    tsup->>tsup.config.ts: Load configuration
    tsup.config.ts-->>tsup: Provide entry, formats, dts, banner, etc.
    tsup->>Output Files: Build outputs with banner and types
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~6 minutes

Poem

A hop and a skip, the scripts are now neat,
With tsup’s config, our build is complete!
No more long commands, just simple and clear,
The bunny approves with a jubilant cheer.
🐇✨ Banners and types, all bundled just right—
This codebase now builds with effortless light!

✨ 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.

@taj54 taj54 self-assigned this Aug 5, 2025
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: 0

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

4-17: Minor build-quality tweaks you might want

  1. sourcemap: true – helps consumers debug.
  2. target: 'es2019' (or whichever baseline you support) – avoids oversized output.
  3. minify: true for production builds if bundle size matters.

None are blockers, but worth considering before publishing v0.0.3+.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eed6e67 and f8768f5.

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

20-21: Scripts now defer to default config – looks good

Moving the detailed build parameters out of the command line and into tsup.config.ts makes the scripts cleaner and less repetitive. No functional issues spotted in these two lines.

tsup.config.ts (1)

2-2: No change needed: bare JSON import is safe in tsup.config.ts

Tsup loads your TypeScript config via its built-in esbuild register hook, which transpiles

import pkg from './package.json';

into a CJS require('./package.json') under the hood. Even with "type": "module" in package.json, your tsup config runs as CommonJS, so you don’t need an assert { type: "json" }.

Likely an incorrect or invalid review comment.

@taj54 taj54 merged commit 54a98a7 into interactive-video-labs:main Aug 5, 2025
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