Skip to content

docs(bundler): sync manifest loader fs notes#5957

Open
killagu wants to merge 1 commit into
nextfrom
agent/egg-doc/6fce9f0e
Open

docs(bundler): sync manifest loader fs notes#5957
killagu wants to merge 1 commit into
nextfrom
agent/egg-doc/6fce9f0e

Conversation

@killagu
Copy link
Copy Markdown
Contributor

@killagu killagu commented Jun 1, 2026

Summary

  • document that bundled workers create ManifestLoaderFS and pass loaderFS into startEgg
  • update egg-bundler output structure docs and wiki package pages for manifest-backed loader FS
  • add wiki log entry for the doc sync

Verification

  • git diff --check
  • pnpm dlx oxfmt --check tools/egg-bundler/README.md tools/egg-bundler/docs/output-structure.md wiki/index.md wiki/log.md wiki/packages/core.md wiki/packages/egg-bundler.md wiki/packages/loader-fs.md

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

  • Documentation
    • Clarified documentation for bundled worker initialization and manifest-backed loader filesystem behavior, including startup sequence, loader discovery, and fallback mechanisms across bundled worker documentation.

Copilot AI review requested due to automatic review settings June 1, 2026 18:06
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 1, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 14f6b86b-a25a-4c1a-a8af-c29f05b71456

📥 Commits

Reviewing files that changed from the base of the PR and between b015dce and 380f300.

📒 Files selected for processing (7)
  • tools/egg-bundler/README.md
  • tools/egg-bundler/docs/output-structure.md
  • wiki/index.md
  • wiki/log.md
  • wiki/packages/core.md
  • wiki/packages/egg-bundler.md
  • wiki/packages/loader-fs.md

📝 Walkthrough

Walkthrough

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

Changes

Manifest-Backed Loader Filesystem Documentation

Layer / File(s) Summary
Bundler tool documentation and worker generation
tools/egg-bundler/README.md, tools/egg-bundler/docs/output-structure.md
Updated egg-bundler README and output-structure docs to specify that generated workers initialize ManifestStore.setBundleStore(), set globalThis.__EGG_BUNDLE_MODULE_LOADER__, construct a ManifestLoaderFS from the manifest, and pass it into startEgg() with explicit loaderFS, framework, and mode: 'single' parameters.
Core package loader implementation and API
wiki/packages/core.md
Added packages/core/src/loader/loader_fs.ts to source files and expanded LoaderFS section to document how @eggjs/core exports ManifestLoaderFS alongside re-exported LoaderFS/RealLoaderFS, how EggLoader passes custom loaderFS through loadToApp()/loadToContext(), and how manifest-backed loaders serve file discovery and load bundled modules via globalThis.__EGG_BUNDLE_MODULE_LOADER__ with filesystem fallback.
Public package documentation and metadata
wiki/packages/egg-bundler.md, wiki/packages/loader-fs.md
Updated egg-bundler bundle flow and current behavior descriptions to explicitly mention passing ManifestLoaderFS into startEgg. Updated loader-fs package summary and re-export documentation to clarify that smaller packages can depend directly on loader-fs while manifest-backed worker logic remains in @eggjs/core. Bumped both packages' updated_at timestamps to 2026-06-02.
Changelog and wiki index updates
wiki/log.md, wiki/index.md
Added new log entry documenting manifest-backed loader FS changes for bundled workers and touched source/documentation files. Updated wiki index line for Loader FS Package entry.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

  • eggjs/egg#5943: Documents the new ManifestLoaderFS implementation and EggLoader integration that this PR's bundler and core documentation describes.
  • eggjs/egg#5936: Implements the LoaderFS abstraction and EggLoader threading of custom loaderFS that this PR's documentation explains.
  • eggjs/egg#5911: Changes the generated bundled worker entry template to set globalThis.__EGG_BUNDLE_MODULE_LOADER__, which this PR documents as part of the manifest-backed loader initialization flow.

Suggested reviewers

  • fengmk2

Poem

📚 A bundler's dream, now on the page,
Manifest loaders for the bundled age,
Filesystem fallback, a safety net tight,
Wiki and docs now perfectly bright,
Discovery flows with such graceful might! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(bundler): sync manifest loader fs notes' accurately describes the main change: syncing documentation about manifest-backed loader filesystem in the bundler tool and related wiki pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/egg-doc/6fce9f0e

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying egg with  Cloudflare Pages  Cloudflare Pages

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

View logs

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ManifestLoaderFS and passing loaderFS into startEgg().
  • Update wiki package pages (@eggjs/core, @eggjs/loader-fs, @eggjs/egg-bundler) to document ManifestLoaderFS ownership/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().

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying egg-v3 with  Cloudflare Pages  Cloudflare Pages

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

View logs

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