Store route manifest in-memory / virtual module (#91) - #112
Draft
nounder wants to merge 1 commit into
Draft
Conversation
…n docs Adds BunFileRouterPlugin, a Bun plugin that serves the file-router manifest (the same code FileRouterCodegen.generateCode produces) as a virtual module during Bun.build, instead of writing a .server.ts / routes.gen.ts file to disk. Bun's bundler statically resolves the manifest's relative import() calls against the real routes directory and inlines them, so a bundled deploy never needs an on-disk manifest agents could mistake for source and edit. FileRouter.layer() without load already builds the route map fully in-memory (no file written) — this was correct on main but the README still showcased the load/path + routes.gen.ts codegen flow as the primary usage, which is exactly the kind of generated file agents keep 'fixing'. Updated the README and FileRouter.layer() docs to lead with the in-memory default, and describe the load/path manifest as an opt-in path for typed DevRoutes, pointing at BunFileRouterPlugin for bundled builds. Co-authored-by: Ralph Gutkowski <nounder@users.noreply.github.com>
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
2 participants
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.
Fixes #91
Summary
Agents keep editing generated route manifest files. In-memory scanning already worked for
FileRouter.layer()withoutload; this makes that the documented default and adds a Bun virtual-module plugin for bundled deploys so no on-disk manifest is required.Changes
BunFileRouterPluginservingvirtual:effect-start/file-routesduringBun.buildFileRouter.layerdocs: in-memory default;load/pathopt-in for typed DevRoutesTest plan
bun test test/bun/BunFileRouterPlugin.test.ts