@eighty4/dank 0.0.5-2 → 0.0.5-3

package/lib/build.ts

@@ -1,6 +1,5 @@
 import { mkdir, readFile, rm, writeFile } from 'node:fs/promises'
 import { join } from 'node:path'
-import { createBuildTag } from './build_tag.ts'
 import { loadConfig, type ResolvedDankConfig } from './config.ts'
 import { type DefineDankGlobal, createGlobalDefinitions } from './define.ts'
 import type { DankDirectories } from './dirs.ts'
@@ -14,7 +13,7 @@ export async function buildWebsite(
     if (!c) {
         c = await loadConfig('build', process.cwd())
     }
-    const buildTag = await createBuildTag(c.flags)
+    const buildTag = await c.buildTag()
     console.log(
         c.flags.minify
             ? c.flags.production

package/lib/build_tag.ts

@@ -1,25 +1,129 @@
 import { exec } from 'node:child_process'
+import type { DankConfig } from './dank.ts'
 import type { DankFlags } from './flags.ts'
 
-export async function createBuildTag(flags: DankFlags): Promise<string> {
+export async function createBuildTag(
+    projectDir: string,
+    flags: DankFlags,
+    buildTagSource?: DankConfig['buildTag'],
+): Promise<string> {
+    if (typeof buildTagSource === 'function') {
+        buildTagSource = await buildTagSource({ production: flags.production })
+    }
+    if (typeof buildTagSource === 'undefined' || buildTagSource === null) {
+        buildTagSource = await resolveExpressionDefault(projectDir)
+    }
+    if (typeof buildTagSource !== 'string') {
+        throw TypeError(
+            'DankConfig.buildTag must resolve to a string expession',
+        )
+    }
+    const params: BuildTagParams = {}
     const now = new Date()
+    const paramPattern = new RegExp(/{{\s*(?<name>[a-z][A-Za-z]+)\s*}}/g)
+    let paramMatch: RegExpExecArray | null
+    let buildTag = buildTagSource
+    let offset = 0
+    while ((paramMatch = paramPattern.exec(buildTagSource)) != null) {
+        const paramName = paramMatch.groups!.name.trim() as keyof BuildTagParams
+        let paramValue: string
+        if (params[paramName]) {
+            paramValue = params[paramName]
+        } else {
+            paramValue = params[paramName] = await getParamValue(
+                projectDir,
+                paramName,
+                now,
+                buildTagSource,
+            )
+        }
+        buildTag =
+            buildTag.substring(0, paramMatch.index + offset) +
+            paramValue +
+            buildTag.substring(paramMatch.index + paramMatch[0].length + offset)
+        offset += paramValue.length - paramMatch[0].length
+    }
+    const validate = /^[A-Za-z\d][A-Za-z\d-_\.]+$/
+    if (!validate.test(buildTag)) {
+        throw Error(
+            `build tag ${buildTag} does not pass pattern ${validate.source} validation`,
+        )
+    }
+    return buildTag
+}
+
+async function resolveExpressionDefault(projectDir: string): Promise<string> {
+    const base = '{{ date }}-{{ timeMS }}'
+    const isGitRepo = await new Promise(res =>
+        exec('git rev-parse --is-inside-work-tree', { cwd: projectDir }, err =>
+            res(!err),
+        ),
+    )
+    return isGitRepo ? base + '-{{ gitHash }}' : base
+}
+
+type BuildTagParams = {
+    date?: string
+    gitHash?: string
+    timeMS?: string
+}
+
+async function getParamValue(
+    projectDir: string,
+    name: keyof BuildTagParams,
+    now: Date,
+    buildTagSource: string,
+): Promise<string> {
+    switch (name) {
+        case 'date':
+            return getDate(now)
+        case 'gitHash':
+            try {
+                return await getGitHash(projectDir)
+            } catch (e) {
+                if (e === 'not-repo') {
+                    throw Error(
+                        `buildTag cannot use \`gitHash\` in \`${buildTagSource}\` outside of a git repository`,
+                    )
+                } else {
+                    throw e
+                }
+            }
+        case 'timeMS':
+            return getTimeMS(now)
+        default:
+            throw Error(name + ' is not a supported build tag param')
+    }
+}
+
+function getDate(now: Date): string {
+    return now.toISOString().substring(0, 10)
+}
+
+async function getGitHash(projectDir: string): Promise<string> {
+    return await new Promise((res, rej) =>
+        exec(
+            'git rev-parse --short HEAD',
+            { cwd: projectDir },
+            (err, stdout, stderr) => {
+                if (err) {
+                    if (stderr.includes('not a git repository')) {
+                        rej('not-repo')
+                    } else {
+                        rej(err)
+                    }
+                }
+                res(stdout.trim())
+            },
+        ),
+    )
+}
+
+function getTimeMS(now: Date): string {
     const ms =
         now.getUTCMilliseconds() +
         now.getUTCSeconds() * 1000 +
         now.getUTCMinutes() * 1000 * 60 +
         now.getUTCHours() * 1000 * 60 * 60
-    const date = now.toISOString().substring(0, 10)
-    const time = String(ms).padStart(8, '0')
-    const when = `${date}-${time}`
-    if (flags.production) {
-        const gitHash = await new Promise((res, rej) =>
-            exec('git rev-parse --short HEAD', (err, stdout) => {
-                if (err) rej(err)
-                res(stdout.trim())
-            }),
-        )
-        return `${when}-${gitHash}`
-    } else {
-        return when
-    }
+    return String(ms).padStart(8, '0')
 }

package/lib/config.ts

@@ -1,4 +1,5 @@
 import { isAbsolute, resolve } from 'node:path'
+import { createBuildTag } from './build_tag.ts'
 import type {
     DankConfig,
     DankDetails,
@@ -34,6 +35,8 @@ export type ResolvedDankConfig = {
     get devPages(): Readonly<DankConfig['devPages']>
     get services(): Readonly<DankConfig['services']>
 
+    buildTag(): Promise<string>
+
     reload(): Promise<void>
 }
 
@@ -60,6 +63,7 @@ export async function loadConfig(
 }
 
 class DankConfigInternal implements ResolvedDankConfig {
+    #buildTag: DankConfig['buildTag']
     #dirs: Readonly<DankDirectories>
     #flags: Readonly<DankFlags>
     #mode: 'build' | 'serve'
@@ -119,11 +123,20 @@ class DankConfigInternal implements ResolvedDankConfig {
         return this.#services
     }
 
+    async buildTag(): Promise<string> {
+        return await createBuildTag(
+            this.#dirs.projectRootAbs,
+            this.#flags,
+            this.#buildTag,
+        )
+    }
+
     async reload() {
         const userConfig = await resolveConfig(
             this.#modulePath,
             resolveDankDetails(this.#mode, this.#flags),
         )
+        this.#buildTag = userConfig.buildTag
         this.#dankPort = resolveDankPort(this.#flags, userConfig)
         this.#esbuildPort = resolveEsbuildPort(this.#flags, userConfig)
         this.#esbuild = Object.freeze(userConfig.esbuild)
@@ -173,6 +186,7 @@ function resolveDankDetails(
 function validateDankConfig(c: Partial<DankConfig>) {
     try {
         validatePorts(c)
+        validateBuildTag(c.buildTag)
         validatePages(c.pages)
         validateDevPages(c.devPages)
         validateDevServices(c.services)
@@ -202,6 +216,20 @@ function validatePorts(c: Partial<DankConfig>) {
     }
 }
 
+function validateBuildTag(buildTag: DankConfig['buildTag']) {
+    if (buildTag === null) {
+        return
+    }
+    switch (typeof buildTag) {
+        case 'undefined':
+        case 'string':
+        case 'function':
+            return
+        default:
+            throw Error('DankConfig.buildTag must be a string or function')
+    }
+}
+
 function validateEsbuildConfig(esbuild?: EsbuildConfig) {
     if (esbuild?.loaders !== null && typeof esbuild?.loaders !== 'undefined') {
         if (typeof esbuild.loaders !== 'object') {

package/lib/dank.ts

@@ -1,8 +1,8 @@
 import type { Plugin as EsbuildPlugin } from 'esbuild'
 
 export type DankConfig = {
-    // used for releases and service worker caching
-    // buildTag?:  (() => Promise<string> | string) | string
+    // used for service worker caching
+    buildTag?: string | BuildTagBuilder
 
     // customize esbuild configs
     esbuild?: EsbuildConfig
@@ -26,6 +26,14 @@ export type DankConfig = {
     services?: Array<DevService>
 }
 
+export type BuildTagParams = {
+    production: boolean
+}
+
+export type BuildTagBuilder = (
+    build: BuildTagParams,
+) => Promise<string> | string
+
 // extend an html entrypoint with url rewriting similar to cdn configurations
 // after trying all webpage, bundle and asset paths, mapping patterns
 // will be tested in the alphabetical order of the webpage paths

package/lib_js/build.js

@@ -1,6 +1,5 @@
 import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
 import { join } from "node:path";
-import { createBuildTag } from "./build_tag.js";
 import { loadConfig } from "./config.js";
 import { createGlobalDefinitions } from "./define.js";
 import { esbuildWebpages, esbuildWorkers } from "./esbuild.js";
@@ -10,7 +9,7 @@ async function buildWebsite(c) {
   if (!c) {
     c = await loadConfig("build", process.cwd());
   }
-  const buildTag = await createBuildTag(c.flags);
+  const buildTag = await c.buildTag();
   console.log(c.flags.minify ? c.flags.production ? "minified production" : "minified" : "unminified", "build", buildTag, "building in ./build/dist");
   await rm(c.dirs.buildRoot, { recursive: true, force: true });
   await mkdir(c.dirs.buildDist, { recursive: true });

package/lib_js/build_tag.js

@@ -1,21 +1,81 @@
 import { exec } from "node:child_process";
-async function createBuildTag(flags) {
+async function createBuildTag(projectDir, flags, buildTagSource) {
+  if (typeof buildTagSource === "function") {
+    buildTagSource = await buildTagSource({ production: flags.production });
+  }
+  if (typeof buildTagSource === "undefined" || buildTagSource === null) {
+    buildTagSource = await resolveExpressionDefault(projectDir);
+  }
+  if (typeof buildTagSource !== "string") {
+    throw TypeError("DankConfig.buildTag must resolve to a string expession");
+  }
+  const params = {};
   const now = /* @__PURE__ */ new Date();
-  const ms = now.getUTCMilliseconds() + now.getUTCSeconds() * 1e3 + now.getUTCMinutes() * 1e3 * 60 + now.getUTCHours() * 1e3 * 60 * 60;
-  const date = now.toISOString().substring(0, 10);
-  const time = String(ms).padStart(8, "0");
-  const when = `${date}-${time}`;
-  if (flags.production) {
-    const gitHash = await new Promise((res, rej) => exec("git rev-parse --short HEAD", (err, stdout) => {
-      if (err)
-        rej(err);
-      res(stdout.trim());
-    }));
-    return `${when}-${gitHash}`;
-  } else {
-    return when;
+  const paramPattern = new RegExp(/{{\s*(?<name>[a-z][A-Za-z]+)\s*}}/g);
+  let paramMatch;
+  let buildTag = buildTagSource;
+  let offset = 0;
+  while ((paramMatch = paramPattern.exec(buildTagSource)) != null) {
+    const paramName = paramMatch.groups.name.trim();
+    let paramValue;
+    if (params[paramName]) {
+      paramValue = params[paramName];
+    } else {
+      paramValue = params[paramName] = await getParamValue(projectDir, paramName, now, buildTagSource);
+    }
+    buildTag = buildTag.substring(0, paramMatch.index + offset) + paramValue + buildTag.substring(paramMatch.index + paramMatch[0].length + offset);
+    offset += paramValue.length - paramMatch[0].length;
+  }
+  const validate = /^[A-Za-z\d][A-Za-z\d-_\.]+$/;
+  if (!validate.test(buildTag)) {
+    throw Error(`build tag ${buildTag} does not pass pattern ${validate.source} validation`);
+  }
+  return buildTag;
+}
+async function resolveExpressionDefault(projectDir) {
+  const base = "{{ date }}-{{ timeMS }}";
+  const isGitRepo = await new Promise((res) => exec("git rev-parse --is-inside-work-tree", { cwd: projectDir }, (err) => res(!err)));
+  return isGitRepo ? base + "-{{ gitHash }}" : base;
+}
+async function getParamValue(projectDir, name, now, buildTagSource) {
+  switch (name) {
+    case "date":
+      return getDate(now);
+    case "gitHash":
+      try {
+        return await getGitHash(projectDir);
+      } catch (e) {
+        if (e === "not-repo") {
+          throw Error(`buildTag cannot use \`gitHash\` in \`${buildTagSource}\` outside of a git repository`);
+        } else {
+          throw e;
+        }
+      }
+    case "timeMS":
+      return getTimeMS(now);
+    default:
+      throw Error(name + " is not a supported build tag param");
   }
 }
+function getDate(now) {
+  return now.toISOString().substring(0, 10);
+}
+async function getGitHash(projectDir) {
+  return await new Promise((res, rej) => exec("git rev-parse --short HEAD", { cwd: projectDir }, (err, stdout, stderr) => {
+    if (err) {
+      if (stderr.includes("not a git repository")) {
+        rej("not-repo");
+      } else {
+        rej(err);
+      }
+    }
+    res(stdout.trim());
+  }));
+}
+function getTimeMS(now) {
+  const ms = now.getUTCMilliseconds() + now.getUTCSeconds() * 1e3 + now.getUTCMinutes() * 1e3 * 60 + now.getUTCHours() * 1e3 * 60 * 60;
+  return String(ms).padStart(8, "0");
+}
 export {
   createBuildTag
 };

package/lib_js/config.js

@@ -1,4 +1,5 @@
 import { isAbsolute, resolve } from "node:path";
+import { createBuildTag } from "./build_tag.js";
 import { defaultProjectDirs } from "./dirs.js";
 import { resolveFlags as lookupDankFlags } from "./flags.js";
 var __rewriteRelativeImportExtension = function(path, preserveJsx) {
@@ -24,6 +25,7 @@ async function loadConfig(mode, projectRootAbs) {
   return c;
 }
 class DankConfigInternal {
+  #buildTag;
   #dirs;
   #flags;
   #mode;
@@ -67,8 +69,12 @@ class DankConfigInternal {
   get services() {
     return this.#services;
   }
+  async buildTag() {
+    return await createBuildTag(this.#dirs.projectRootAbs, this.#flags, this.#buildTag);
+  }
   async reload() {
     const userConfig = await resolveConfig(this.#modulePath, resolveDankDetails(this.#mode, this.#flags));
+    this.#buildTag = userConfig.buildTag;
     this.#dankPort = resolveDankPort(this.#flags, userConfig);
     this.#esbuildPort = resolveEsbuildPort(this.#flags, userConfig);
     this.#esbuild = Object.freeze(userConfig.esbuild);
@@ -99,6 +105,7 @@ function resolveDankDetails(mode, flags) {
 function validateDankConfig(c) {
   try {
     validatePorts(c);
+    validateBuildTag(c.buildTag);
     validatePages(c.pages);
     validateDevPages(c.devPages);
     validateDevServices(c.services);
@@ -119,6 +126,19 @@ function validatePorts(c) {
     }
   }
 }
+function validateBuildTag(buildTag) {
+  if (buildTag === null) {
+    return;
+  }
+  switch (typeof buildTag) {
+    case "undefined":
+    case "string":
+    case "function":
+      return;
+    default:
+      throw Error("DankConfig.buildTag must be a string or function");
+  }
+}
 function validateEsbuildConfig(esbuild) {
   if (esbuild?.loaders !== null && typeof esbuild?.loaders !== "undefined") {
     if (typeof esbuild.loaders !== "object") {

package/lib_types/dank.d.ts

@@ -1,5 +1,6 @@
 import type { Plugin as EsbuildPlugin } from 'esbuild';
 export type DankConfig = {
+    buildTag?: string | BuildTagBuilder;
     esbuild?: EsbuildConfig;
     pages: Record<`/${string}`, `${string}.html` | PageMapping>;
     devPages?: Record<`/__${string}`, `${string}.html` | DevPageMapping>;
@@ -7,6 +8,10 @@ export type DankConfig = {
     previewPort?: number;
     services?: Array<DevService>;
 };
+export type BuildTagParams = {
+    production: boolean;
+};
+export type BuildTagBuilder = (build: BuildTagParams) => Promise<string> | string;
 export type PageMapping = {
     pattern?: RegExp;
     webpage: `${string}.html`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eighty4/dank",
-  "version": "0.0.5-2",
+  "version": "0.0.5-3",
   "type": "module",
   "license": "MIT",
   "author": "Adam McKee Bennett <adam.be.g84d@gmail.com>",