@eighty4/dank 0.0.4-1 → 0.0.4-2

package/client/esbuild.js

@@ -1,91 +1 @@
-new EventSource('http://127.0.0.1:3995/esbuild').addEventListener('change', (e) => {
-    const { updated } = JSON.parse(e.data);
-    const changes = new Set();
-    for (const c of updated)
-        changes.add(c);
-    const cssUpdates = Array.from(changes).filter(p => p.endsWith('.css'));
-    if (cssUpdates.length) {
-        console.log('esbuild css updates', cssUpdates);
-        const cssLinks = {};
-        for (const elem of document.getElementsByTagName('link')) {
-            if (elem.getAttribute('rel') === 'stylesheet') {
-                const url = new URL(elem.href);
-                if ((url.host = location.host)) {
-                    cssLinks[url.pathname] = elem;
-                }
-            }
-        }
-        let swappedCss = false;
-        for (const cssUpdate of cssUpdates) {
-            const cssLink = cssLinks[cssUpdate];
-            if (cssLink) {
-                const next = cssLink.cloneNode();
-                next.href = `${cssUpdate}?${Math.random().toString(36).slice(2)}`;
-                next.onload = () => cssLink.remove();
-                cssLink.parentNode.insertBefore(next, cssLink.nextSibling);
-                swappedCss = true;
-            }
-        }
-        if (swappedCss) {
-            addCssUpdateIndicator();
-        }
-    }
-    if (cssUpdates.length < changes.size) {
-        const jsUpdates = Array.from(changes).filter(p => !p.endsWith('.css'));
-        const jsScripts = new Set();
-        for (const elem of document.getElementsByTagName('script')) {
-            if (elem.src.length) {
-                const url = new URL(elem.src);
-                if ((url.host = location.host)) {
-                    jsScripts.add(url.pathname);
-                }
-            }
-        }
-        if (jsUpdates.some(jsUpdate => jsScripts.has(jsUpdate))) {
-            console.log('esbuild js updates require reload');
-            addJsReloadIndicator();
-        }
-    }
-});
-export function addCssUpdateIndicator() {
-    const indicator = createUpdateIndicator('green', '9999');
-    indicator.style.opacity = '0';
-    indicator.animate([
-        { opacity: 0 },
-        { opacity: 1 },
-        { opacity: 1 },
-        { opacity: 1 },
-        { opacity: 0.75 },
-        { opacity: 0.5 },
-        { opacity: 0.25 },
-        { opacity: 0 },
-    ], {
-        duration: 400,
-        iterations: 1,
-        direction: 'normal',
-        easing: 'linear',
-    });
-    document.body.appendChild(indicator);
-    Promise.all(indicator.getAnimations().map(a => a.finished)).then(() => indicator.remove());
-}
-function addJsReloadIndicator() {
-    const indicator = createUpdateIndicator('orange', '9000');
-    indicator.style.opacity = '0';
-    indicator.animate([{ opacity: 0 }, { opacity: 1 }], {
-        duration: 400,
-        iterations: 1,
-        direction: 'normal',
-        easing: 'ease-in',
-    });
-    document.body.appendChild(indicator);
-}
-function createUpdateIndicator(color, zIndex) {
-    const indicator = document.createElement('div');
-    indicator.style.border = '6px dashed ' + color;
-    indicator.style.zIndex = zIndex;
-    indicator.style.position = 'fixed';
-    indicator.style.top = indicator.style.left = '1px';
-    indicator.style.height = indicator.style.width = 'calc(100% - 2px)';
-    indicator.style.boxSizing = 'border-box';
-    return indicator;
-}
+new EventSource("http://127.0.0.1:3995/esbuild").addEventListener("change",t=>{const{updated:i}=JSON.parse(t.data),e=new Set;for(const s of i)e.add(s);const c=Array.from(e).filter(s=>s.endsWith(".css"));if(c.length){console.log("esbuild css updates",c);const s={};for(const o of document.getElementsByTagName("link"))if(o.getAttribute("rel")==="stylesheet"){const n=new URL(o.href);(n.host=location.host)&&(s[n.pathname]=o)}let a=!1;for(const o of c){const n=s[o];if(n){const r=n.cloneNode();r.href=`${o}?${Math.random().toString(36).slice(2)}`,r.onload=()=>n.remove(),n.parentNode.insertBefore(r,n.nextSibling),a=!0}}a&&l()}if(c.length<e.size){const s=Array.from(e).filter(o=>!o.endsWith(".css")),a=new Set;for(const o of document.getElementsByTagName("script"))if(o.src.length){const n=new URL(o.src);(n.host=location.host)&&a.add(n.pathname)}s.some(o=>a.has(o))&&(console.log("esbuild js updates require reload"),p())}});function l(){const t=d("green","9999");t.style.opacity="0",t.animate([{opacity:0},{opacity:1},{opacity:1},{opacity:1},{opacity:.75},{opacity:.5},{opacity:.25},{opacity:0}],{duration:400,iterations:1,direction:"normal",easing:"linear"}),document.body.appendChild(t),Promise.all(t.getAnimations().map(i=>i.finished)).then(()=>t.remove())}function p(){const t=d("orange","9000");t.style.opacity="0",t.animate([{opacity:0},{opacity:1}],{duration:400,iterations:1,direction:"normal",easing:"ease-in"}),document.body.appendChild(t)}function d(t,i){const e=document.createElement("div");return e.style.border="6px dashed "+t,e.style.zIndex=i,e.style.position="fixed",e.style.top=e.style.left="1px",e.style.height=e.style.width="calc(100% - 2px)",e.style.boxSizing="border-box",e}export{l as addCssUpdateIndicator};

