@temir.ra/create-test115 0.0.12 → 0.0.14

package/CHANGELOG.md

@@ -0,0 +1,46 @@
+# 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/CHANGELOG.md.template

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

package/gitignore

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temir.ra/create-test115",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "",
   "type": "module",
   "exports": {
@@ -12,7 +12,17 @@
     }
   },
   "files": [
-    "dist"
+    "src",
+    "tests",
+    "scripts",
+    "tsconfig.json",
+    "tsconfig.build.json",
+    "README.md",
+    "README.md.template",
+    "CHANGELOG.md",
+    "CHANGELOG.md.template",
+    "gitignore",
+    "package.json"
   ],
   "bun-create": {
     "preinstall": [

package/scripts/build-cdn-map.json

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

package/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/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/src/buildinfo.ts

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

package/src/dev.ts

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

package/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/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/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"
+  ]
+}