@troyio/vite-file-router 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,74 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# vite-file-router
+
+A Vite plugin that generates a route tree from a file-based page directory.
+
+## Install
+
+The package is published to GitHub Packages on every push to `main`, under
+`@OWNER/vite-file-router`. Configure npm to use GitHub Packages for that scope
+and authenticate with a GitHub token that has `read:packages` access:
+
+```ini
+@OWNER:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
+```
+
+Then install it with:
+
+```sh
+npm install @OWNER/vite-file-router
+```
+
+Each main-branch build is published with a unique prerelease version.
+
+Vite is a peer dependency and must also be installed in your project.
+
+## Configure
+
+```ts
+import { defineConfig } from "vite";
+import { routes } from "@OWNER/vite-file-router";
+
+export default defineConfig({
+  plugins: [routes()],
+});
+```
+
+By default, the plugin scans `src/pages`. Pass a path relative to the Vite
+project root to use another directory:
+
+```ts
+plugins: [routes("src/routes")];
+```
+
+Each `page.tsx` becomes a route page, and each `layout.tsx` becomes a lazy
+layout for its directory. Directories become nested routes. For example:
+
+```text
+src/pages/
+  layout.tsx
+  page.tsx
+  users/
+    page.tsx
+    [id]/
+      page.tsx
+```
+
+Dynamic segments such as `[id]` become `:id`; catch-all segments such as
+`[...slug]` become `*`.
+
+Import the generated route configuration from the `virtual:routes` module in
+your application:
+
+```ts
+import { routes } from "virtual:routes";
+```
+
+The virtual module exports a `routes` array with lazy-loaded page and layout
+components.
+
+## Build
+
+```sh
+npm run build
+```

package/dist/generator.d.ts

@@ -0,0 +1,2 @@
+import type { Node } from "./scanner";
+export declare function generate(node: Node, root?: boolean): string;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import type { Plugin } from "vite";
+export declare function routes(directory?: string): Plugin;

package/dist/index.js

@@ -0,0 +1,86 @@
+import fs from "node:fs";
+import path from "node:path";
+import { genArrayFromRaw, genObjectFromRaw } from "knitwork";
+import { normalizePath } from "vite";
+// src/scanner.ts
+function scan(directory) {
+	const node = {
+		name: path.basename(directory),
+		directory,
+		children: []
+	};
+	if (!fs.existsSync(directory)) return node;
+	const entries = fs.readdirSync(directory, { withFileTypes: true });
+	for (const entry of entries) {
+		const file = path.join(directory, entry.name);
+		if (entry.isDirectory()) {
+			node.children.push(scan(file));
+			continue;
+		}
+		if (entry.name === "page.tsx") node.page = file;
+		if (entry.name === "layout.tsx") node.layout = file;
+	}
+	return node;
+}
+// src/generator.ts
+function getRoutePath(directory) {
+	const segment = path.basename(directory);
+	if (segment.startsWith("[...") && segment.endsWith("]")) return "*";
+	return segment.replace(/^\[(.+)\]$/, ":$1");
+}
+function generateImport(file) {
+	return `async ()=>({
+        Component: (await import(${JSON.stringify(normalizePath(file))})).default
+    })`;
+}
+function generate(node, root = false) {
+	const route = {};
+	if (!root) route.path = JSON.stringify(getRoutePath(node.directory));
+	if (node.layout) route.lazy = generateImport(node.layout);
+	const children = [];
+	if (node.page) children.push(genObjectFromRaw({
+		index: "true",
+		lazy: generateImport(node.page)
+	}));
+	for (const child of node.children) children.push(generate(child));
+	if (children.length) route.children = genArrayFromRaw(children);
+	return genObjectFromRaw(route);
+}
+// src/index.ts
+var MODULE_ID = "virtual:routes";
+var RESOLVED_ID = `\0${MODULE_ID}`;
+function routes(directory = "src/pages") {
+	let root = "";
+	function execute() {
+		const routes = generate(scan(root), true);
+		return `
+      export const routes = ${genArrayFromRaw([routes])};
+    `;
+	}
+	return {
+		name: "routes",
+		configResolved(config) {
+			root = path.resolve(config.root, directory);
+		},
+		resolveId: (id) => id === MODULE_ID ? RESOLVED_ID : void 0,
+		load: (id) => id === RESOLVED_ID ? execute() : void 0,
+		configureServer: (server) => {
+			server.watcher.add(root);
+			server.watcher.on("all", (event, file) => {
+				if (![
+					"add",
+					"unlink",
+					"addDir",
+					"unlinkDir",
+					"change"
+				].includes(event)) return;
+				const location = path.resolve(file);
+				if (location !== root && !location.startsWith(root + path.sep)) return;
+				const module = server.moduleGraph.getModuleById(RESOLVED_ID);
+				if (module) server.moduleGraph.invalidateModule(module);
+				server.ws.send({ type: "full-reload" });
+			});
+		}
+	};
+}
+export { routes };

package/dist/scanner.d.ts

@@ -0,0 +1,8 @@
+export type Node = {
+    name: string;
+    directory: string;
+    page?: string;
+    layout?: string;
+    children: Node[];
+};
+export declare function scan(directory: string): Node;

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@troyio/vite-file-router",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "File-system routing plugin for Vite",
+  "type": "module",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "types"
+  ],
+  "main": "./dist/index.js",
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "vite build && tsc -p tsconfig.build.json",
+    "lint": "eslint src vite.config.ts"
+  },
+  "dependencies": {
+    "knitwork": "^1.3.0",
+    "react-router": "^8.5.1",
+    "vite-file-router": "link:"
+  },
+  "peerDependencies": {
+    "vite": "^6.0.0 || ^7.0.0 || ^8.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^24.19.2",
+    "eslint": "^10.13.0",
+    "globals": "^17.13.0",
+    "typescript": "~6.0.3",
+    "typescript-eslint": "^8.72.0",
+    "vite": "^8.3.5"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="./virtual-routes.d.ts" />
+
+export { routes } from "../dist/index.js";

package/types/virtual-routes.d.ts

@@ -0,0 +1,4 @@
+declare module "virtual:routes" {
+  import type { RouteObject } from "react-router";
+  export const routes: RouteObject[];
+}