package/lib/bin.ts

@@ -71,7 +71,7 @@ const task: 'build' | 'serve' = (function resolveTask() {
     return task
 })()
 
-const c = await loadConfig()
+const c = await loadConfig(task)
 
 try {
     switch (task) {

package/lib/build.ts

@@ -9,10 +9,8 @@ import { HtmlEntrypoint } from './html.ts'
 import { type WebsiteManifest, WebsiteRegistry } from './metadata.ts'
 import { copyAssets } from './public.ts'
 
-export async function buildWebsite(
-    c: DankConfig,
-    build: DankBuild = resolveBuildFlags(),
-): Promise<WebsiteManifest> {
+export async function buildWebsite(c: DankConfig): Promise<WebsiteManifest> {
+    const build: DankBuild = resolveBuildFlags()
     const buildTag = await createBuildTag(build)
     console.log(
         build.minify

package/lib/config.ts

@@ -1,12 +1,30 @@
 import { isAbsolute, resolve } from 'node:path'
-import type { DankConfig } from './dank.ts'
+import type {
+    DankConfig,
+    DankDetails,
+    EsbuildConfig,
+    PageMapping,
+} from './dank.ts'
+import { LOG } from './developer.ts'
+import { isProductionBuild } from './flags.ts'
 
 const CFG_P = './dank.config.ts'
 
-export async function loadConfig(path: string = CFG_P): Promise<DankConfig> {
-    const modulePath = `${resolveConfigPath(path)}?${Date.now()}`
-    const module = await import(modulePath)
-    return await module.default
+export async function loadConfig(
+    mode: 'build' | 'serve',
+    path: string = CFG_P,
+): Promise<DankConfig> {
+    const modulePath = resolveConfigPath(path)
+    LOG({
+        realm: 'config',
+        message: 'loading config module',
+        data: {
+            modulePath,
+        },
+    })
+    const c = await resolveConfig(mode, modulePath)
+    normalizePagePaths(c.pages)
+    return c
 }
 
 export function resolveConfigPath(path: string): string {
@@ -16,3 +34,191 @@ export function resolveConfigPath(path: string): string {
         return resolve(process.cwd(), path)
     }
 }
+
+export async function resolveConfig(
+    mode: 'build' | 'serve',
+    modulePath: string,
+): Promise<DankConfig> {
+    const module = await import(`${modulePath}?${Date.now()}`)
+    const c: Partial<DankConfig> =
+        typeof module.default === 'function'
+            ? await module.default(resolveDankDetails(mode))
+            : module.default
+    validateDankConfig(c)
+    return c as DankConfig
+}
+
+function resolveDankDetails(mode: 'build' | 'serve'): DankDetails {
+    const production = isProductionBuild()
+    return {
+        dev: !production,
+        production,
+        mode,
+    }
+}
+
+function validateDankConfig(c: Partial<DankConfig>) {
+    try {
+        validatePorts(c)
+        validatePages(c.pages)
+        validateDevServices(c.services)
+        validateEsbuildConfig(c.esbuild)
+    } catch (e: any) {
+        LOG({
+            realm: 'config',
+            message: 'validation error',
+            data: {
+                error: e.message,
+            },
+        })
+        throw e
+    }
+}
+
+function validatePorts(c: Partial<DankConfig>) {
+    if (c.port !== null && typeof c.port !== 'undefined') {
+        if (typeof c.port !== 'number') {
+            throw Error('DankConfig.port must be a number')
+        }
+    }
+    if (c.previewPort !== null && typeof c.previewPort !== 'undefined') {
+        if (typeof c.previewPort !== 'number') {
+            throw Error('DankConfig.previewPort must be a number')
+        }
+    }
+}
+
+function validateEsbuildConfig(esbuild?: EsbuildConfig) {
+    if (esbuild?.loaders !== null && typeof esbuild?.loaders !== 'undefined') {
+        if (typeof esbuild.loaders !== 'object') {
+            throw Error(
+                'DankConfig.esbuild.loaders must be a map of extensions to esbuild loaders',
+            )
+        } else {
+            for (const [ext, loader] of Object.entries(esbuild.loaders)) {
+                if (typeof loader !== 'string') {
+                    throw Error(
+                        `DankConfig.esbuild.loaders['${ext}'] must be a string of a loader name`,
+                    )
+                }
+            }
+        }
+    }
+    if (esbuild?.plugins !== null && typeof esbuild?.plugins !== 'undefined') {
+        if (!Array.isArray(esbuild.plugins)) {
+            throw Error(
+                'DankConfig.esbuild.plugins must be an array of esbuild plugins',
+            )
+        }
+    }
+    if (esbuild?.port !== null && typeof esbuild?.port !== 'undefined') {
+        if (typeof esbuild.port !== 'number') {
+            throw Error('DankConfig.esbuild.port must be a number')
+        }
+    }
+}
+
+function validatePages(pages?: DankConfig['pages']) {
+    if (
+        pages === null ||
+        typeof pages === 'undefined' ||
+        Object.keys(pages).length === 0
+    ) {
+        throw Error('DankConfig.pages is required')
+    }
+    for (const [urlPath, mapping] of Object.entries(pages)) {
+        if (typeof mapping === 'string' && mapping.endsWith('.html')) {
+            continue
+        }
+        if (typeof mapping === 'object') {
+            validatePageMapping(urlPath, mapping)
+            continue
+        }
+        throw Error(
+            `DankConfig.pages['${urlPath}'] must configure an html file`,
+        )
+    }
+}
+
+function validatePageMapping(urlPath: string, mapping: PageMapping) {
+    if (
+        mapping.webpage === null ||
+        typeof mapping.webpage !== 'string' ||
+        !mapping.webpage.endsWith('.html')
+    ) {
+        throw Error(
+            `DankConfig.pages['${urlPath}'].webpage must configure an html file`,
+        )
+    }
+    if (mapping.pattern === null || typeof mapping.pattern === 'undefined') {
+        return
+    }
+    if (
+        typeof mapping.pattern === 'object' &&
+        mapping.pattern.constructor.name === 'RegExp'
+    ) {
+        return
+    }
+    throw Error(`DankConfig.pages['${urlPath}'].pattern must be a RegExp`)
+}
+
+function validateDevServices(services: DankConfig['services']) {
+    if (services === null || typeof services === 'undefined') {
+        return
+    }
+    if (!Array.isArray(services)) {
+        throw Error(`DankConfig.services must be an array`)
+    }
+    for (let i = 0; i < services.length; i++) {
+        const s = services[i]
+        if (s.command === null || typeof s.command === 'undefined') {
+            throw Error(`DankConfig.services[${i}].command is required`)
+        } else if (typeof s.command !== 'string' || s.command.length === 0) {
+            throw Error(
+                `DankConfig.services[${i}].command must be a non-empty string`,
+            )
+        }
+        if (s.cwd !== null && typeof s.cwd !== 'undefined') {
+            if (typeof s.cwd !== 'string' || s.cwd.trim().length === 0) {
+                throw Error(
+                    `DankConfig.services[${i}].cwd must be a non-empty string`,
+                )
+            }
+        }
+        if (s.env !== null && typeof s.env !== 'undefined') {
+            if (typeof s.env !== 'object') {
+                throw Error(
+                    `DankConfig.services[${i}].env must be an env variable map`,
+                )
+            }
+            for (const [k, v] of Object.entries(s.env)) {
+                if (typeof v !== 'string') {
+                    throw Error(
+                        `DankConfig.services[${i}].env[${k}] must be a string`,
+                    )
+                }
+            }
+        }
+        if (s.http !== null && typeof s.http !== 'undefined') {
+            if (typeof s.http.port !== 'number') {
+                throw Error(
+                    `DankConfig.services[${i}].http.port must be a number`,
+                )
+            }
+        }
+    }
+}
+
+function normalizePagePaths(pages: DankConfig['pages']) {
+    for (const [pageUrl, mapping] of Object.entries(pages)) {
+        if (typeof mapping === 'string') {
+            pages[pageUrl as `/${string}`] = normalizePagePath(mapping)
+        } else {
+            mapping.webpage = normalizePagePath(mapping.webpage)
+        }
+    }
+}
+
+function normalizePagePath(p: `${string}.html`): `${string}.html` {
+    return p.replace(/^\.\//, '') as `${string}.html`
+}

package/lib/dank.ts

@@ -66,157 +66,21 @@ export type EsbuildLoader =
     | 'json'
     | 'text'
 
-export async function defineConfig(
-    c: Partial<DankConfig>,
-): Promise<DankConfig> {
-    if (c.port !== null && typeof c.port !== 'undefined') {
-        if (typeof c.port !== 'number') {
-            throw Error('DankConfig.port must be a number')
-        }
-    }
-    if (c.previewPort !== null && typeof c.previewPort !== 'undefined') {
-        if (typeof c.previewPort !== 'number') {
-            throw Error('DankConfig.previewPort must be a number')
-        }
-    }
-    validatePages(c.pages)
-    validateDevServices(c.services)
-    validateEsbuildConfig(c.esbuild)
-    normalizePagePaths(c.pages!)
-    return c as DankConfig
-}
-
-function validateEsbuildConfig(esbuild?: EsbuildConfig) {
-    if (esbuild?.loaders !== null && typeof esbuild?.loaders !== 'undefined') {
-        if (typeof esbuild.loaders !== 'object') {
-            throw Error(
-                'DankConfig.esbuild.loaders must be a map of extensions to esbuild loaders',
-            )
-        } else {
-            for (const [ext, loader] of Object.entries(esbuild.loaders)) {
-                if (typeof loader !== 'string') {
-                    throw Error(
-                        `DankConfig.esbuild.loaders['${ext}'] must be a string of a loader name`,
-                    )
-                }
-            }
-        }
-    }
-    if (esbuild?.plugins !== null && typeof esbuild?.plugins !== 'undefined') {
-        if (!Array.isArray(esbuild.plugins)) {
-            throw Error(
-                'DankConfig.esbuild.plugins must be an array of esbuild plugins',
-            )
-        }
-    }
-    if (esbuild?.port !== null && typeof esbuild?.port !== 'undefined') {
-        if (typeof esbuild.port !== 'number') {
-            throw Error('DankConfig.esbuild.port must be a number')
-        }
-    }
-}
-
-function validatePages(pages?: DankConfig['pages']) {
-    if (
-        pages === null ||
-        typeof pages === 'undefined' ||
-        Object.keys(pages).length === 0
-    ) {
-        throw Error('DankConfig.pages is required')
-    }
-    for (const [urlPath, mapping] of Object.entries(pages)) {
-        if (typeof mapping === 'string' && mapping.endsWith('.html')) {
-            continue
-        }
-        if (typeof mapping === 'object') {
-            validatePageMapping(urlPath, mapping)
-            continue
-        }
-        throw Error(
-            `DankConfig.pages['${urlPath}'] must configure an html file`,
-        )
-    }
+// DankConfigFunction arg details about a dank process used when building DankConfig
+export type DankDetails = {
+    dev: boolean
+    production: boolean
+    mode: 'build' | 'serve'
 }
 
-function validatePageMapping(urlPath: string, mapping: PageMapping) {
-    if (
-        mapping.webpage === null ||
-        typeof mapping.webpage !== 'string' ||
-        !mapping.webpage.endsWith('.html')
-    ) {
-        throw Error(
-            `DankConfig.pages['${urlPath}'].webpage must configure an html file`,
-        )
-    }
-    if (mapping.pattern === null || typeof mapping.pattern === 'undefined') {
-        return
-    }
-    if (
-        typeof mapping.pattern === 'object' &&
-        mapping.pattern.constructor.name === 'RegExp'
-    ) {
-        return
-    }
-    throw Error(`DankConfig.pages['${urlPath}'].pattern must be a RegExp`)
-}
-
-function validateDevServices(services: DankConfig['services']) {
-    if (services === null || typeof services === 'undefined') {
-        return
-    }
-    if (!Array.isArray(services)) {
-        throw Error(`DankConfig.services must be an array`)
-    }
-    for (let i = 0; i < services.length; i++) {
-        const s = services[i]
-        if (s.command === null || typeof s.command === 'undefined') {
-            throw Error(`DankConfig.services[${i}].command is required`)
-        } else if (typeof s.command !== 'string' || s.command.length === 0) {
-            throw Error(
-                `DankConfig.services[${i}].command must be a non-empty string`,
-            )
-        }
-        if (s.cwd !== null && typeof s.cwd !== 'undefined') {
-            if (typeof s.cwd !== 'string' || s.cwd.trim().length === 0) {
-                throw Error(
-                    `DankConfig.services[${i}].cwd must be a non-empty string`,
-                )
-            }
-        }
-        if (s.env !== null && typeof s.env !== 'undefined') {
-            if (typeof s.env !== 'object') {
-                throw Error(
-                    `DankConfig.services[${i}].env must be an env variable map`,
-                )
-            }
-            for (const [k, v] of Object.entries(s.env)) {
-                if (typeof v !== 'string') {
-                    throw Error(
-                        `DankConfig.services[${i}].env[${k}] must be a string`,
-                    )
-                }
-            }
-        }
-        if (s.http !== null && typeof s.http !== 'undefined') {
-            if (typeof s.http.port !== 'number') {
-                throw Error(
-                    `DankConfig.services[${i}].http.port must be a number`,
-                )
-            }
-        }
-    }
-}
-
-function normalizePagePaths(pages: DankConfig['pages']) {
-    for (const [pageUrl, mapping] of Object.entries(pages)) {
-        if (typeof mapping === 'string') {
-            pages[pageUrl as `/${string}`] = normalizePagePath(mapping)
-        } else {
-            mapping.webpage = normalizePagePath(mapping.webpage)
-        }
-    }
-}
+export type DankConfigFunction = (
+    dank: DankDetails,
+) => Partial<DankConfig> | Promise<Partial<DankConfig>>
 
-function normalizePagePath(p: `${string}.html`): `${string}.html` {
-    return p.replace(/^\.\//, '') as `${string}.html`
+export function defineConfig(config: Partial<DankConfig>): Partial<DankConfig>
+export function defineConfig(config: DankConfigFunction): DankConfigFunction
+export function defineConfig(
+    config: Partial<DankConfig> | DankConfigFunction,
+): Partial<DankConfig> | DankConfigFunction {
+    return config
 }

package/lib/developer.ts

@@ -0,0 +1,117 @@
+import { createWriteStream, type WriteStream } from 'node:fs'
+import { mkdir, rm } from 'node:fs/promises'
+import os from 'node:os'
+import { dirname, resolve } from 'node:path'
+import packageJson from '../package.json' with { type: 'json' }
+
+const FILE = process.env.DANK_LOG_FILE
+const ROLLING =
+    process.env.DANK_LOG_ROLLING === '1' ||
+    process.env.DANK_LOG_ROLLING === 'true'
+
+const logs: Array<string> = []
+let initialized = false
+let preparing: Promise<void>
+let stream: WriteStream
+
+export type LogEvent = {
+    realm:
+        | 'build'
+        | 'serve'
+        | 'assets'
+        | 'config'
+        | 'html'
+        | 'registry'
+        | 'services'
+    message: string
+    data?: Record<string, LogEventData>
+}
+
+type LogEventData =
+    | LogEventDatum
+    | Array<LogEventDatum>
+    | Set<LogEventDatum>
+    | Record<string, LogEventDatum>
+
+type LogEventDatum = boolean | number | string | null
+
+function toStringLogEvent(logEvent: LogEvent): string {
+    const when = new Date().toISOString()
+    const message = `[${logEvent.realm}] ${logEvent.message}\n${when}\n`
+    if (!logEvent.data) {
+        return message
+    }
+    let data = ''
+    for (const k of Object.keys(logEvent.data).sort()) {
+        data += `\n    ${k} = ${toStringData(logEvent.data[k])}`
+    }
+    return `${message}${data}\n`
+}
+
+function toStringData(datum: LogEventData): string {
+    if (datum instanceof Set) {
+        datum = Array.from(datum)
+    }
+    if (
+        datum !== null &&
+        typeof datum === 'object' &&
+        datum.constructor.name === 'Object'
+    ) {
+        datum = Object.entries(datum).map(([k, v]) => `${k} = ${v}`)
+    }
+    if (Array.isArray(datum)) {
+        if (datum.length === 0) {
+            return '[]'
+        } else {
+            return `[\n        ${datum.join('\n        ')}\n    ]`
+        }
+    } else {
+        return `${datum}`
+    }
+}
+
+function logToFile(logEvent: LogEvent) {
+    logs.push(toStringLogEvent(logEvent))
+    if (!initialized) {
+        initialized = true
+        preparing = prepareLogFile().catch(onPrepareLogFileError)
+    }
+    preparing.then(syncLogs)
+}
+
+async function prepareLogFile() {
+    const path = resolve(FILE!)
+    if (!ROLLING) {
+        await rm(path, { force: true })
+    }
+    await mkdir(dirname(path), { recursive: true })
+    stream = createWriteStream(path, { flags: 'a' })
+    console.log('debug logging to', FILE)
+    logSystemDetails()
+}
+
+function logSystemDetails() {
+    stream.write(`\
+---
+os: ${os.type()}
+build: ${os.version()}
+cpu: ${os.arch()}
+cores: ${os.availableParallelism()}
+${process.versions.bun ? `bun ${process.versions.bun}` : `node ${process.version}`}
+dank: ${packageJson.version}
+\n`)
+}
+
+function syncLogs() {
+    if (!logs.length) return
+    const content = logs.join('\n') + '\n'
+    logs.length = 0
+    stream.write(content)
+}
+
+function onPrepareLogFileError(e: any) {
+    console.error(`init log file \`${FILE}\` error: ${e.message}`)
+    process.exit(1)
+}
+
+export const LOG = FILE?.length ? logToFile : () => {}

package/lib/flags.ts

@@ -87,7 +87,7 @@ const isPreviewBuild = () =>
 
 // `dank build` will minify sources and append git release tag to build tag
 // `dank serve` will pre-bundle with service worker and minify
-const isProductionBuild = () =>
+export const isProductionBuild = () =>
     process.env.PRODUCTION === 'true' || process.argv.includes('--production')
 
 // `dank serve` dank port for frontend webserver