feat: support custom server

Author: Wenjie Xia

cli/build.ts

@@ -1,4 +1,4 @@
-import { Project } from '../server/project.ts'
+import { Appliaction } from '../server/app.ts'
 
 export const helpMessage = `
 Usage:
@@ -13,8 +13,12 @@ Options:
     -h, --help                   Prints help message
 `
 
-export default async function (appDir: string, options: Record<string, string | boolean>) {
-    const project = new Project(appDir, 'production', Boolean(options.r || options.reload))
-    await project.build()
+export default async function (workingDir: string, options: Record<string, string | boolean>) {
+    const app = new Appliaction({
+        workingDir,
+        mode: 'production',
+        reload: Boolean(options.r || options.reload)
+    })
+    await app.build()
     Deno.exit(0)
 }

cli/dev.ts

@@ -1,5 +1,6 @@
-import { start } from '../server/server.ts'
-import log from '../shared/log.ts'
+import { Appliaction } from '../server/app.ts'
+import { start } from '../server/mod.ts'
+import { parsePortNumber } from '../server/util.ts'
 
 export const helpMessage = `
 Usage:
@@ -15,11 +16,12 @@ Options:
     -h, --help                   Prints help message
 `
 
-export default async function (appDir: string, options: Record<string, string | boolean>) {
-    const port = parseInt(String(options.p || options.port || '8080'))
-    if (isNaN(port) || port <= 0 || !Number.isInteger(port)) {
-        log.error(`invalid port '${options.port || options.p}'`)
-        Deno.exit(1)
-    }
-    start(appDir, 'localhost', port, true, Boolean(options.r || options.reload))
+export default async function (workingDir: string, options: Record<string, string | boolean>) {
+    const port = parsePortNumber(String(options.p || options.port || '8080'))
+    const app = new Appliaction({
+        workingDir,
+        mode: 'development',
+        reload: Boolean(options.r || options.reload)
+    })
+    start('localhost', port, app)
 }

cli/init.ts

@@ -4,33 +4,6 @@ import log from '../shared/log.ts'
 import util from '../shared/util.ts'
 import { VERSION } from '../version.ts'
 
-const gitignore = [
-    '.DS_Store',
-    'Thumbs.db',
-    '.aleph/',
-    'dist/',
-]
-
-const vscExtensions = {
-    'recommendations': [
-        'denoland.vscode-deno'
-    ]
-}
-
-const vscSettings = {
-    'files.eol': '\n',
-    'files.trimTrailingWhitespace': true,
-    'files.exclude': {
-        '**/.git': true,
-        '**/.DS_Store': true,
-        '**/Thumbs.db': true,
-        '**/.aleph': true
-    },
-    'deno.enable': true,
-    'deno.unstable': true,
-    'deno.import_map': './import_map.json'
-}
-
 export const helpMessage = `
 Usage:
     aleph init <dir> [...options]
@@ -50,6 +23,12 @@ export default async function (appDir: string, options: Record<string, string |
     log.info('Saving template...')
     const tarData = gzipDecode(gzData)
     const entryList = new Untar(new Deno.Buffer(tarData))
+    const gitignore = [
+        '.DS_Store',
+        'Thumbs.db',
+        '.aleph/',
+        'dist/',
+    ]
 
     // todo: add template select ui
     let template = 'hello-world'
@@ -65,22 +44,33 @@ export default async function (appDir: string, options: Record<string, string |
             await Deno.copy(entry, file)
         }
     }
-
-    await ensureDir(path.join(appDir, '.vscode'))
-    await Deno.writeTextFile(path.join(appDir, '.vscode', 'extensions.json'), JSON.stringify(vscExtensions, undefined, 4))
-    await Deno.writeTextFile(path.join(appDir, '.vscode', 'settings.json'), JSON.stringify(vscSettings, undefined, 4))
     await Deno.writeTextFile(path.join(appDir, '.gitignore'), gitignore.join('\n'))
     await Deno.writeTextFile(path.join(appDir, 'import_map.json'), JSON.stringify({
         imports: {
             'aleph': `https://deno.land/x/aleph@v${VERSION}/mod.ts`,
-            'aleph/react': `https://deno.land/x/aleph@v${VERSION}/react.ts`,
             'aleph/': `https://deno.land/x/aleph@v${VERSION}/`,
             'react': 'https://esm.sh/[email protected]',
             'react-dom': 'https://esm.sh/[email protected]',
         },
         scopes: {}
     }, undefined, 4))
 
