@buzola/vite-plugin 0.0.1

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 (56) hide show
  1. package/dist/__tests__/codegen.test.d.ts +2 -0
  2. package/dist/__tests__/codegen.test.d.ts.map +1 -0
  3. package/dist/__tests__/codegen.test.js +121 -0
  4. package/dist/__tests__/codegen.test.js.map +1 -0
  5. package/dist/__tests__/conventions.test.d.ts +2 -0
  6. package/dist/__tests__/conventions.test.d.ts.map +1 -0
  7. package/dist/__tests__/conventions.test.js +80 -0
  8. package/dist/__tests__/conventions.test.js.map +1 -0
  9. package/dist/__tests__/page-extractor.test.d.ts +2 -0
  10. package/dist/__tests__/page-extractor.test.d.ts.map +1 -0
  11. package/dist/__tests__/page-extractor.test.js +82 -0
  12. package/dist/__tests__/page-extractor.test.js.map +1 -0
  13. package/dist/__tests__/tree-builder.test.d.ts +2 -0
  14. package/dist/__tests__/tree-builder.test.d.ts.map +1 -0
  15. package/dist/__tests__/tree-builder.test.js +335 -0
  16. package/dist/__tests__/tree-builder.test.js.map +1 -0
  17. package/dist/conventions.d.ts +53 -0
  18. package/dist/conventions.d.ts.map +1 -0
  19. package/dist/conventions.js +82 -0
  20. package/dist/conventions.js.map +1 -0
  21. package/dist/generator/codegen.d.ts +23 -0
  22. package/dist/generator/codegen.d.ts.map +1 -0
  23. package/dist/generator/codegen.js +164 -0
  24. package/dist/generator/codegen.js.map +1 -0
  25. package/dist/generator/page-extractor.d.ts +21 -0
  26. package/dist/generator/page-extractor.d.ts.map +1 -0
  27. package/dist/generator/page-extractor.js +23 -0
  28. package/dist/generator/page-extractor.js.map +1 -0
  29. package/dist/generator/scanner.d.ts +11 -0
  30. package/dist/generator/scanner.d.ts.map +1 -0
  31. package/dist/generator/scanner.js +34 -0
  32. package/dist/generator/scanner.js.map +1 -0
  33. package/dist/generator/tree-builder.d.ts +50 -0
  34. package/dist/generator/tree-builder.d.ts.map +1 -0
  35. package/dist/generator/tree-builder.js +273 -0
  36. package/dist/generator/tree-builder.js.map +1 -0
  37. package/dist/index.d.ts +13 -0
  38. package/dist/index.d.ts.map +1 -0
  39. package/dist/index.js +7 -0
  40. package/dist/index.js.map +1 -0
  41. package/dist/plugin.d.ts +26 -0
  42. package/dist/plugin.d.ts.map +1 -0
  43. package/dist/plugin.js +101 -0
  44. package/dist/plugin.js.map +1 -0
  45. package/package.json +24 -0
  46. package/src/__tests__/codegen.test.ts +134 -0
  47. package/src/__tests__/conventions.test.ts +93 -0
  48. package/src/__tests__/page-extractor.test.ts +95 -0
  49. package/src/__tests__/tree-builder.test.ts +390 -0
  50. package/src/conventions.ts +116 -0
  51. package/src/generator/codegen.ts +214 -0
  52. package/src/generator/page-extractor.ts +48 -0
  53. package/src/generator/scanner.ts +45 -0
  54. package/src/generator/tree-builder.ts +354 -0
  55. package/src/index.ts +17 -0
  56. package/src/plugin.ts +132 -0
