Skip to content

Expose esbuild keepNames and minify options (experimental) #2091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 22, 2025

Conversation

nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented May 22, 2025

The minify option can decrease bundle sizes by up to half, if not more. It could also break a lot of stuff, hence experimental.
The keepNames option can fix issues in frameworks like MikroORM. Unsure about potential to break things, but best to be safe.
Both disabled by default.

Copy link

changeset-bot bot commented May 22, 2025

🦋 Changeset detected

Latest commit: 613612c

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

coderabbitai bot commented May 22, 2025

Walkthrough

This change adds two new optional boolean properties, experimental_keepNames and experimental_minify, to the build configuration object within the TriggerConfig type. Both options are marked as experimental and deprecated, with documentation indicating they may be removed in the future. The createBuildOptions function is updated to read these options from the configuration and pass them to esbuild, controlling the preservation of function/class names and enabling minification, respectively. Changelog entries are added to document the exposure of these experimental features for the trigger.dev and @trigger.dev/core packages. No other functional or structural changes are present.

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
    • @coderabbitai modularize this function.
  • 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 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: 0

🧹 Nitpick comments (1)
packages/core/src/v3/config.ts (1)

186-213: Well-documented experimental features

The addition of experimental options for esbuild configuration looks good. Both experimental_keepNames and experimental_minify are clearly documented with appropriate warnings, default values, and links to esbuild documentation.

Some suggestions:

  • Consider providing examples of when each option might be useful in specific scenarios
  • Maybe add a note about how much bundle size reduction users might expect with minification
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c8d252e and 613612c.

⛔ Files ignored due to path filters (2)
  • references/v3-catalog/src/trigger/binaries.ts is excluded by !references/**
  • references/v3-catalog/trigger.config.ts is excluded by !references/**
📒 Files selected for processing (4)
  • .changeset/gold-insects-invite.md (1 hunks)
  • .changeset/wild-mirrors-return.md (1 hunks)
  • packages/cli-v3/src/build/bundle.ts (2 hunks)
  • packages/core/src/v3/config.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (4)
.changeset/gold-insects-invite.md (1)

1-7: LGTM - Clear changelog entry

The changeset correctly identifies the affected packages and indicates this is a patch-level change, which is appropriate for an experimental feature addition.

.changeset/wild-mirrors-return.md (1)

1-7: LGTM - Clear changelog entry

The changeset correctly identifies the affected packages and indicates this is a patch-level change, which is appropriate for an experimental feature addition.

packages/cli-v3/src/build/bundle.ts (2)

179-181: LGTM - Properly handling experimental options

The variables are correctly initialized with default values matching the documentation.


191-192: LGTM - Proper integration with esbuild options

The new experimental options are correctly applied to the esbuild configuration, replacing the hardcoded minify: false with the configurable option.

Also applies to: 198-199

@nicktrn nicktrn merged commit 1ca37f5 into main May 22, 2025
12 checks passed
@nicktrn nicktrn deleted the feat/experimental-keepnames branch May 22, 2025 09:42
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