+    if (await confirm(`Add VS Code workspace settings?`)) {
+        const extensions = {
+            'recommendations': [
+                'denoland.vscode-deno'
+            ]
+        }
+        const settigns = {
+            'deno.enable': true,
+            'deno.unstable': true,
+            'deno.import_map': './import_map.json'
+        }
+        await ensureDir(path.join(appDir, '.vscode'))
+        await Deno.writeTextFile(path.join(appDir, '.vscode', 'extensions.json'), JSON.stringify(extensions, undefined, 4))
+        await Deno.writeTextFile(path.join(appDir, '.vscode', 'settings.json'), JSON.stringify(settigns, undefined, 4))
+    }
+
     log.info('Done')
     log.info('---')
     log.info(colors.dim('Aleph.js is ready to Go.'))
@@ -91,3 +81,17 @@ export default async function (appDir: string, options: Record<string, string |
     log.info('---')
     Deno.exit(0)
 }
+
+async function ask(question: string = ':', stdin = Deno.stdin, stdout = Deno.stdout) {
+    await stdout.write(new TextEncoder().encode(question + ' '))
+    const buf = new Uint8Array(1024)
+    const n = <number>await stdin.read(buf)
+    const answer = new TextDecoder().decode(buf.subarray(0, n))
+    return answer.trim()
+}
+
+async function confirm(question: string = 'are you sure?') {
+    let a: string
+    while (!/^(y(es)?|no?)$/i.test(a = (await ask(question + ' [y/n]')).trim())) { }
+    return a.charAt(0).toLowerCase() === 'y'
+}

cli/start.ts

@@ -1,4 +1,6 @@
-import log from '../shared/log.ts'
+import { Appliaction } from '../server/app.ts'
+import { start } from '../server/mod.ts'
+import { parsePortNumber } from '../server/util.ts'
 
 export const helpMessage = `
 Usage:
@@ -15,13 +17,13 @@ Options:
     -h, --help                   Prints help message
 `
 
