@temir.ra/create-test115 0.0.13 → 0.0.15

package/README.md

@@ -145,6 +145,7 @@ When building the library for distribution, the `tsconfig.build.json` configurat
     "src/**/*.ts"
   ],
   "exclude": [
+    "src/dev.ts",
     "node_modules",
     "dist",
     "tests",

package/dist/buildinfo.d.ts

@@ -0,0 +1,2 @@
+export declare const buildInfo = "0.0.14+ac7caf3";
+//# sourceMappingURL=buildinfo.d.ts.map

package/dist/buildinfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildinfo.d.ts","sourceRoot":"","sources":["../src/buildinfo.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,SAAS,mBAAmB,CAAC"}

package/dist/buildinfo.js

@@ -0,0 +1,2 @@
+// auto-generated by scripts/buildinfo.ts
+export const buildInfo = '0.0.14+ac7caf3';

package/dist/index.bundle.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import{cpSync as C,readFileSync as E,writeFileSync as G}from"fs";import{resolve as q,basename as H}from"path";import{fileURLToPath as I}from"url";var x=process.argv[2];if(!x)console.error("Usage: bun create my-template <destination>"),process.exit(1);var z=q(process.cwd(),x),A=H(z),J=q(I(import.meta.url),"../../template");C(J,z,{recursive:!0});var B=q(z,"package.json"),K=E(B,"utf8");G(B,K.replaceAll("{{PACKAGE_NAME}}",A));console.log(`✔ Created ${A}`);console.log(`  cd ${x} && bun install`);
+
+//# debugId=B480A6DF82A2DA2A64756E2164756E21

package/dist/index.bundle.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["..\\src\\index.ts"],
+  "sourcesContent": [
+    "#!/usr/bin/env node\r\n\r\nimport { cpSync, readFileSync, writeFileSync } from 'fs';\r\nimport { resolve, basename } from 'path';\r\nimport { fileURLToPath } from 'url';\r\n\r\n\r\nconst dest = process.argv[2];\r\nif (!dest) {\r\n    console.error('Usage: bun create my-template <destination>');\r\n    process.exit(1);\r\n}\r\n\r\nconst destDir = resolve(process.cwd(), dest);\r\nconst packageName = basename(destDir);\r\n\r\n// template/ dir is relative to the installed package\r\nconst templateDir = resolve(fileURLToPath(import.meta.url), '../../template');\r\n\r\n// Copy template to destination\r\ncpSync(templateDir, destDir, { recursive: true });\r\n\r\n// Replace placeholders in package.json\r\nconst pkgPath = resolve(destDir, 'package.json');\r\nconst pkg = readFileSync(pkgPath, 'utf8');\r\nwriteFileSync(pkgPath, pkg.replaceAll('{{PACKAGE_NAME}}', packageName));\r\n\r\nconsole.log(`✔ Created ${packageName}`);\r\nconsole.log(`  cd ${dest} && bun install`);\r\n"
+  ],
+  "mappings": ";AAEA,iBAAS,kBAAQ,mBAAc,WAC/B,kBAAS,cAAS,aAClB,wBAAS,YAGT,IAAM,EAAO,QAAQ,KAAK,GAC1B,GAAI,CAAC,EACD,QAAQ,MAAM,6CAA6C,EAC3D,QAAQ,KAAK,CAAC,EAGlB,IAAM,EAAU,EAAQ,QAAQ,IAAI,EAAG,CAAI,EACrC,EAAc,EAAS,CAAO,EAG9B,EAAc,EAAQ,EAAc,YAAY,GAAG,EAAG,gBAAgB,EAG5E,EAAO,EAAa,EAAS,CAAE,UAAW,EAAK,CAAC,EAGhD,IAAM,EAAU,EAAQ,EAAS,cAAc,EACzC,EAAM,EAAa,EAAS,MAAM,EACxC,EAAc,EAAS,EAAI,WAAW,mBAAoB,CAAW,CAAC,EAEtE,QAAQ,IAAI,aAAY,GAAa,EACrC,QAAQ,IAAI,QAAQ,kBAAqB",
+  "debugId": "B480A6DF82A2DA2A64756E2164756E21",
+  "names": []
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+import { cpSync, readFileSync, writeFileSync } from 'fs';
+import { resolve, basename } from 'path';
+import { fileURLToPath } from 'url';
+const dest = process.argv[2];
+if (!dest) {
+    console.error('Usage: bun create my-template <destination>');
+    process.exit(1);
+}
+const destDir = resolve(process.cwd(), dest);
+const packageName = basename(destDir);
+// template/ dir is relative to the installed package
+const templateDir = resolve(fileURLToPath(import.meta.url), '../../template');
+// Copy template to destination
+cpSync(templateDir, destDir, { recursive: true });
+// Replace placeholders in package.json
+const pkgPath = resolve(destDir, 'package.json');
+const pkg = readFileSync(pkgPath, 'utf8');
+writeFileSync(pkgPath, pkg.replaceAll('{{PACKAGE_NAME}}', packageName));
+console.log(`✔ Created ${packageName}`);
+console.log(`  cd ${dest} && bun install`);

package/dist/template/README.md

@@ -0,0 +1,29 @@
+# Introduction
+
+*<INTRO TEXT>*
+
+## Table of Contents
+
+1. [Quick Start](#quick-start)
+2. [Documentation](#documentation)
+3. [DevOps](#devops)
+    1. [Change Management](#change-management)
+    2. [Publish](#publish)
+
+# Quick Start
+
+*<QUICK START INSTRUCTIONS>*
+
+# Documentation
+
+*<DOCUMENTATION>*
+
+# DevOps
+
+## Change Management
+
+1. Create a new branch for the change.
+2. Make the changes and commit them to the branch.
+3. Bump the version in [`package.json`](package.json).
+4. Add an entry for the new version in [`CHANGELOG.md`](CHANGELOG.md).
+5. Pull request the branch.

package/dist/{package.json → template/package.json}

@@ -1,6 +1,6 @@
 {
-  "name": "@temir.ra/create-test115",
-  "version": "0.0.12",
+  "name": "",
+  "version": "",
   "description": "",
   "type": "module",
   "exports": {
@@ -14,14 +14,6 @@
   "files": [
     "dist"
   ],
-  "bun-create": {
-    "preinstall": [
-      "mv README.md README-template.md",
-      "mv README.md.template README.md",
-      "mv CHANGELOG.md CHANGELOG-template.md",
-      "mv CHANGELOG.md.template CHANGELOG.md"
-    ]
-  },
   "scripts": {
     "clean": "rm -rf dist/",
     "prebuild": "bun run scripts/buildinfo.ts",
@@ -29,7 +21,7 @@
     "build": "bun run build:lib && bun run build:cdn && bun run build:assets",
     "build:lib": "tsc --project tsconfig.build.json",
     "build:cdn": "bun run scripts/build-cdn.ts",
-    "build:assets": "echo 'no assets to build'",
+    "build:assets": "cp src/assets/* dist/assets/",
     "typecheck": "tsc --noEmit",
     "dev": "bun run --watch src/dev.ts"
   },

package/dist/template/src/buildinfo.ts

@@ -0,0 +1,2 @@
+// auto-generated by scripts/buildinfo.ts
+export const buildInfo = '-';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temir.ra/create-test115",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "",
   "type": "module",
   "exports": {
@@ -11,17 +11,13 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "bin": {
+    "create-test115": "./dist/index.bundle.js"
+  },
   "files": [
-    "dist"
+    "dist",
+    "template"
   ],
-  "bun-create": {
-    "preinstall": [
-      "mv README.md README-template.md",
-      "mv README.md.template README.md",
-      "mv CHANGELOG.md CHANGELOG-template.md",
-      "mv CHANGELOG.md.template CHANGELOG.md"
-    ]
-  },
   "scripts": {
     "clean": "rm -rf dist/",
     "prebuild": "bun run scripts/buildinfo.ts",
@@ -29,7 +25,7 @@
     "build": "bun run build:lib && bun run build:cdn && bun run build:assets",
     "build:lib": "tsc --project tsconfig.build.json",
     "build:cdn": "bun run scripts/build-cdn.ts",
-    "build:assets": "echo 'no assets to build'",
+    "build:assets": "cp -R template/ dist/template/",
     "typecheck": "tsc --noEmit",
     "dev": "bun run --watch src/dev.ts"
   },

package/template/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Version 0
+
+## 0.0.0
+
+1. Versioning initialized.

package/template/README.md

@@ -0,0 +1,29 @@
+# Introduction
+
+*<INTRO TEXT>*
+
+## Table of Contents
+
+1. [Quick Start](#quick-start)
+2. [Documentation](#documentation)
+3. [DevOps](#devops)
+    1. [Change Management](#change-management)
+    2. [Publish](#publish)
+
+# Quick Start
+
+*<QUICK START INSTRUCTIONS>*
+
+# Documentation
+
+*<DOCUMENTATION>*
+
+# DevOps
+
+## Change Management
+
+1. Create a new branch for the change.
+2. Make the changes and commit them to the branch.
+3. Bump the version in [`package.json`](package.json).
+4. Add an entry for the new version in [`CHANGELOG.md`](CHANGELOG.md).
+5. Pull request the branch.

package/template/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "",
+  "version": "",
+  "description": "",
+  "type": "module",
+  "exports": {
+    ".": {
+      "entrypoint": "./src/index.ts",
+      "browser": "./dist/index.bundle.js",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist/",
+    "prebuild": "bun run scripts/buildinfo.ts",
+    "test": "bun test",
+    "build": "bun run build:lib && bun run build:cdn && bun run build:assets",
+    "build:lib": "tsc --project tsconfig.build.json",
+    "build:cdn": "bun run scripts/build-cdn.ts",
+    "build:assets": "cp src/assets/* dist/assets/",
+    "typecheck": "tsc --noEmit",
+    "dev": "bun run --watch src/dev.ts"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5.9.3"
+  }
+}

package/template/scripts/build-cdn-map.json

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

package/template/scripts/build-cdn.ts

@@ -0,0 +1,158 @@
+import { readFileSync } from 'fs';
+import { join } from 'path';
+import CDN_MAP from 'scripts/build-cdn-map.json';
+
+
+interface ExportConditions {
+
+    [key: string]: string | undefined;
+
+    import?: string;
+    types?: string;
+    browser?: string;
+    entrypoint?: 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("[build-cdn] Could not read manifest for '" + packageIdentifier + "' at '" + manifestPath + "'. Is it installed?");
+        else
+            throw new Error("[build-cdn] Could not read package manifest at '" + manifestPath + "'.");
+    }
+
+    return manifest;
+
+}
+
+function getManifestEntrypoints(packageManifest: PackageManifest): string[] {
+
+    const exports = packageManifest.exports;
+    if (!exports) throw new Error('[build-cdn] No exports field found in package.json.');
+
+    const entrypoints = Object.entries(exports)
+        .map(([key, conditions]) => {
+            if (!conditions.entrypoint) throw new Error(`[build-cdn] 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(`[build-cdn] Package '${packageIdentifier}' is not listed in dependencies.`);
+
+    }
+    else {
+        if (!manifest.version) throw new Error('[build-cdn] 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_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('[build-cdn] Entrypoints:', entrypoints);
+
+let buildResult;
+
+console.log('[build-cdn] Starting ESM CDN 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('[build-cdn] Build failed:');
+    for (const message of buildResult.logs) {
+        console.error(message);
+    }
+    process.exit(1);
+}
+console.log('[build-cdn] ESM CDN bundle build completed successfully.');
+
+console.log('[build-cdn] Starting IIFE CDN 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('[build-cdn] Build failed:');
+    for (const message of buildResult.logs) {
+        console.error(message);
+    }
+    process.exit(1);
+}
+console.log('[build-cdn] IIFE CDN bundle build completed successfully.');

package/template/scripts/buildinfo.ts

@@ -0,0 +1,25 @@
+import { execSync } from 'child_process';
+import { writeFileSync } from 'fs';
+import { join } from 'path';
+
+
+const BUILD_INFO_FILE = join('src', 'buildinfo.ts');
+const GIT_COMMAND = 'git rev-parse --short HEAD';
+
+const version = process.env.npm_package_version ?? '0.0.0';
+
+let gitHash = '';
+try {
+    gitHash = execSync(GIT_COMMAND, { stdio: ['ignore', 'pipe', 'ignore'] })
+        .toString()
+        .trim();
+} catch { }
+
+const buildInfo = gitHash ? `${version}+${gitHash}` : version;
+
+writeFileSync(
+    BUILD_INFO_FILE,
+    `// auto-generated by scripts/buildinfo.ts\nexport const buildInfo = '${buildInfo}';\n`
+);
+
+console.log(`'${BUILD_INFO_FILE}' has been updated with build info: ${buildInfo}`);

package/template/src/buildinfo.ts

@@ -0,0 +1,2 @@
+// auto-generated by scripts/buildinfo.ts
+export const buildInfo = '-';

package/template/src/dev.ts

@@ -0,0 +1,5 @@
+const start = performance.now();
+
+// dev code
+
+console.log(`${(performance.now() - start).toFixed(3)}ms`);

package/template/tests/buildinfo.test.ts

@@ -0,0 +1,20 @@
+import { describe, it, expect } from 'bun:test';
+import { buildInfo } from '@/buildinfo';
+
+
+describe('buildInfo', () => {
+
+    it('should follow semantic versioning format with optional commit hash', () => {
+        expect(buildInfo).toMatch(/^\d+\.\d+\.\d+(\+[0-9a-f]+)?$/);
+    });
+
+    it('should not contain whitespace', () => {
+        expect(buildInfo).not.toMatch(/\s/);
+    });
+
+    it('should not be empty or dash', () => {
+        expect(buildInfo.length).toBeGreaterThan(0);
+        expect(buildInfo).not.toBe('-');
+    });
+
+});

package/template/tsconfig.build.json

@@ -0,0 +1,18 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "emitDeclarationOnly": false,
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "src/dev.ts",
+    "node_modules",
+    "dist",
+    "tests",
+    "scripts"
+  ]
+}

package/template/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "lib": [
+      "ES2022",
+      "DOM"
+    ],
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "outDir": "./dist",
+    "baseUrl": ".",
+    "paths": {
+      "@/*": [
+        "src/*"
+      ]
+    }
+  },
+  "include": [
+    "src/**/*.ts",
+    "tests/**/*.ts",
+    "scripts/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}

package/README.md.template

@@ -1,59 +0,0 @@
-# Introduction
-
-*<INTRO TEXT>*
-
-## Table of Contents
-
-1. [Quick Start](#quick-start)
-2. [Documentation](#documentation)
-3. [DevOps](#devops)
-    1. [Change Management](#change-management)
-    2. [Publish](#publish)
-
-# Quick Start
-
-*<QUICK START INSTRUCTIONS>*
-
-# Documentation
-
-*<DOCUMENTATION>*
-
-# DevOps
-
-## Change Management
-
-1. Create a new branch for the change.
-2. Make the changes and commit them to the branch.
-3. Bump the version in [`package.json`](package.json).
-4. Add an entry for the new version in [`CHANGELOG.md`](CHANGELOG.md).
-5. Pull request the branch.
-
-## Publish
-
-### bun
-
-```bash
-# placeholder:
-    # <SCOPE_WITHOUT_AT: <SCOPE_WITHOUT_AT>
-    # <REGISTRY_URL: <REGISTRY_URL>
-    # <BUN_PUBLISH_AUTH_TOKEN: <BUN_PUBLISH_AUTH_TOKEN>
-```
-
-`bunfig.toml`:
-
-```toml
-[install.scopes]
-<SCOPE_WITHOUT_AT> = { url = "<REGISTRY_URL>", token = "$BUN_PUBLISH_AUTH_TOKEN" }
-```
-
-```powershell
-$env:BUN_PUBLISH_AUTH_TOKEN = "<BUN_PUBLISH_AUTH_TOKEN>"
-bun publish
-```
-
-### npm
-
-```powershell
-npm login --registry https://registry.npmjs.org/
-npm publish --registry https://registry.npmjs.org/ --access public
-```

package/dist/CHANGELOG.md

@@ -1,46 +0,0 @@
-# Version 0
-
-## next
-
-1. Updated `scripts/buildinfo.ts` to use `join` from `path` module for better cross-platform compatibility.
-2. Added `scripts/build-cdn.ts` to generate a bundled version of the library for CDN usage.
-3. Added `scripts/build-cdn-map.json` to configure import path rewrites for the CDN build.
-4. Cleaned up legacy fields `main`, `module`, and `types` from `package.json` to rely solely on the `exports` field for module resolution.
-5. Added `browser` condition to the `exports` field in `package.json` to specify the bundled version for CDN usage.
-6. Added `src/dev.ts` as a development entry point for testing and experimentation during development.
-7. Added QoL `clean` and `test` scripts to `package.json`.
-8. Updated `build` workflow in `package.json`. Now it runs `build:lib` to create JavaScript and declaration files, then runs `build:cdn` to create the bundled version for CDN, and finally runs `build:assets` as a placeholder for any future asset build steps.
-9. Added `description` metadata field to `package.json`.
-10. Updated `tsconfig.json` and `tsconfig.build.json` with opiniated settings for better development, build, and publishing experience.
-11. Added documentation for custom scripts and rationale for the selected values in `tsconfig.json`, `tsconfig.build.json`, and `package.json`.
-12. Updated Quick Start instructions to reflect the new scripts and workflow.
-13. Renamed `README.md` and `CHANGELOG.md` to `README.md.template` and `CHANGELOG.md.template` respectively, and added a `bun-create` configuration in `package.json` to rename them back during project creation.
-14. Added `gitignore` (note the missing dot) to the template to ensure that generated projects have a proper `.gitignore` file.
-
-## 0.2.0
-
-1. Added `tests/` directory for unit tests using Bun's built-in test runner.
-2. Updated `tsconfig.json` to include `tests/` in the `include` array to allow TypeScript to recognize test files during development, while still excluding them from the build output using `tsconfig.build.json`.
-3. Updated `tsconfig.build.json` to exclude `tests/` to ensure that test files are not included in the build output.
-4. Updated `tsconfig.json` to include `baseUrl` and `paths` for better module resolution and cleaner import statements in the source code.
-
-## 0.1.4
-
-1. Introduced `tsconfig.build.json` to separate build-specific TypeScript configuration from development configuration, allowing for more tailored settings for each use case.
-2. Updated scripts in `package.json` to utilize `tsconfig.build.json` for the build process, ensuring that the build is optimized and does not include unnecessary files or settings meant for development.
-
-## 0.1.3
-
-1. Added `--no-git` to `bun create` command in Quick Start instructions to allow users to choose when to initialize git repository.
-
-## 0.1.2
-
-1. Added `--no-install` to `bun create` command in Quick Start instructions to allow users to choose when to install dependencies.
-
-## 0.1.1
-
-1. Fixed github user in Quick Start instructions.
-
-## 0.1.0
-
-1. First version of the template.

package/dist/README.md

@@ -1,289 +0,0 @@
-# Introduction
-
-This package serves as a template for creating Bun libraries. It includes a basic setup with TypeScript, build scripts, and versioning information.
-
-## Table of Contents
-
-1. [Quick Start](#quick-start)
-2. [Documentation](#documentation)
-    1. [`tsconfig.json` and `tsconfig.build.json`](#tsconfigjson-and-tsconfigbuildjson)
-    2. [`package.json`](#packagejson)
-    3. [Script `scripts/buildinfo.ts`](#script-scriptsbuildinfots)
-    4. [Script `scripts/build-cdn.ts`](#script-scriptsbuild-cdn-ts)
-    5. [CDN Map `scripts/build-cdn-map.json`](#cdn-map-scriptsbuild-cdn-mapjson)
-3. [DevOps](#devops)
-    1. [Change Management](#change-management)
-    2. [Publish](#publish)
-
-# Quick Start
-
-```bash
-# placeholder:
-    # <PACKAGE: <PACKAGE>
-
-bun create temir-ra/bun-lib-template --no-install --no-git <PACKAGE>
-cd <PACKAGE>
-bun install
-
-bun run dev
-bun run test
-
-bun run build
-
-bun publish
-```
-
-# Documentation
-
-`README-template.md` and `CHANGELOG-template.md` are the actual documentation files for this template package. Whereas `README.md` and `CHANGELOG.md` are copied as part of the package creation process and should be modified by the user to reflect the specifics of their library.
-
-## `tsconfig.json` and `tsconfig.build.json`
-
-```json
-{
-
-  "compilerOptions": {
-
-    // supported JavaScript features and syntax in the emitted JavaScript files
-    // ES2022 is a reasonable modern baseline
-    "target": "ES2022",
-    
-    // how import and export statements are written in the emitted JavaScript files
-    // ESNext emits standard ES module syntax unchanged
-    "module": "ESNext",
-    
-    // available built-in types
-    "lib": [
-      "ES2022", // standard JavaScript runtime APIs
-      "DOM"     // browser globals or import.meta.url
-    ],
-
-    // permissive about file extensions in import statements
-    // `tsconfig.build.json` switches to a stricter resolution mode
-    "moduleResolution": "bundler",
-
-    // collection of type-safety checks
-    "strict": true,
-
-    // compatibility shims that make it easier to import CommonJS modules as if they were ES modules
-    "esModuleInterop": true,
-
-    // do not type-check `.d.ts` files in `node_modules/`
-    "skipLibCheck": true,
-
-    // enforce consistent casing across import statements
-    "forceConsistentCasingInFileNames": true,
-
-    // allow importing JSON files as modules and infer the full type of the JSON structure
-    "resolveJsonModule": true,
-
-    // generate .d.ts type declaration files alongside the JavaScript output
-    "declaration": true,
-    // allow a consumer's editor to "go to definition" on something from the library
-    "declarationMap": true,
-
-    // prevents tsc from emitting any JavaScript files
-    // during development, rely on executing environment to handle TypeScript directly
-    // during build, use `tsconfig.build.json` to override this setting and emit JavaScript files for distribution
-    "emitDeclarationOnly": true,
-
-    // the directory where the emitted JavaScript and declaration files will be placed when building the library for distribution
-    // matches the `files` field in `package.json` that determines what gets published
-    "outDir": "./dist",
-
-    // the base directory to resolve non-relative module imports
-    "baseUrl": ".",
-
-    // a mapping of module import paths to physical paths in the project
-    // `paths` is a TypeScript-only feature - it must not be used in import statements in `src/` files
-    "paths": {
-      "@/*": [
-        "src/*"
-      ]
-    }
-
-  },
-
-  // files to be included/excluded by the TypeScript compiler and the development environment
-  // `tsconfig.build.json` overrides these settings to include only `src/` files
-  "include": [
-    "src/**/*.ts",
-    "tests/**/*.ts",
-    "scripts/**/*.ts"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist"
-  ]
-
-}
-```
-
-During development, the `tsconfig.json` configuration prevents emitting JavaScript files and relies on the executing environment to handle TypeScript directly. The `include` and `exclude` settings ensure that all relevant TypeScript files are included in the development environment.
-
-When building the library for distribution, the `tsconfig.build.json` configuration overrides the settings to emit JavaScript files and include only the `src/` files.
-
-```json
-{
-
-  "extends": "./tsconfig.json",
-
-  "compilerOptions": {
-
-    // `nodenext` is the strictest and most forward-compatible ESM mode
-    // imports must include explicit `.js` file extensions
-    "module": "nodenext",
-    "moduleResolution": "nodenext",
-
-    // emit both JavaScript files and declaration files for distribution
-    "emitDeclarationOnly": false,
-
-  },
-
-  // include only the source files for the build, excluding tests and scripts
-  "include": [
-    "src/**/*.ts"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist",
-    "tests",
-    "scripts"
-  ]
-
-}
-```
-
-## `package.json`
-
-```json
-{
-  "name": "package",
-  "version": "0.0.0",
-  "description": "",
-
-  // "module" makes every `.js` file in the package to be treated as an ES module unless explicitly named `.cjs`
-  "type": "module",
-
-  // runtime consults "exports" to find the actual file to load
-  // "import" condition is used by ESM consumers
-  // "types" condition is used by TypeScript to find the declaration files
-  // "browser" condition is used by CDN infrastructure
-  // "entrypoint" is a custom condition used by the build script to find the entry point for the CDN build
-  "exports": {
-    ".": {
-      "entrypoint": "./src/index.ts",
-      "browser": "./dist/index.bundle.js",
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
-    }
-  },
-
-  // files to include in the published package
-  "files": [
-    "dist"
-  ],
-
-  "scripts": {
-
-    // cleans the `dist/` directory before building
-    "clean": "rm -rf dist/",
-
-    // overwrites `src/buildinfo.ts` with the current version and git hash (if available)
-    "prebuild": "bun run scripts/buildinfo.ts",
-
-    // runs all tests
-    "test": "bun test",
-
-    // runs all build steps in sequence
-    "build": "bun run build:lib && bun run build:cdn && bun run build:assets",
-
-    // uses `tsconfig.build.json` to compile the TypeScript source files
-    "build:lib": "tsc --project tsconfig.build.json",
-
-    // bundles the library for CDN distribution in both ESM and IIFE formats
-    "build:cdn": "bun run scripts/build-cdn.ts",
-
-    // placeholder for any asset build steps (e.g. copying static files, generating documentation, etc.)
-    "build:assets": "echo 'no assets to build'",
-
-    // type checks the TypeScript source files without emitting any output
-    "typecheck": "tsc --noEmit",
-
-    // runs the development file
-    "dev": "bun run --watch src/dev.ts"
-
-  },
-  "devDependencies": {
-    "@types/bun": "latest",
-    "typescript": "^5.9.3"
-  }
-}
-```
-
-## Script `scripts/buildinfo.ts`
-
-This script overwrites `src/buildinfo.ts` with the current version from `package.json` and the current git hash (if available).
-
-## Script `scripts/build-cdn.ts`
-
-This script bundles the library for CDN distribution in both ESM and IIFE formats. It reads the `exports` field from `package.json` to determine the entry points for the library and generates bundled files in the `dist/` directory. A custom condition `entrypoint` is used in the `exports` field to specify the entry point for the CDN build.
-
-During the bundling process, the import paths in the source files can be rewritten to point to a CDN URL of a package, instead of using the package name that would be resolved from `node_modules/`.
-
-The list of import paths to rewrite and their corresponding CDN URLs can be configured in the `scripts/build-cdn-map.json` file.
-
-## CDN Map `scripts/build-cdn-map.json`
-
-This JSON file contains a mapping of module import paths to their corresponding CDN URLs. During the CDN build process, if an import path in the source files matches a key in this map, it will be replaced with the corresponding CDN URL in the bundled output.
-
-The URL can contain the placeholder `<VERSION>` which will be replaced with the current version of that package from `package.json`.
-
-```json
-{
-    "package-name": "https://cdn.jsdelivr.net/npm/package-name@<VERSION>/dist/index.bundle.js"
-}
-```
-
-- Keys are the import specifiers as they appear in source code.
-- Values are CDN URLs. The URL can contain the placeholder `<VERSION>` which will be replaced with the current version of that package from `package.json`.
-
-# DevOps
-
-## Change Management
-
-1. Create a new branch for the change.
-2. Make the changes and commit them to the branch.
-3. Add an entry for the new version in [`CHANGELOG-template.md`](CHANGELOG-template.md).
-4. Pull & publish request the branch.
-
-## Publish
-
-### `npmjs.org`
-
-⚠️ Either run `npm login` or set up `~/.npmrc` or `bunfig.toml` with the appropriate auth token before running the publish command.
-
-```powershell
-bun publish --registry https://registry.npmjs.org/ --access public
-```
-
-### Custom registry with `bun`
-
-```bash
-# placeholder:
-    # <SCOPE_WITHOUT_AT: <SCOPE_WITHOUT_AT>
-    # <REGISTRY_URL: <REGISTRY_URL>
-    # <BUN_PUBLISH_AUTH_TOKEN: <BUN_PUBLISH_AUTH_TOKEN>
-```
-
-`bunfig.toml`:
-
-```toml
-[install.scopes]
-<SCOPE_WITHOUT_AT> = { url = "<REGISTRY_URL>", token = "$BUN_PUBLISH_AUTH_TOKEN" }
-```
-
-```powershell
-$env:BUN_PUBLISH_AUTH_TOKEN = "<BUN_PUBLISH_AUTH_TOKEN>"
-bun publish
-```

package/dist/README.md.template

@@ -1,59 +0,0 @@
-# Introduction
-
-*<INTRO TEXT>*
-
-## Table of Contents
-
-1. [Quick Start](#quick-start)
-2. [Documentation](#documentation)
-3. [DevOps](#devops)
-    1. [Change Management](#change-management)
-    2. [Publish](#publish)
-
-# Quick Start
-
-*<QUICK START INSTRUCTIONS>*
-
-# Documentation
-
-*<DOCUMENTATION>*
-
-# DevOps
-
-## Change Management
-
-1. Create a new branch for the change.
-2. Make the changes and commit them to the branch.
-3. Bump the version in [`package.json`](package.json).
-4. Add an entry for the new version in [`CHANGELOG.md`](CHANGELOG.md).
-5. Pull request the branch.
-
-## Publish
-
-### bun
-
-```bash
-# placeholder:
-    # <SCOPE_WITHOUT_AT: <SCOPE_WITHOUT_AT>
-    # <REGISTRY_URL: <REGISTRY_URL>
-    # <BUN_PUBLISH_AUTH_TOKEN: <BUN_PUBLISH_AUTH_TOKEN>
-```
-
-`bunfig.toml`:
-
-```toml
-[install.scopes]
-<SCOPE_WITHOUT_AT> = { url = "<REGISTRY_URL>", token = "$BUN_PUBLISH_AUTH_TOKEN" }
-```
-
-```powershell
-$env:BUN_PUBLISH_AUTH_TOKEN = "<BUN_PUBLISH_AUTH_TOKEN>"
-bun publish
-```
-
-### npm
-
-```powershell
-npm login --registry https://registry.npmjs.org/
-npm publish --registry https://registry.npmjs.org/ --access public
-```

package/dist/gitignore

@@ -1,2 +0,0 @@
-dist
-node_modules

package/dist/src/buildinfo.ts

@@ -1,2 +0,0 @@
-// auto-generated by scripts/buildinfo.ts
-export const buildInfo = '0.0.12+ac7caf3';