ts-file-router 3.0.0 → 4.0.0

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.
Files changed (2) hide show
  1. package/README.md +20 -8
  2. package/package.json +5 -1
package/README.md CHANGED
@@ -57,27 +57,26 @@ export default defineConfig({
57
57
  generateRoutesPlugin({
58
58
  baseFolder: 'src/screens',
59
59
  outputFile: 'screens.ts',
60
- exitCodeOnResolution: false,
61
60
  }),
62
61
  ],
63
62
  });
64
63
  ```
65
64
 
66
- ## 🎯 Usage With Watcher (Chokidar peerDependencie)
65
+ ## 🎯 Usage With Watcher (Chokidar Peer Dependencie)
67
66
 
68
67
  Create a script to generate your routes. Example:
69
68
 
70
69
  ```js
71
70
  // scripts/generate-routes.mjs
72
- import { generateRoutesWithWatcher } from 'ts-file-router';
71
+ import { generateRoutes } from 'ts-file-router';
73
72
 
74
- generateRoutesWithWatcher({
75
- input: {
76
- baseFolder: 'src/screens',
77
- outputFile: 'screens.ts',
73
+ generateRoutes({
74
+ baseFolder: 'src/screens',
75
+ outputFile: 'screens.ts',
76
+ options: {
77
+ watcher: { watch: true, debounce: 500 },
78
78
  exitCodeOnResolution: false,
79
79
  },
80
- options: { debounce: 500 },
81
80
  });
82
81
  ```
83
82
 
@@ -92,3 +91,16 @@ generateRoutesWithWatcher({
92
91
  Run the script with:
93
92
 
94
93
  node scripts/generate-routes.mjs
94
+
95
+ or setup generateRoutesPlugin in vite.config.ts
96
+
97
+ ## Output based on your folder
98
+
99
+ ```ts
100
+ export const routes = {
101
+ page: {
102
+ path: '/',
103
+ import: () => import('./page'),
104
+ },
105
+ } as const;
106
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ts-file-router",
3
- "version": "3.0.0",
3
+ "version": "4.0.0",
4
4
  "description": "router based on project files using typescript",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -26,5 +26,9 @@
26
26
  "peerDependencies": {
27
27
  "chokidar": ">=4.0.0",
28
28
  "vite": ">=3.0.0"
29
+ },
30
+ "dependencies": {
31
+ "@biomejs/js-api": "^4.0.0",
32
+ "@biomejs/wasm-nodejs": "^2.3.11"
29
33
  }
30
34
  }