-export default async function (appDir: string, options: Record<string, string | boolean>) {
-    const { start } = await import('../server/server.ts')
+export default async function (workingDir: string, options: Record<string, string | boolean>) {
     const host = String(options.hn || options.hostname || 'localhost')
-    const port = parseInt(String(options.p || options.port || '8080'))
-    if (isNaN(port) || port <= 0 || !Number.isInteger(port)) {
-        log.error(`invalid port '${options.port || options.p}'`)
-        Deno.exit(1)
-    }
-    start(appDir, host, port, false, Boolean(options.r || options.reload))
+    const port = parsePortNumber(String(options.p || options.port || '8080'))
+    const app = new Appliaction({
+        workingDir,
+        mode: 'production',
+        reload: Boolean(options.r || options.reload)
+    })
+    start(host, port, app)
 }

server/project.ts renamed to server/app.ts

@@ -7,25 +7,23 @@ import { hashShort, reFullVersion, reHashJs, reHashResolve, reHttp, reLocaleID,
 import { ensureTextFile, existsDirSync, existsFileSync } from '../shared/fs.ts'
 import log from '../shared/log.ts'
 import util from '../shared/util.ts'
-import type { APIHandler, Config, RouterURL, ServerRequest } from '../types.ts'
+import type { Config, RouterURL, ServerRequest } from '../types.ts'
 import { VERSION } from '../version.ts'
 import { Request } from './api.ts'
-import type { DependencyDescriptor, ImportMap, Module, RenderResult } from './types.ts'
+import type { AppliactionOptions, DependencyDescriptor, ImportMap, Module, RenderResult } from './types.ts'
 import { AlephRuntimeCode, cleanupCompilation, createHtml, fixImportMap, fixImportUrl, formatBytesWithColor, getAlephPkgUrl, getRelativePath, newModule, respondError } from './util.ts'
 
+const defaultOptions: Required<AppliactionOptions> = {
+    workingDir: '.',
+    mode: 'production',
+    reload: false
+}
+
 /**
- * A Project to manage the Aleph.js appliaction.
- * core functions include:
- * - manage deps
- * - compile & bundle
- * - apply plugins
- * - map page/API routes
- * - watch file changes
- * - call APIs
- * - SSR/SSG
+ * The Alep Appliaction class.
  */
-export class Project {
-    readonly appRoot: string
+export class Appliaction {
+    readonly workingDir: string
     readonly mode: 'development' | 'production'
     readonly config: Readonly<Required<Config>>
     readonly importMap: Readonly<{ imports: ImportMap, scopes: Record<string, ImportMap> }>
@@ -44,12 +42,13 @@ export class Project {
     #postcssReady: Promise<void[]> | null = null
     #reloading = false
 
-    constructor(appDir: string, mode: 'development' | 'production', reload = false) {
-        this.appRoot = path.resolve(appDir)
+    constructor(options: AppliactionOptions = defaultOptions) {
+        const { workingDir, mode, reload } = Object.assign({}, defaultOptions, options)
+        this.workingDir = path.resolve(workingDir)
         this.mode = mode
         this.config = {
             framework: 'react',
-            srcDir: existsDirSync(path.join(this.appRoot, '/src/pages')) ? '/src' : '/',
+            srcDir: existsDirSync(path.join(this.workingDir, '/src/pages')) ? '/src' : '/',
             outputDir: '/dist',
             baseUrl: '/',
             defaultLocale: 'en',
@@ -74,15 +73,15 @@ export class Project {
     }
 
     get srcDir() {
-        return path.join(this.appRoot, this.config.srcDir)
+        return path.join(this.workingDir, this.config.srcDir)
     }
 
     get buildDir() {
-        return path.join(this.appRoot, '.aleph', this.mode)
+        return path.join(this.workingDir, '.aleph', this.mode)
     }
 
     get outputDir() {
-        return path.join(this.appRoot, this.config.outputDir)
+        return path.join(this.workingDir, this.config.outputDir)
     }
 
     isHMRable(url: string) {
@@ -149,7 +148,7 @@ export class Project {
         }
     }
 
-    async callAPI(req: ServerRequest, loc: { pathname: string, search?: string }): Promise<APIHandler | null> {
+    async callAPI(req: ServerRequest, loc: { pathname: string, search?: string }) {
         const [url, chain] = this.#apiRouting.createRouter({
             ...loc,
             pathname: decodeURI(loc.pathname)
@@ -172,7 +171,6 @@ export class Project {
         } else {
             respondError(req, 404, 'page not found')
         }
-        return null
     }
 
     async getSSRData(loc: { pathname: string, search?: string }): Promise<[number, any]> {
@@ -245,7 +243,7 @@ export class Project {
         await this.ssg()
 
         // copy public assets
-        const publicDir = path.join(this.appRoot, 'public')
+        const publicDir = path.join(this.workingDir, 'public')
         if (existsDirSync(publicDir)) {
             let n = 0
             for await (const { path: p } of walk(publicDir, { includeDirs: false, skip: [/(^|\/)\.DS_Store$/] })) {
@@ -332,7 +330,7 @@ export class Project {
 
     /** load config from `aleph.config.(json|mjs|js|ts)` */
     private async loadConfig() {
-        const importMapFile = path.join(this.appRoot, 'import_map.json')
+        const importMapFile = path.join(this.workingDir, 'import_map.json')
         if (existsFileSync(importMapFile)) {
             const importMap = JSON.parse(await Deno.readTextFile(importMapFile))
             const imports: ImportMap = fixImportMap(importMap.imports)
@@ -348,7 +346,7 @@ export class Project {
         const config: Record<string, any> = {}
 
         for (const name of Array.from(['ts', 'js', 'mjs', 'json']).map(ext => `aleph.config.${ext}`)) {
-            const p = path.join(this.appRoot, name)
+            const p = path.join(this.workingDir, name)
             if (existsFileSync(p)) {
                 log.info('  ✓', name)
                 if (name.endsWith('.json')) {
@@ -425,7 +423,7 @@ export class Project {
             Object.assign(this.config, { postcss })
         } else {
             for (const name of Array.from(['ts', 'js', 'mjs', 'json']).map(ext => `postcss.config.${ext}`)) {
-                const p = path.join(this.appRoot, name)
+                const p = path.join(this.workingDir, name)
                 if (existsFileSync(p)) {
                     log.info('  ✓', name)
                     if (name.endsWith('.json')) {
@@ -506,7 +504,7 @@ export class Project {
         await this.loadConfig()
 
         // change current work dir to appDoot
-        Deno.chdir(this.appRoot)
+        Deno.chdir(this.workingDir)
 
         // inject env variables
         Object.entries(this.config.env).forEach(([key, value]) => Deno.env.set(key, value))