@temir.ra/create-template 0.5.5 → 0.6.1

package/dist/template/scripts/build-bundle.ts

@@ -1,212 +1,212 @@
-import { cpSync, existsSync, readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import {
-    build,
-    type BuildFailure,
-    type OnResolveArgs,
-    type OnResolveResult,
-    type Plugin as EsbuildPlugin,
-    type PluginBuild,
-    type BuildOptions,
-    type BuildResult
-} from 'esbuild';
-
-import IMPORT_MAP from './import-map.json';
-
-
-interface ExportConditions {
-    [key: string]: string | undefined;
-    entrypoint?: string;
-    types?: string;
-    browser?: string;
-    import?: string;
-}
-interface Dependency {
-    [key: string]: string;
-}
-interface PackageManifest {
-    version: string;
-    exports?: Record<string, ExportConditions>;
-    dependencies?: Dependency;
-    devDependencies?: Dependency;
-    peerDependencies?: Dependency;
-}
-
-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 {
-        throw new Error(`[scripts/build-bundle.ts] Failed to 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] Failed to read entrypoints from package manifest: 'exports' field is missing.`);
-
-    const entrypoints = Object.entries(exports)
-        .filter(([_, conditions]) => conditions.entrypoint)
-        .map(([_, conditions]) => conditions.entrypoint as string);
-
-    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] Failed to read version for package '${packageIdentifier}': package is not listed in dependencies.`);
-
-    }
-    else {
-        if (!manifest.version)
-            throw new Error('[scripts/build-bundle.ts] Failed to read package version from manifest: version field is missing.');
-        version = manifest.version;
-    }
-
-    return version;
-
-}
-
-function resolveVersionInCdnUrl(importSpecifier: string, cdnUrl: string): string {
-    if (cdnUrl.includes('<VERSION>')) {
-        const manifest = getManifest();
-        const version = getPackageVersion(manifest, importSpecifier);
-        let resolvedVersion = version;
-        if (resolvedVersion.startsWith('workspace:')) resolvedVersion = resolvedVersion.replace(/^workspace:/, '');
-        if (resolvedVersion.startsWith('^') || resolvedVersion.startsWith('~')) resolvedVersion = resolvedVersion.substring(1);
-        if (resolvedVersion.length === 0)
-            throw new Error(`[scripts/build-bundle.ts] Failed to resolve version for package '${importSpecifier}': resolved version is empty.`);
-        return cdnUrl.replace('<VERSION>', resolvedVersion);
-    }
-    return cdnUrl;
-}
-
-const esbuildLog: EsbuildPlugin = {
-    name: 'esbuild-log',
-    setup(build: PluginBuild) {
-        const buildFormat = build.initialOptions.format ? `${build.initialOptions.format} ` : '';
-        build.onStart(() => {
-            console.log(`[esbuild-log plugin] ${buildFormat}build started...`);
-        });
-        build.onEnd((result: BuildResult<BuildOptions>) => {
-            if (result.errors.length > 0) {
-                console.error(`[esbuild-log plugin] ${buildFormat}build failed.`);
-            } else {
-                console.log(`[esbuild-log plugin] ${buildFormat}build finished.`);
-            }
-        });
-    }
-}
-const COPY_FILES: string[] = [
-    "buildinfo.txt",
-    "buildinfo-template.txt",
-    "CHANGELOG.md",
-    "template/"
-];
-const copyFiles: EsbuildPlugin = {
-    name: 'copy-files',
-    setup(build: PluginBuild) {
-        build.onEnd((result: BuildResult<BuildOptions>) => {
-            const outDir = build.initialOptions.outdir || 'dist/';
-            console.log(`[copy-files plugin] Copying additional files to '${outDir}'...`);
-            for (const file of COPY_FILES) {
-                const destination = join(outDir, file);
-                if (existsSync(file)) {
-                    cpSync(file, destination, { recursive: true });
-                    console.log(`[copy-files plugin] Copied '${file}' to '${destination}'.`);
-                } else {
-                    console.warn(`[copy-files plugin] File '${file}' does not exist. Skipping...`);
-                }
-            }
-        });
-    }
-}
-const importMap: EsbuildPlugin = {
-    name: 'import-map',
-    setup(build: PluginBuild) {
-
-        for (const [importSpecifier, urlTemplate] of Object.entries(IMPORT_MAP) as [string, string | null][]) {
-
-            const url = urlTemplate ? resolveVersionInCdnUrl(importSpecifier, urlTemplate) : null;
-            console.log(`[import-map plugin] '${importSpecifier}' → ${url ? `'${url}'` : 'external (no rewrite)'}`);
-
-            const escapedSpecifier = importSpecifier.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-            build.onResolve(
-                { filter: new RegExp(`^${escapedSpecifier}$`) },
-                (args: OnResolveArgs): OnResolveResult | undefined => {
-                    return { path: url ?? args.path, external: true };
-                }
-            );
-
-        }
-
-    },
-};
-
-
-const entrypoints = getManifestEntrypoints(getManifest());
-console.log('[scripts/build-bundle.ts] Entrypoints:', entrypoints);
-
-const buildOptions: BuildOptions = {
-    entryPoints: entrypoints,
-    outdir: 'dist/',
-    entryNames: '[dir]/[name].bundle',
-    platform: 'node',
-    format: 'esm',
-    bundle: true,
-    minify: true,
-    sourcemap: 'external',
-    plugins: [esbuildLog, copyFiles, importMap],
-};
-
-try {
-    await build(buildOptions);
-} catch (error) {
-    console.error('[scripts/build-bundle.ts] Build failed:');
-    for (const message of (error as BuildFailure).errors) {
-        console.error(message);
-    }
-    process.exit(1);
-}
-
-const omitIife = process.argv.includes('--omit-iife');
-if (!omitIife) {
-    try {
-        await build({
-            ...buildOptions,
-            entryNames: '[dir]/[name].bundle.iife',
-            format: 'iife',
-            banner: { js: 'var __importMetaUrl = document.currentScript && document.currentScript.src || \'\';' },
-            define: { 'import.meta.url': '__importMetaUrl' },
-            plugins: [esbuildLog, importMap],
-        });
-    } catch (error) {
-        console.error('[scripts/build-bundle.ts] Build failed:');
-        for (const message of (error as BuildFailure).errors) {
-            console.error(message);
-        }
-        process.exit(1);
-    }
-}
+import { cpSync, existsSync, readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import {
+    build,
+    type BuildFailure,
+    type OnResolveArgs,
+    type OnResolveResult,
+    type Plugin as EsbuildPlugin,
+    type PluginBuild,
+    type BuildOptions,
+    type BuildResult
+} from 'esbuild';
+
+import IMPORT_MAP from './import-map.json';
+
+
+interface ExportConditions {
+    [key: string]: string | undefined;
+    entrypoint?: string;
+    types?: string;
+    browser?: string;
+    import?: string;
+}
+interface Dependency {
+    [key: string]: string;
+}
+interface PackageManifest {
+    version: string;
+    exports?: Record<string, ExportConditions>;
+    dependencies?: Dependency;
+    devDependencies?: Dependency;
+    peerDependencies?: Dependency;
+}
+
+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 {
+        throw new Error(`[scripts/build-bundle.ts] Failed to 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] Failed to read entrypoints from package manifest: 'exports' field is missing.`);
+
+    const entrypoints = Object.entries(exports)
+        .filter(([_, conditions]) => conditions.entrypoint)
+        .map(([_, conditions]) => conditions.entrypoint as string);
+
+    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] Failed to read version for package '${packageIdentifier}': package is not listed in dependencies.`);
+
+    }
+    else {
+        if (!manifest.version)
+            throw new Error('[scripts/build-bundle.ts] Failed to read package version from manifest: version field is missing.');
+        version = manifest.version;
+    }
+
+    return version;
+
+}
+
+function resolveVersionInCdnUrl(importSpecifier: string, cdnUrl: string): string {
+    if (cdnUrl.includes('<VERSION>')) {
+        const manifest = getManifest();
+        const version = getPackageVersion(manifest, importSpecifier);
+        let resolvedVersion = version;
+        if (resolvedVersion.startsWith('workspace:')) resolvedVersion = resolvedVersion.replace(/^workspace:/, '');
+        if (resolvedVersion.startsWith('^') || resolvedVersion.startsWith('~')) resolvedVersion = resolvedVersion.substring(1);
+        if (resolvedVersion.length === 0)
+            throw new Error(`[scripts/build-bundle.ts] Failed to resolve version for package '${importSpecifier}': resolved version is empty.`);
+        return cdnUrl.replace('<VERSION>', resolvedVersion);
+    }
+    return cdnUrl;
+}
+
+const esbuildLog: EsbuildPlugin = {
+    name: 'esbuild-log',
+    setup(build: PluginBuild) {
+        const buildFormat = build.initialOptions.format ? `${build.initialOptions.format} ` : '';
+        build.onStart(() => {
+            console.log(`[esbuild-log plugin] ${buildFormat}build started...`);
+        });
+        build.onEnd((result: BuildResult<BuildOptions>) => {
+            if (result.errors.length > 0) {
+                console.error(`[esbuild-log plugin] ${buildFormat}build failed.`);
+            } else {
+                console.log(`[esbuild-log plugin] ${buildFormat}build finished.`);
+            }
+        });
+    }
+}
+const COPY_FILES: string[] = [
+    "buildinfo.txt",
+    "buildinfo-template.txt",
+    "CHANGELOG.md",
+    "template/"
+];
+const copyFiles: EsbuildPlugin = {
+    name: 'copy-files',
+    setup(build: PluginBuild) {
+        build.onEnd((result: BuildResult<BuildOptions>) => {
+            const outDir = build.initialOptions.outdir || 'dist/';
+            console.log(`[copy-files plugin] Copying additional files to '${outDir}'...`);
+            for (const file of COPY_FILES) {
+                const destination = join(outDir, file);
+                if (existsSync(file)) {
+                    cpSync(file, destination, { recursive: true });
+                    console.log(`[copy-files plugin] Copied '${file}' to '${destination}'.`);
+                } else {
+                    console.warn(`[copy-files plugin] File '${file}' does not exist. Skipping...`);
+                }
+            }
+        });
+    }
+}
+const importMap: EsbuildPlugin = {
+    name: 'import-map',
+    setup(build: PluginBuild) {
+
+        for (const [importSpecifier, urlTemplate] of Object.entries(IMPORT_MAP) as [string, string | null][]) {
+
+            const url = urlTemplate ? resolveVersionInCdnUrl(importSpecifier, urlTemplate) : null;
+            console.log(`[import-map plugin] '${importSpecifier}' → ${url ? `'${url}'` : 'external (no rewrite)'}`);
+
+            const escapedSpecifier = importSpecifier.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+            build.onResolve(
+                { filter: new RegExp(`^${escapedSpecifier}$`) },
+                (args: OnResolveArgs): OnResolveResult | undefined => {
+                    return { path: url ?? args.path, external: true };
+                }
+            );
+
+        }
+
+    },
+};
+
+
+const entrypoints = getManifestEntrypoints(getManifest());
+console.log('[scripts/build-bundle.ts] Entrypoints:', entrypoints);
+
+const buildOptions: BuildOptions = {
+    entryPoints: entrypoints,
+    outdir: 'dist/',
+    entryNames: '[dir]/[name].bundle',
+    platform: 'node',
+    format: 'esm',
+    bundle: true,
+    minify: true,
+    sourcemap: 'external',
+    plugins: [esbuildLog, copyFiles, importMap],
+};
+
+try {
+    await build(buildOptions);
+} catch (error) {
+    console.error('[scripts/build-bundle.ts] Build failed:');
+    for (const message of (error as BuildFailure).errors) {
+        console.error(message);
+    }
+    process.exit(1);
+}
+
+const omitIife = process.argv.includes('--omit-iife');
+if (!omitIife) {
+    try {
+        await build({
+            ...buildOptions,
+            entryNames: '[dir]/[name].bundle.iife',
+            format: 'iife',
+            banner: { js: 'var __importMetaUrl = document.currentScript && document.currentScript.src || \'\';' },
+            define: { 'import.meta.url': '__importMetaUrl' },
+            plugins: [esbuildLog, importMap],
+        });
+    } catch (error) {
+        console.error('[scripts/build-bundle.ts] Build failed:');
+        for (const message of (error as BuildFailure).errors) {
+            console.error(message);
+        }
+        process.exit(1);
+    }
+}