package/src/plugin.ts ADDED
@@ -0,0 +1,132 @@
1
+ import * as fs from 'node:fs'
2
+ import * as path from 'node:path'
3
+ import type { Plugin, ViteDevServer } from 'vite'
4
+ import { generateRouteModule } from './generator/codegen'
5
+ import type { ModuleLoader } from './generator/page-extractor'
6
+ import { scanRouteFiles } from './generator/scanner'
7
+ import { buildFileRouteTree } from './generator/tree-builder'
8
+
9
+ export interface BuzolaPluginOptions {
10
+ /** Path to routes directory, relative to project root. Defaults to "src/routes". */
11
+ routesDir?: string
12
+ /** Path to output generated file, relative to project root. Defaults to "src/buzola.gen.ts". */
13
+ output?: string
14
+ /**
15
+ * Parameter names that should be persistent across navigations.
16
+ * When set, generates a BuzolaPersistentParams type augmentation
17
+ * so these params become optional in Link and navigate() calls.
18
+ */
19
+ persistentParams?: string[]
20
+ }
21
+
22
+ const VIRTUAL_MODULE_ID = 'virtual:buzola/routes'
23
+ const RESOLVED_VIRTUAL_ID = '\0' + VIRTUAL_MODULE_ID
24
+
25
+ /**
26
+ * Vite plugin for Buzola page-centric routing.
27
+ *
28
+ * Scans `src/routes/` for page files using `createPage()`.
29
+ * Generates `buzola.gen.ts` with:
30
+ * - Route tree
31
+ * - Page registry (page ID → route pattern)
32
+ * - BuzolaPageMap type augmentation
33
+ *
34
+ * Provides `virtual:buzola/routes` virtual module.
35
+ */
36
+ export function buzolaPlugin(options: BuzolaPluginOptions = {}): Plugin {
37
+ const {
38
+ routesDir: routesDirOption = 'src/routes',
39
+ output: outputOption = 'src/buzola.gen.ts',
40
+ persistentParams: persistentParamsOption,
41
+ } = options
42
+
43
+ let root: string
44
+ let routesDir: string
45
+ let outputPath: string
46
+ let server: ViteDevServer | undefined
47
+
48
+ async function generate(moduleLoader: ModuleLoader): Promise<boolean> {
49
+ const files = scanRouteFiles(routesDir)
50
+ const tree = await buildFileRouteTree(files, moduleLoader)
51
+ const code = generateRouteModule({
52
+ tree,
53
+ routesDir,
54
+ outputPath,
55
+ persistentParams: persistentParamsOption,
56
+ })
57
+
58
+ return writeIfChanged(outputPath, code)
59
+ }
60
+
61
+ return {
62
+ name: 'buzola',
63
+ enforce: 'pre',
64
+
65
+ configResolved(config) {
66
+ root = config.root
67
+ routesDir = path.resolve(root, routesDirOption)
68
+ outputPath = path.resolve(root, outputOption)
69
+ },
70
+
71
+ configureServer(srv) {
72
+ server = srv
73
+ },
74
+
75
+ async buildStart() {
76
+ if (!fs.existsSync(routesDir)) return
77
+
78
+ if (server) {
79
+ await generate((p) => server!.ssrLoadModule(p))
80
+ } else {
81
+ // Production build — create a temporary Vite server for module loading
82
+ const { createServer } = await import('vite')
83
+ const tempServer = await createServer({
84
+ root,
85
+ server: { middlewareMode: true },
86
+ logLevel: 'silent',
87
+ optimizeDeps: { noDiscovery: true },
88
+ })
89
+ try {
90
+ await generate((p) => tempServer.ssrLoadModule(p))
91
+ } finally {
92
+ await tempServer.close()
93
+ }
94
+ }
95
+ },
96
+
97
+ resolveId(id) {
98
+ if (id === VIRTUAL_MODULE_ID) {
99
+ return RESOLVED_VIRTUAL_ID
100
+ }
101
+ },
102
+
103
+ load(id) {
104
+ if (id === RESOLVED_VIRTUAL_ID) {
105
+ return `export { routes, pageRegistry } from '${outputPath.replace(/\.ts$/, '')}';\n`
106
+ }
107
+ },
108
+
109
+ async handleHotUpdate({ file }) {
110
+ if (!file.startsWith(routesDir) || !server) return
111
+
112
+ const changed = await generate((p) => server!.ssrLoadModule(p))
113
+
114
+ if (changed) {
115
+ const mod = server.moduleGraph.getModuleById(RESOLVED_VIRTUAL_ID)
116
+ if (mod) {
117
+ server.moduleGraph.invalidateModule(mod)
118
+ }
119
+ server.ws.send({ type: 'full-reload' })
120
+ }
121
+ },
122
+ }
123
+ }
124
+
125
+ function writeIfChanged(filePath: string, content: string): boolean {
126
+ if (fs.existsSync(filePath) && fs.readFileSync(filePath, 'utf-8') === content) {
127
+ return false
128
+ }
129
+
130
+ fs.writeFileSync(filePath, content, 'utf-8')
131
+ return true
132
+ }