docs(bundler): document manifest loader fs runtime#5956
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThis PR updates documentation across bundler, core, and wiki artifacts to describe the new ChangesManifestLoaderFS Worker Initialization Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Code Review
This pull request updates the documentation across several files (including READMEs, guides, and wiki logs) to reflect the introduction of the manifest-backed loader filesystem (ManifestLoaderFS) in the Egg bundler runtime. The documentation now details how the bundled worker entry creates a ManifestLoaderFS from the startup manifest and passes it to startEgg to handle file discovery and module loading. There are no review comments to address, and no further feedback is required.
Deploying egg with
|
| Latest commit: |
1e571ef
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://54854dcd.egg-cci.pages.dev |
| Branch Preview URL: | https://agent-egg-doc-d0743594.egg-cci.pages.dev |
There was a problem hiding this comment.
Pull request overview
Documents the current bundled-worker runtime behavior in @eggjs/egg-bundler and @eggjs/core, specifically that bundled workers now construct a ManifestLoaderFS from the bundled startup manifest and pass it into Egg startup so loader filesystem operations can be served from manifest/bundle-map data with real-FS fallback.
Changes:
- Update bundler docs to describe creating
ManifestStore+ManifestLoaderFSand passingloaderFSintostartEgg(...). - Update the core wiki page to document
ManifestLoaderFSas the manifest-backed bundled-runtimeLoaderFSimplementation and how it interacts with__EGG_BUNDLE_MODULE_LOADER__. - Add a wiki log entry for the 2026-05-30 doc sync and update wiki page
updated_atmetadata.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| wiki/packages/egg-bundler.md | Updates the wiki description of bundled worker startup to include ManifestLoaderFS being created and passed into Egg startup. |
| wiki/packages/core.md | Documents ManifestLoaderFS as part of the LoaderFS surface and describes how it serves reads from manifest + bundle loader before fallback. |
| wiki/log.md | Adds a 2026-05-30 entry recording the doc sync and the manifest-backed loader FS runtime behavior. |
| tools/egg-bundler/README.md | Clarifies that runtime file discovery/module loading is served through Egg’s manifest-backed loader filesystem. |
| tools/egg-bundler/docs/output-structure.md | Expands the runtime description to explicitly include ManifestStore + ManifestLoaderFS creation and passing loaderFS to startEgg. |
Deploying egg-v3 with
|
| Latest commit: |
1e571ef
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://85829f58.egg-v3.pages.dev |
| Branch Preview URL: | https://agent-egg-doc-d0743594.egg-v3.pages.dev |
|
|
||
| Dates use the workspace-local Asia/Shanghai calendar date. | ||
|
|
||
| ## [2026-05-30] package | document manifest-backed loader fs runtime |
Summary
ManifestLoaderFSinto Egg startupVerification
git diff --checkXDG_CACHE_HOME=/tmp/xdg-cache XDG_DATA_HOME=/tmp/xdg-data PNPM_HOME=/tmp/pnpm-home pnpm dlx oxfmt@0.46.0 --check tools/egg-bundler/README.md tools/egg-bundler/docs/output-structure.md wiki/log.md wiki/packages/core.md wiki/packages/egg-bundler.mdNote:
pnpm run fmtcheckcould not run directly before install because dependencies were absent.pnpm install --frozen-lockfilecould not proceed because this checkout has nopnpm-lock.yamland pnpm reported a frozen lockfile/config mismatch, so I ran the same formatter version viapnpm dlxon the touched files.Summary by CodeRabbit