@temir.ra/create-template 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Version 0
 
+## 0.1.2
+
+1. Updated `package.json` from `create-ts-lib` template.
+
+## 0.1.1
+
+1. Added clarifications to `README.md`.
+
 ## 0.1.0
 
 1. First published version.

package/README.md

@@ -38,10 +38,24 @@ bun install
 
 # Documentation
 
+The following sections explain the configurations and conventions baked into the generated package. Useful when adapting it to fit specific needs.
+
 *<DOCUMENTATION>*
 
 # DevOps
 
+```bash
+bun install
+
+bun run clean
+bun run build
+bun run tests
+
+bun run dev
+
+# see publish section for publish instructions
+```
+
 ## Change Management
 
 1. Create a new branch for the change.

package/buildinfo.txt

@@ -1 +1 @@
-0.1.0+4727289
+0.1.2+1e4ccca

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temir.ra/create-template",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Template package to create new template packages",
   "author": "temir.ra",
   "license": "MIT",
@@ -20,6 +20,9 @@
   },
   "bin": "./dist/cli.bundle.js",
   "files": [
+    "scripts/buildinfo.ts",
+    "scripts/build-bundle.ts",
+    "scripts/cdn-rewrite-map.json",
     "dist",
     "CHANGELOG.md",
     "buildinfo.txt",
@@ -33,7 +36,6 @@
     "tests": "bun test",
     "typecheck": "tsc --noEmit",
     "reinstall": "rm -rf node_modules && rm -f bun.lock && bun pm cache rm && bun install && bunx tsc --version",
-    "dev": "bun run buildinfo && bun run --watch scripts/dev.ts",
     "prebuild": "bun run buildinfo",
     "build": "bun run build:cli-bundle",
     "build:cli-bundle": "bun build src/cli.ts --entry-naming \"[dir]/[name].bundle.[ext]\" --outdir dist --target node --format esm --minify --sourcemap=external"

package/scripts/build-bundle.ts

@@ -0,0 +1,161 @@
+import { readFileSync } from 'fs';
+import { join } from 'path';
+
+import CDN_REWRITE_MAP from './cdn-rewrite-map.json';
+
+
+interface ExportConditions {
+    [key: string]: string | undefined;
+    entrypoint?: string;
+    types?: string;
+    browser?: string;
+    import?: string;
+}
+
+interface DependencyMap {
+    [packageName: string]: string;
+}
+
+interface PackageManifest {
+    version: string;
+    exports?: Record<string, ExportConditions>;
+    dependencies?: DependencyMap;
+    devDependencies?: DependencyMap;
+    peerDependencies?: DependencyMap;
+}
+
+function getManifest(packageIdentifier?: string): PackageManifest {
+
+    const manifestPath = packageIdentifier
+        ? join('node_modules', packageIdentifier, 'package.json')
+        : 'package.json';
+
+    let manifest: PackageManifest;
+    try {
+        manifest = JSON.parse(readFileSync(manifestPath, 'utf-8'));
+    } catch {
+        if (packageIdentifier)
+            throw new Error(`[scripts/build-bundle.ts] Could not read manifest for '${packageIdentifier}' at '${manifestPath}'.`);
+        else
+            throw new Error(`[scripts/build-bundle.ts] Could not read package manifest at '${manifestPath}'.`);
+    }
+
+    return manifest;
+
+}
+
+function getManifestEntrypoints(packageManifest: PackageManifest): string[] {
+
+    const exports = packageManifest.exports;
+    if (!exports)
+        throw new Error(`[scripts/build-bundle.ts] No 'exports' field found in the given package manifest.`);
+
+    const entrypoints = Object.entries(exports)
+        .map(([key, conditions]) => {
+            if (!conditions.entrypoint)
+                throw new Error(`[scripts/build-bundle.ts] Export '${key}' does not have an 'entrypoint' condition.`);
+            return conditions.entrypoint;
+        });
+
+    return entrypoints;
+
+}
+
+function getPackageVersion(manifest: PackageManifest, packageIdentifier?: string): string {
+
+    let version: string | undefined;
+    if (packageIdentifier) {
+
+        const dependencies = {
+            ...manifest.dependencies,
+            ...manifest.devDependencies,
+            ...manifest.peerDependencies,
+        };
+
+        version = dependencies[packageIdentifier];
+        if (!version)
+            throw new Error(`[scripts/build-bundle.ts] Package '${packageIdentifier}' is not listed in dependencies.`);
+
+    }
+    else {
+        if (!manifest.version)
+            throw new Error('[scripts/build-bundle.ts] Package manifest does not contain a version field.');
+        version = manifest.version;
+    }
+
+    return version;
+
+}
+
+function resolveCdnUrl(importSpecifier: string, urlTemplate: string): string {
+    const manifest = getManifest();
+    const version = getPackageVersion(manifest, importSpecifier);
+    return urlTemplate.replace('<VERSION>', version);
+}
+
+const cdnRewritePlugin = {
+    name: 'cdn-rewrite',
+    setup(build: any) {
+
+        const resolved = new Map<string, string>();
+        for (const [importSpecifier, urlTemplate] of Object.entries(CDN_REWRITE_MAP) as [string, string][]) {
+            const url = resolveCdnUrl(importSpecifier, urlTemplate);
+            resolved.set(importSpecifier, url);
+            console.log(`[cdn-rewrite] '${importSpecifier}' → '${url}'`);
+        }
+
+        build.onResolve({ filter: /\*/ }, (args: any) => {
+            const url = resolved.get(args.path);
+            if (url) return { path: url, external: true };
+        });
+
+    },
+};
+
+
+const entrypoints = getManifestEntrypoints(getManifest());
+console.log('[scripts/build-bundle.ts] Entrypoints:', entrypoints);
+
+let buildResult;
+
+console.log('[scripts/build-bundle.ts] Starting ESM bundle build...');
+buildResult = await Bun.build({
+    entrypoints,
+    outdir: 'dist',
+    naming: '[dir]/[name].bundle.[ext]',
+    target: 'browser',
+    format: 'esm',
+    minify: true,
+    sourcemap: 'external',
+    plugins: [cdnRewritePlugin],
+});
+
+if (!buildResult.success) {
+    console.error('[scripts/build-bundle.ts] Build failed:');
+    for (const message of buildResult.logs) {
+        console.error(message);
+    }
+    process.exit(1);
+}
+console.log('[scripts/build-bundle.ts] ESM bundle build completed successfully.');
+
+console.log('[scripts/build-bundle.ts] Starting IIFE bundle build...');
+buildResult = await Bun.build({
+    entrypoints,
+    outdir: 'dist',
+    naming: '[dir]/[name].iife.[ext]',
+    target: 'browser',
+    format: 'iife',
+    minify: true,
+    sourcemap: 'external',
+    plugins: [cdnRewritePlugin],
+});
+
+if (!buildResult.success) {
+    console.error('[scripts/build-bundle.ts] Build failed:');
+    for (const message of buildResult.logs) {
+        console.error(message);
+    }
+    process.exit(1);
+}
+console.log('[scripts/build-bundle.ts] IIFE bundle build completed successfully.');

package/scripts/buildinfo.ts

@@ -0,0 +1,25 @@
+import { execSync } from 'child_process';
+import { readFileSync, writeFileSync } from 'fs';
+
+
+const BUILD_INFO_FILE = 'buildinfo.txt';
+const GIT_COMMAND = 'git rev-parse --short HEAD';
+
+const version: string = JSON.parse(readFileSync('package.json', 'utf-8')).version;
+
+let gitHash = '';
+try {
+    gitHash = execSync(GIT_COMMAND, { stdio: ['ignore', 'pipe', 'ignore'] })
+        .toString()
+        .trim();
+} catch { }
+
+const buildinfo = gitHash
+    ? version.includes('+')
+        ? `${version}.${gitHash}`
+        : `${version}+${gitHash}`
+    : version;
+
+writeFileSync(BUILD_INFO_FILE, buildinfo.trim(), 'utf-8');
+
+console.log(`'${BUILD_INFO_FILE}' has been updated with build info: ${buildinfo}`);

package/scripts/cdn-rewrite-map.json

@@ -0,0 +1 @@
+{}

package/template/README.md

@@ -40,10 +40,24 @@ bun install
 
 # Documentation
 
+The following sections explain the configurations and conventions baked into the generated package. Useful when adapting it to fit specific needs.
+
 *<DOCUMENTATION>*
 
 # DevOps
 
+```bash
+bun install
+
+bun run clean
+bun run build
+bun run tests
+
+bun run dev
+
+# see publish section for publish instructions
+```
+
 ## Change Management
 
 1. Create a new branch for the change.

package/template/package.json

@@ -11,13 +11,16 @@
     "type": "git",
     "url": ""
   },
-  "private": true,
+  "private": false,
   "type": "module",
   "imports": {
     "#src/*.js": "./src/*.ts"
   },
   "bin": "./dist/cli.bundle.js",
   "files": [
+    "scripts/buildinfo.ts",
+    "scripts/build-bundle.ts",
+    "scripts/cdn-rewrite-map.json",
     "dist",
     "CHANGELOG.md",
     "buildinfo.txt",
@@ -31,7 +34,6 @@
     "tests": "bun test",
     "typecheck": "tsc --noEmit",
     "reinstall": "rm -rf node_modules && rm -f bun.lock && bun pm cache rm && bun install && bunx tsc --version",
-    "dev": "bun run buildinfo && bun run --watch scripts/dev.ts",
     "prebuild": "bun run buildinfo",
     "build": "bun run build:cli-bundle",
     "build:cli-bundle": "bun build src/cli.ts --entry-naming \"[dir]/[name].bundle.[ext]\" --outdir dist --target node --format esm --minify --sourcemap=external"