docs: add esbuild bundling rules for require() in AGENTS.md#1011
Merged
Conversation
Document the critical rule that esbuild only resolves bare require() calls statically. Aliased requires (_require, localRequire) pass through and break in bundles when used with relative paths. Also documents the correct pattern: use createRequire for node builtins and npm packages only, keep bare require() for relative lazy imports.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the critical esbuild bundling rule that caused two post-migration bugs (#1008, #1009):
esbuild only statically resolves bare
require()calls. Any aliased require (_require,localRequire, etc.) passes through as-is into the bundle and breaks at runtime when used with relative paths.Adds a reference table and 4 key rules to AGENTS.md so AI agents and contributors avoid this pattern.
Filed #1010 for the companion testing improvements (deeper smoke tests for binary + npm bundle).