package/dist/template/scripts/buildinfo.ts

@@ -1,25 +1,25 @@
-import { spawnSync } from 'node:child_process';
-import { readFileSync, writeFileSync } from 'node:fs';
-
-
-let gitHash = '';
-try {
-    const gitProc = spawnSync('git', ['rev-parse', '--short', 'HEAD']);
-    if (gitProc.status === 0) {
-        gitHash = gitProc.stdout.toString().trim();
-    }
-    else {
-        console.warn(`[scripts/buildinfo.ts] Warning: Failed to get git hash. Prceding without...`);
-    }
-} catch { }
-
-const packageJson: { version: string } = JSON.parse(readFileSync('package.json', 'utf-8'));
-const packageVersion = packageJson.version;
-
-const separator = packageVersion.includes('+') ? '.' : '+';
-const buildinfo = gitHash ? `${packageVersion}${separator}${gitHash}` : packageVersion;
-
-const buildinfoFilePath = 'buildinfo.txt';
-writeFileSync(buildinfoFilePath, buildinfo.trim(), 'utf-8');
-
-console.log(`[scripts/buildinfo.ts] Build info '${buildinfo}' written to '${buildinfoFilePath}'.`);
+import { spawnSync } from 'node:child_process';
+import { readFileSync, writeFileSync } from 'node:fs';
+
+
+let gitHash = '';
+try {
+    const gitProc = spawnSync('git', ['rev-parse', '--short', 'HEAD']);
+    if (gitProc.status === 0) {
+        gitHash = gitProc.stdout.toString().trim();
+    }
+    else {
+        console.warn(`[scripts/buildinfo.ts] Warning: Failed to get git hash. Prceding without...`);
+    }
+} catch { }
+
+const packageJson: { version: string } = JSON.parse(readFileSync('package.json', 'utf-8'));
+const packageVersion = packageJson.version;
+
+const separator = packageVersion.includes('+') ? '.' : '+';
+const buildinfo = gitHash ? `${packageVersion}${separator}${gitHash}` : packageVersion;
+
+const buildinfoFilePath = 'buildinfo.txt';
+writeFileSync(buildinfoFilePath, buildinfo.trim(), 'utf-8');
+
+console.log(`[scripts/buildinfo.ts] Build info '${buildinfo}' written to '${buildinfoFilePath}'.`);

