docs(core): document loaderFS option

[killagu]

Summary

• document the new loaderFS LoaderOptions hook in packages/core/README.md
• clarify that custom values implement LoaderFS and per-call options default to the current loader's loaderFS
• move the detailed loaderFS prose under LoaderOptions and fix the markdown table columns/default glob text

Verification

• git diff --check
• pnpm dlx oxfmt@0.46.0 --check packages/core/README.md

Summary by CodeRabbit

• Documentation
  • Expanded EggLoader docs to document the new loaderFS option: its required interface, defaulting to RealLoaderFS, and that loaderFS is reused by load-to-app/context operations when omitted. Updated the LoaderOptions parameter table to reflect this behavior.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0a923412-9049-4310-b013-3d9edc9fd14f

📥 Commits

Reviewing files that changed from the base of the PR and between 99801cd and 5be779f.

📒 Files selected for processing (1)

• packages/core/README.md

✅ Files skipped from review due to trivial changes (1)

• packages/core/README.md

---

📝 Walkthrough

Walkthrough

The packages/core/README.md documentation is updated to describe a new LoaderOptions.loaderFS parameter. The documentation explains that loaderFS accepts a LoaderFS implementation and defaults to RealLoaderFS for standard Node.js filesystem behavior when omitted. A new table row documents this option.

Changes

LoaderFS Documentation Update

Layer / File(s)	Summary
LoaderFS Option Documentation packages/core/README.md	New loaderFS option documented in LoaderOptions with description of LoaderFS interface requirement and RealLoaderFS default behavior; table row added to parameter reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• eggjs/egg#5936: Implements the LoaderFS/RealLoaderFS architecture and EggLoader wiring that this README documents.

Poem

A rabbit hops through docs so neat,
loaderFS makes the circle complete! 🐰
RealLoaderFS guards files with care,
Options spelled out — now all is fair. ✨

🚥 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(core): document loaderFS option' accurately and specifically describes the main change: adding documentation for the loaderFS option in the core package's README.
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 egg-doc/loaderfs-readme-20260511

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[gemini-code-assist]

Code Review

This pull request updates the documentation in packages/core/README.md to include the new loaderFS option within LoaderOptions, which allows for custom filesystem implementations. The review feedback suggests improving the documentation's structure by moving the detailed explanation closer to the options table and refining the description of the default value for better technical accuracy.

[Copilot]

Pull request overview

Documents the new loaderFS hook on loader options in @eggjs/core, helping advanced integrations provide a custom filesystem/glob/loadFile implementation while keeping a clear default (RealLoaderFS).

Changes:

• Add prose documentation explaining LoaderOptions.loaderFS, LoaderFS, and the default RealLoaderFS.
• Add loaderFS to the LoaderOptions parameter table in packages/core/README.md.

[cloudflare-workers-and-pages]

Deploying egg with    Cloudflare Pages

Latest commit:	5be779f
Status:	✅  Deploy successful!
Preview URL:	https://31fff60b.egg-cci.pages.dev
Branch Preview URL:	https://egg-doc-loaderfs-readme-2026.egg-cci.pages.dev

View logs

[cloudflare-workers-and-pages]

Deploying egg-v3 with    Cloudflare Pages

Latest commit:	5be779f
Status:	✅  Deploy successful!
Preview URL:	https://3bb7aaaf.egg-v3.pages.dev
Branch Preview URL:	https://egg-doc-loaderfs-readme-2026.egg-v3.pages.dev

View logs