ts-file-router 1.0.0 â 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ðĶ ts-file-router
|
|
2
|
+
|
|
3
|
+
A lightweight TypeScript filesystem router generator.
|
|
4
|
+
Automatically scans folders and outputs a clean, structured `routes.ts` tree ready for dynamic imports (e.g., `React.lazy`).
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## âĻ Features
|
|
9
|
+
|
|
10
|
+
- ð Recursive folder scanning
|
|
11
|
+
- ð Auto-generated `routes.ts` (TypeScript code, no `resolveJsonModule` required)
|
|
12
|
+
- âïļ Works perfectly with `React.lazy()` and dynamic imports
|
|
13
|
+
- ð Full TypeScript `.d.ts` definitions included
|
|
14
|
+
- ð§Đ Custom route file name (default: `page.ts`)
|
|
15
|
+
- ðŠķ Zero runtime dependencies
|
|
16
|
+
- ðŊ Clean, formatted output with readable keys
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## ðĨ Installation
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install ts-file-router
|
|
24
|
+
# or
|
|
25
|
+
yarn add ts-file-router
|