package/dist/template/scripts/import-map.json

@@ -1 +1 @@
-{}
+{}

package/dist/template/src/cli.ts

@@ -1,41 +1,41 @@
-#!/usr/bin/env node
-
-import { cpSync, readFileSync, renameSync, writeFileSync } from 'node:fs';
-import { resolve } from 'node:path';
-import {
-    templateUrl,
-    changelogUrl,
-    buildinfoUrl,
-    readmeUrl
-} from './package-urls.js';
-
-
-try {
-
-    const packageNameArgument = process.argv[2];
-    if (!packageNameArgument)
-        throw new Error('First argument must be the package name (e.g. "my-package" or "@my-scope/my-package").');
-    const packageName = packageNameArgument.replace(/\\/g, '/');
-
-    const destinationPath = resolve(process.cwd(), packageName);
-
-    cpSync(templateUrl, destinationPath, { recursive: true });
-    cpSync(changelogUrl, resolve(destinationPath, 'CHANGELOG-template.md'));
-    cpSync(buildinfoUrl, resolve(destinationPath, 'buildinfo-template.txt'));
-    cpSync(readmeUrl, resolve(destinationPath, 'README-template.md'));
-
-    const packageJsonPath = resolve(destinationPath, 'package.json');
-    const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
-    packageJson.name = packageName;
-    writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
-
-    renameSync(resolve(destinationPath, 'gitignore'), resolve(destinationPath, '.gitignore'));
-
-    console.log(`Template has been successfully instantiated at '${destinationPath}' with package name '${packageName}'.`);
-
-}
-catch (error) {
-    const err = error instanceof Error ? error : new Error(String(error));
-    console.error('Error:', err.message);
-    process.exit(1);
-}
+#!/usr/bin/env node
+
+import { cpSync, readFileSync, renameSync, writeFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import {
+    templateUrl,
+    changelogUrl,
+    buildinfoUrl,
+    readmeUrl
+} from './package-urls.js';
+
+
+try {
+
+    const packageNameArgument = process.argv[2];
+    if (!packageNameArgument)
+        throw new Error('First argument must be the package name (e.g. "my-package" or "@my-scope/my-package").');
+    const packageName = packageNameArgument.replace(/\\/g, '/');
+
+    const destinationPath = resolve(process.cwd(), packageName);
+
+    cpSync(templateUrl, destinationPath, { recursive: true });
+    cpSync(changelogUrl, resolve(destinationPath, 'CHANGELOG-template.md'));
+    cpSync(buildinfoUrl, resolve(destinationPath, 'buildinfo-template.txt'));
+    cpSync(readmeUrl, resolve(destinationPath, 'README-template.md'));
+
+    const packageJsonPath = resolve(destinationPath, 'package.json');
+    const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+    packageJson.name = packageName;
+    writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
+
+    renameSync(resolve(destinationPath, 'gitignore'), resolve(destinationPath, '.gitignore'));
+
+    console.log(`Template has been successfully instantiated at '${destinationPath}' with package name '${packageName}'.`);
+
+}
+catch (error) {
+    const err = error instanceof Error ? error : new Error(String(error));
+    console.error('Error:', err.message);
+    process.exit(1);
+}

package/dist/template/src/package-urls.ts

@@ -1,8 +1,8 @@
-export const packageUrl: URL = new URL('../', import.meta.url);
-
-export const distUrl: URL = new URL('dist/', packageUrl);
-export const buildinfoUrl: URL = new URL('buildinfo.txt', distUrl);
-export const changelogUrl: URL = new URL('CHANGELOG.md', distUrl);
-export const readmeUrl: URL = new URL('README.md', packageUrl);
-
-export const templateUrl: URL = new URL('template/', distUrl);
+export const packageUrl: URL = new URL('../', import.meta.url);
+
+export const distUrl: URL = new URL('dist/', packageUrl);
+export const buildinfoUrl: URL = new URL('buildinfo.txt', distUrl);
+export const changelogUrl: URL = new URL('CHANGELOG.md', distUrl);
+export const readmeUrl: URL = new URL('README.md', packageUrl);
+
+export const templateUrl: URL = new URL('template/', distUrl);

package/dist/template/tests/buildinfo.test.ts

@@ -1,26 +1,26 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
-import { existsSync, readFileSync } from 'node:fs';
-import { buildinfoUrl, packageUrl } from '#src/package-urls.js';
-
-
-// https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
-// Captures: [1]=major, [2]=minor, [3]=patch, [4]=pre-release, [5]=build-metadata
-const SEMVER_REGEX =
-    /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
-
-
-describe('buildinfo.txt', () => {
-
-    it('MUST exist at the specified location', async () => {
-        assert.ok(existsSync(buildinfoUrl));
-        assert.ok(!existsSync(new URL('wrong.txt', packageUrl)));
-    });
-
-    it('MUST contain a valid semver string', async () => {
-        const buildinfo = readFileSync(buildinfoUrl, 'utf-8');
-        assert.match(buildinfo, SEMVER_REGEX);
-        assert.doesNotMatch('version zwölf', SEMVER_REGEX);
-    });
-
-});
+import { describe, it } from 'node:test';
+import assert from 'node:assert';
+import { existsSync, readFileSync } from 'node:fs';
+import { buildinfoUrl, packageUrl } from '#src/package-urls.js';
+
+
+// https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+// Captures: [1]=major, [2]=minor, [3]=patch, [4]=pre-release, [5]=build-metadata
+const SEMVER_REGEX =
+    /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
+
+
+describe('buildinfo.txt', () => {
+
+    it('MUST exist at the specified location', async () => {
+        assert.ok(existsSync(buildinfoUrl));
+        assert.ok(!existsSync(new URL('wrong.txt', packageUrl)));
+    });
+
+    it('MUST contain a valid semver string', async () => {
+        const buildinfo = readFileSync(buildinfoUrl, 'utf-8');
+        assert.match(buildinfo, SEMVER_REGEX);
+        assert.doesNotMatch('version zwölf', SEMVER_REGEX);
+    });
+
+});