refactor: rename 'RouteModule' to 'Module'

Author: Je

aleph.ts

@@ -3,7 +3,7 @@ import { DataContext, RouterContext } from './context.ts'
 import { E404Page, E501App, E501Page, ErrorBoundary } from './error.ts'
 import events from './events.ts'
 import type { Routing } from './router.ts'
-import type { PageProps, RouteModule, RouterURL } from './types.ts'
+import type { Module, PageProps, RouterURL } from './types.ts'
 import util, { hashShort, reModuleExt } from './util.ts'
 
 export function ALEPH({ initial }: {
@@ -91,7 +91,7 @@ export function ALEPH({ initial }: {
             console.log('[DATA]', data)
             setStaticData(data)
         }
-        const onAddModule = async (mod: RouteModule) => {
+        const onAddModule = async (mod: Module) => {
             switch (mod.id) {
                 case '/404.js': {
                     const { default: Component } = await import(getModuleImportUrl(baseUrl, mod, true))
@@ -196,6 +196,6 @@ export async function redirect(url: string, replace?: boolean) {
     events.emit('popstate', { type: 'popstate' })
 }
 
-export function getModuleImportUrl(baseUrl: string, mod: RouteModule, forceFetch = false) {
+export function getModuleImportUrl(baseUrl: string, mod: Module, forceFetch = false) {
     return util.cleanPath(baseUrl + '/_aleph/' + util.trimSuffix(mod.id, '.js') + `.${mod.hash.slice(0, hashShort)}.js` + (forceFetch ? `?t=${Date.now()}` : ''))
 }

bootstrap.ts

@@ -3,7 +3,7 @@ import { hydrate, render } from 'https://esm.sh/react-dom'
 import { ALEPH, getModuleImportUrl } from './aleph.ts'
 import { E501Page } from './error.ts'
 import { Routing } from './router.ts'
-import type { PageProps, Route, RouteModule } from './types.ts'
+import type { Module, PageProps, Route } from './types.ts'
 import util, { reModuleExt } from './util.ts'
 
 export default async function bootstrap({
@@ -17,7 +17,7 @@ export default async function bootstrap({
     baseUrl: string
     defaultLocale: string
     locales: string[]
-    preloadModules: RouteModule[]
+    preloadModules: Module[]
 }) {
     const { document } = window as any
     const mainEl = document.querySelector('main')

project.ts

@@ -8,7 +8,7 @@ import log from './log.ts'
 import { Routing } from './router.ts'
 import { colors, ensureDir, path, ServerRequest, Sha1, walk } from './std.ts'
 import { compile } from './tsc/compile.ts'
-import type { AlephRuntime, APIHandle, Config, RouteModule, RouterURL } from './types.ts'
+import type { AlephRuntime, APIHandle, Config, RouterURL } from './types.ts'
 import util, { existsDirSync, existsFileSync, hashShort, reHashJs, reHttp, reMDExt, reModuleExt, reStyleModuleExt } from './util.ts'
 import { cleanCSS, Document, less } from './vendor/mod.ts'
 import { version } from './version.ts'
@@ -33,7 +33,7 @@ interface RenderResult {
     body: string
 }
 
-export default class Project {
+export class Project {
     readonly mode: 'development' | 'production'
     readonly appRoot: string
     readonly config: Config
@@ -414,7 +414,6 @@ export default class Project {
 
         for await (const { path: p, } of walk(this.srcDir, { ...walkOptions, maxDepth: 1, exts: [...walkOptions.exts, '.jsx', '.tsx'] })) {
             const name = path.basename(p)
-            console.log(name)
             switch (name.replace(reModuleExt, '')) {
                 case 'app':
                 case 'data':
@@ -427,14 +426,14 @@ export default class Project {
         if (existsDirSync(apiDir)) {
             for await (const { path: p } of walk(apiDir, walkOptions)) {
                 const mod = await this._compile('/api' + util.trimPrefix(p, apiDir))
-                this.#apiRouting.update(this._getRouteModule(mod))
+                this.#apiRouting.update(this._getPageModule(mod))
             }
         }
 
         for await (const { path: p } of walk(pagesDir, { ...walkOptions, exts: [...walkOptions.exts, '.jsx', '.tsx', '.md', '.mdx'] })) {
             const rp = util.trimPrefix(p, pagesDir)
             const mod = await this._compile('/pages' + rp)
-            this.#routing.update(this._getRouteModule(mod))
+            this.#routing.update(this._getPageModule(mod))
         }
 
         const precompileUrls = [
@@ -523,9 +522,9 @@ export default class Project {
                                     }
                                 }
                                 if (moduleID.startsWith('/pages/')) {
-                                    this.#routing.update(this._getRouteModule(mod))
+                                    this.#routing.update(this._getPageModule(mod))
                                 } else if (moduleID.startsWith('/api/')) {
-                                    this.#apiRouting.update(this._getRouteModule(mod))
+                                    this.#apiRouting.update(this._getPageModule(mod))
                                 }
                                 this._updateDependency(path, mod.hash, ({ id: moduleID }) => {
                                     if (!hmrable && this.isHMRable(moduleID)) {
@@ -553,7 +552,7 @@ export default class Project {
         }
     }
 
-    private _getRouteModule({ id, hash }: Module): RouteModule {
+    private _getPageModule({ id, hash }: Module) {
         const asyncDeps = this._lookupStyleDeps(id).filter(({ async }) => !!async).map(({ async, ...rest }) => rest)
         return { id, hash, asyncDeps }
     }
@@ -586,7 +585,7 @@ export default class Project {
             locales: [],
             routes: this.#routing.routes,
             preloadModules: ['/404.js', '/app.js', '/data.js'].filter(id => this.#modules.has(id)).map(id => {
-                return this._getRouteModule(this.#modules.get(id)!)
+                return this._getPageModule(this.#modules.get(id)!)
             })
         }
         const module = this._moduleFromURL('/main.js')

router.ts

@@ -1,4 +1,4 @@
-import type { Route, RouteModule, RouterURL } from './types.ts'
+import type { Module, Route, RouterURL } from './types.ts'
 import util, { reMDExt } from './util.ts'
 
 const ghostRoute: Route = { path: '', module: { id: '', hash: '' } }
@@ -36,7 +36,7 @@ export class Routing {
         return JSON.parse(JSON.stringify(this._routes))
     }
 
-    update(module: RouteModule) {
+    update(module: Module) {
         const newRoute: Route = { path: getPagePath(module.id), module }
         const dirtyRoutes: Set<Route[]> = new Set()
         let exists = false
@@ -91,15 +91,15 @@ export class Routing {
         }, true)
     }
 
-    createRouter(location?: { pathname: string, search?: string }): [RouterURL, RouteModule[]] {
+    createRouter(location?: { pathname: string, search?: string }): [RouterURL, Module[]] {
         const loc = location || (window as any).location || { pathname: '/' }
         const query = new URLSearchParams(loc.search)
 
         let locale = this._defaultLocale
         let pathname = util.cleanPath(util.trimPrefix(loc.pathname, this._baseUrl))
         let pagePath = ''
         let params: Record<string, string> = {}
-        let tree: RouteModule[] = []
+        let tree: Module[] = []
 
         if (pathname !== '/' && this._locales.length > 0) {
             const a = pathname.split('/')

server.ts

@@ -1,7 +1,7 @@
 import { createHtml } from './html.ts'
 import log from './log.ts'
 import { getContentType } from './mime.ts'
-import Project, { injectHmr } from './project.ts'
+import { injectHmr, Project } from './project.ts'
 import { path, serve, ws } from './std.ts'
 import util, { hashShort } from './util.ts'
 

types.ts

@@ -50,18 +50,18 @@ export interface APIHandle {
     (req: APIRequest, res: APIResponse): void
 }
 
-export interface Route {
-    path: string
-    module: RouteModule
-    children?: Route[]
-}
-
-export interface RouteModule {
+export interface Module {
     readonly id: string
     readonly hash: string
     readonly asyncDeps?: { url: string, hash: string }[]
 }
 
+export interface Route {
+    path: string
+    module: Module
+    children?: Route[]
+}
+
 export interface RouterURL {
     readonly locale: string
     readonly pathname: string