solidjs GitHub avatar

filesystem-routing

solidjs

A router-neutral library for file-system routing that scans directories, applies filename conventions, and produces a neutral route manifest that can be consumed by any router or bundler.

Stars

5

7-day growth

No data

Forks

0

Open issues

0

License

MIT

Last updated

2026-07-27

AI repository intelligence
FR-AI / ANALYSIS

Why it is worth attention

It decouples the file-scanning logic from any specific router or bundler, providing a pluggable convention system and a neutral manifest that enables code-splitting, HMR, and typed routes across frameworks.

Who it is for

  • Framework authors building file-based routing systems
  • SolidStart or Remix users wanting to understand or customize routing
  • Library maintainers integrating file-routing into custom bundlers
  • Developers seeking a standalone, convention-agnostic route manifest generator

Use cases

  • Building file-based routing for any JavaScript framework (Solid, React, Vue, Svelte)
  • Reusing the same routing conventions across different bundlers (Vite, webpack, Rollup)
  • Generating typed route tuples for type-safe navigation in Solid Router
  • Creating custom filename conventions or module conventions for project-specific needs

Strengths

  • Router-agnostic core never imports any framework-specific code; adapters are separate and minimal (~30 lines for Solid Router).
  • Pluggable convention system: built-in nested (SolidStart-style) and flat (Remix-style) conventions, with easy customization via toPath/toRoute hooks.
  • Type generation writes a literal tuple declaration for type-safe route paths, regenerated on file changes.
  • Vite adapter delivers dynamic code-splitting per route module, HMR, and build entry management out of the box.

Considerations

  • Only provides the manifest generation; actual request dispatching and server handling must be implemented by the consuming framework.
  • HTTP method support must be explicitly enabled and is opt-in; core does not handle serving.
  • Optional static segment syntax (e.g., (en).about.tsx) from Remix is rejected due to no representation in the neutral pattern language.

README quick start

Usage with Solid Router and Vite

Description

Universal Filesystem routing plugin for Vite

Related repositories

Similar projects matched by category, topics, and programming language.

TanStack
Featured
TanStack GitHub avatar

router

TanStack Router is a type-safe, data-driven React router with built-in caching, prefetching, and nested layouts, while TanStack Start extends it into a full-stack SSR framework.

Web DevelopmentFrontend Frameworks
14,861
vercel-labs
Featured
vercel-labs GitHub avatar

scriptc

scriptc compiles ordinary TypeScript into small, fast native executables without needing Node.js, V8, or any JavaScript runtime in the binary.

Developer ToolsCode Quality & Build
1,985
Jakubantalik
Featured
Jakubantalik GitHub avatar

thinking-orbs

A React component library that renders six hand-tuned animated thought orb loading indicators on a plain 2D canvas, with two purpose-tuned sizes and automatic theme detection for AI and agent UIs.

AI & Machine LearningAI Agents
1,191