docs(bundler): sync manifest loader fs notes#5957
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 (7)
📝 WalkthroughWalkthroughThis PR updates documentation across bundler tool guides, core loader implementation, and package wikis to describe how bundled workers use manifest-backed loader filesystem for module discovery and resolution, with automatic filesystem fallback for paths outside the manifest. ChangesManifest-Backed Loader Filesystem Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 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 markdown files (including READMEs, wiki pages, and package docs) to reflect the integration of the manifest-backed loader filesystem (ManifestLoaderFS). It documents how the generated worker entry now creates a ManifestLoaderFS from the startup manifest and passes it to startEgg(), allowing file discovery and module loading to be served from the manifest before falling back to the real filesystem. Since there are no review comments, I have no additional feedback to provide.
Deploying egg with
|
| Latest commit: |
380f300
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://62f10c5f.egg-cci.pages.dev |
| Branch Preview URL: | https://agent-egg-doc-6fce9f0e.egg-cci.pages.dev |
There was a problem hiding this comment.
Pull request overview
This PR synchronizes repository documentation to reflect that bundled workers now create a manifest-backed loader filesystem (ManifestLoaderFS) and pass it into startEgg() so loader file discovery/JSON reads/module loading can use manifest data with a real-FS fallback.
Changes:
- Update bundler docs to describe creating
ManifestLoaderFSand passingloaderFSintostartEgg(). - Update wiki package pages (
@eggjs/core,@eggjs/loader-fs,@eggjs/egg-bundler) to documentManifestLoaderFSownership/exports and the LoaderFS boundary in bundled runtimes. - Add a wiki log entry recording the doc sync and touched sources/pages.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| wiki/packages/loader-fs.md | Clarifies @eggjs/loader-fs as the shared LoaderFS interface + real FS impl, and points manifest-backed impl to @eggjs/core. |
| wiki/packages/egg-bundler.md | Updates bundle flow/current behavior to state ManifestLoaderFS is created and passed to startEgg(). |
| wiki/packages/core.md | Documents that @eggjs/core exports ManifestLoaderFS alongside re-exporting LoaderFS/RealLoaderFS. |
| wiki/log.md | Adds a 2026-06-02 entry recording the manifest-backed loader FS doc sync. |
| wiki/index.md | Updates the Loader FS package blurb to remove “future” wording now that bundling is present. |
| tools/egg-bundler/README.md | Describes the runtime behavior as using a manifest-backed loader filesystem with fallback to real FS. |
| tools/egg-bundler/docs/output-structure.md | Expands runtime docs to include ManifestLoaderFS creation and loaderFS passed to startEgg(). |
Deploying egg-v3 with
|
| Latest commit: |
380f300
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5364a010.egg-v3.pages.dev |
| Branch Preview URL: | https://agent-egg-doc-6fce9f0e.egg-v3.pages.dev |
Summary
Verification
Note: npm run fmtcheck could not run from the clean checkout because oxfmt was not installed; using pnpm dlx, the repo-wide check reports pre-existing package.json formatting issues outside this patch.
Summary by CodeRabbit