genomic 4.0.1 → 5.0.0

package/licenses-templates/UNLICENSE.txt

@@ -0,0 +1,22 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+

package/licenses.d.ts

@@ -0,0 +1,18 @@
+interface LicenseContext {
+    year: string;
+    author: string;
+    email: string;
+}
+export type SupportedLicense = string;
+export declare const DEFAULT_LICENSE = "MIT";
+export declare const CLOSED_LICENSE = "CLOSED";
+export declare const LICENSE_VALUE_KEYS: string[];
+export declare const LICENSE_AUTHOR_KEYS: string[];
+export declare const LICENSE_EMAIL_KEYS: string[];
+export declare function isSupportedLicense(name: string): name is SupportedLicense;
+export declare function renderLicense(licenseName: string, context: Partial<LicenseContext>): string | null;
+export declare function listSupportedLicenses(): string[];
+export declare function findLicenseValue(answers: Record<string, any>): string | undefined;
+export declare function findLicenseAuthor(answers: Record<string, any>): string | undefined;
+export declare function findLicenseEmail(answers: Record<string, any>): string | undefined;
+export {};

package/licenses.js

@@ -0,0 +1,162 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LICENSE_EMAIL_KEYS = exports.LICENSE_AUTHOR_KEYS = exports.LICENSE_VALUE_KEYS = exports.CLOSED_LICENSE = exports.DEFAULT_LICENSE = void 0;
+exports.isSupportedLicense = isSupportedLicense;
+exports.renderLicense = renderLicense;
+exports.listSupportedLicenses = listSupportedLicenses;
+exports.findLicenseValue = findLicenseValue;
+exports.findLicenseAuthor = findLicenseAuthor;
+exports.findLicenseEmail = findLicenseEmail;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const PLACEHOLDER_PATTERN = /{{(\w+)}}/g;
+let cachedTemplates = null;
+exports.DEFAULT_LICENSE = 'MIT';
+exports.CLOSED_LICENSE = 'CLOSED';
+exports.LICENSE_VALUE_KEYS = ['LICENSE', 'license'];
+exports.LICENSE_AUTHOR_KEYS = [
+    'USERFULLNAME',
+    'AUTHOR',
+    'AUTHORFULLNAME',
+    'USERNAME',
+    'fullName',
+    'author',
+    'authorFullName',
+    'userName',
+];
+exports.LICENSE_EMAIL_KEYS = ['USEREMAIL', 'EMAIL', 'email', 'userEmail'];
+function isSupportedLicense(name) {
+    if (!name) {
+        return false;
+    }
+    return Boolean(loadLicenseTemplates()[name.toUpperCase()]);
+}
+function renderLicense(licenseName, context) {
+    if (!licenseName) {
+        return null;
+    }
+    const templates = loadLicenseTemplates();
+    const template = templates[licenseName.toUpperCase()];
+    if (!template) {
+        return null;
+    }
+    const ctx = {
+        year: context.year ?? new Date().getFullYear().toString(),
+        author: context.author ?? 'Unknown Author',
+        email: context.email ?? '',
+    };
+    const emailLine = ctx.email ? ` <${ctx.email}>` : '';
+    return template.replace(PLACEHOLDER_PATTERN, (_, rawKey) => {
+        const key = rawKey.toUpperCase();
+        if (key === 'EMAIL_LINE') {
+            return emailLine;
+        }
+        const normalizedKey = key.toLowerCase();
+        const value = ctx[normalizedKey];
+        return value || '';
+    });
+}
+function listSupportedLicenses() {
+    const licenses = Object.keys(loadLicenseTemplates());
+    // Sort with DEFAULT_LICENSE first, CLOSED_LICENSE last, then alphabetically
+    return licenses.sort((a, b) => {
+        if (a === exports.DEFAULT_LICENSE)
+            return -1;
+        if (b === exports.DEFAULT_LICENSE)
+            return 1;
+        if (a === exports.CLOSED_LICENSE)
+            return 1;
+        if (b === exports.CLOSED_LICENSE)
+            return -1;
+        return a.localeCompare(b);
+    });
+}
+function findLicenseValue(answers) {
+    return getAnswerValue(answers, exports.LICENSE_VALUE_KEYS);
+}
+function findLicenseAuthor(answers) {
+    return getAnswerValue(answers, exports.LICENSE_AUTHOR_KEYS);
+}
+function findLicenseEmail(answers) {
+    return getAnswerValue(answers, exports.LICENSE_EMAIL_KEYS);
+}
+function loadLicenseTemplates() {
+    if (cachedTemplates) {
+        return cachedTemplates;
+    }
+    const dir = findTemplatesDir();
+    if (!dir) {
+        cachedTemplates = {};
+        return cachedTemplates;
+    }
+    const files = fs.readdirSync(dir);
+    const templates = {};
+    for (const file of files) {
+        const fullPath = path.join(dir, file);
+        const stats = fs.statSync(fullPath);
+        if (!stats.isFile()) {
+            continue;
+        }
+        if (path.extname(file).toLowerCase() !== '.txt') {
+            continue;
+        }
+        const key = path.basename(file, path.extname(file)).toUpperCase();
+        templates[key] = fs.readFileSync(fullPath, 'utf8');
+    }
+    cachedTemplates = templates;
+    return cachedTemplates;
+}
+function findTemplatesDir() {
+    const candidates = [
+        path.resolve(__dirname, '..', 'licenses-templates'),
+        path.resolve(__dirname, 'licenses-templates'),
+    ];
+    for (const candidate of candidates) {
+        if (fs.existsSync(candidate)) {
+            return candidate;
+        }
+    }
+    return null;
+}
+function getAnswerValue(answers, keys) {
+    for (const key of keys) {
+        const value = answers?.[key];
+        if (typeof value === 'string' && value.trim() !== '') {
+            return value;
+        }
+    }
+    return undefined;
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "genomic",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "author": "Constructive <developers@constructive.io>",
-  "description": "TypeScript-first library for building beautiful CLI interfaces with interactive prompts",
+  "description": "Clone and customize template repositories with variable replacement",
   "main": "index.js",
   "module": "esm/index.js",
   "types": "index.d.ts",
@@ -20,26 +20,21 @@
     "url": "https://github.com/constructive-io/dev-utils/issues"
   },
   "scripts": {
-    "copy": "makage assets",
+    "copy": "copyfiles -f ../../LICENSE README.md package.json dist && copyfiles -f \"licenses-templates/**/*\" dist/licenses-templates",
     "clean": "makage clean",
     "prepublishOnly": "npm run build",
-    "build": "makage build",
-    "dev": "ts-node dev/index",
+    "build": "npm run clean && tsc && tsc -p tsconfig.esm.json && npm run copy",
     "test": "jest",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "deepmerge": "^4.3.1",
-    "find-and-require-package-json": "0.8.3",
-    "js-yaml": "^4.1.0",
-    "minimist": "^1.2.8",
-    "yanse": "0.1.9"
+    "appstash": "0.2.6",
+    "inquirerer": "4.0.0"
   },
-  "keywords": [],
   "devDependencies": {
-    "@types/minimist": "^1.2.5",
-    "clean-ansi": "0.1.6",
+    "copyfiles": "^2.4.1",
     "makage": "0.1.8"
   },
-  "gitHead": "a3cc79dcdfee205c15394fcd485212a25e383d2d"
+  "keywords": [],
+  "gitHead": "ab5945f162906da8fdf6776510ba30d82769b47f"
 }

package/scaffolder/index.d.ts

@@ -0,0 +1,2 @@
+export * from './template-scaffolder';
+export * from './types';

package/{question → scaffolder}/index.js

@@ -14,4 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./template-scaffolder"), exports);
 __exportStar(require("./types"), exports);

package/scaffolder/template-scaffolder.d.ts

@@ -0,0 +1,91 @@
+import { CacheManager } from '../cache/cache-manager';
+import { GitCloner } from '../git/git-cloner';
+import { Templatizer } from '../template/templatizer';
+import { TemplateScaffolderConfig, ScaffoldOptions, ScaffoldResult, BoilerplatesConfig, BoilerplateConfig, InspectOptions, InspectResult } from './types';
+/**
+ * High-level orchestrator for template scaffolding operations.
+ * Combines CacheManager, GitCloner, and Templatizer into a single, easy-to-use API.
+ *
+ * @example
+ * ```typescript
+ * const scaffolder = new TemplateScaffolder({
+ *   toolName: 'my-cli',
+ *   defaultRepo: 'https://github.com/org/templates.git',
+ *   ttlMs: 7 * 24 * 60 * 60 * 1000, // 1 week
+ * });
+ *
+ * await scaffolder.scaffold({
+ *   outputDir: './my-project',
+ *   fromPath: 'starter',
+ *   answers: { name: 'my-project' },
+ * });
+ * ```
+ */
+export declare class TemplateScaffolder {
+    private config;
+    private cacheManager;
+    private gitCloner;
+    private templatizer;
+    constructor(config: TemplateScaffolderConfig);
+    /**
+     * Scaffold a new project from a template.
+     *
+     * Handles both local directories and remote git repositories.
+     * For remote repos, caching is used to avoid repeated cloning.
+     *
+     * @param options - Scaffold options
+     * @returns Scaffold result with output path and metadata
+     */
+    scaffold(options: ScaffoldOptions): Promise<ScaffoldResult>;
+    /**
+     * Inspect a template without scaffolding.
+     * Clones/caches the template and reads its .boilerplate.json configuration
+     * without copying any files to an output directory.
+     *
+     * This is useful for metadata-driven workflows where you need to know
+     * the template's type or other configuration before deciding how to handle it.
+     *
+     * @param options - Inspect options
+     * @returns Inspect result with template metadata
+     */
+    inspect(options: InspectOptions): InspectResult;
+    /**
+     * Read the .boilerplates.json configuration from a template repository root.
+     */
+    readBoilerplatesConfig(templateDir: string): BoilerplatesConfig | null;
+    /**
+     * Read the .boilerplate.json configuration from a boilerplate directory.
+     */
+    readBoilerplateConfig(boilerplatePath: string): BoilerplateConfig | null;
+    /**
+     * Get the underlying CacheManager instance for advanced cache operations.
+     */
+    getCacheManager(): CacheManager;
+    /**
+     * Get the underlying GitCloner instance for advanced git operations.
+     */
+    getGitCloner(): GitCloner;
+    /**
+     * Get the underlying Templatizer instance for advanced template operations.
+     */
+    getTemplatizer(): Templatizer;
+    private inspectLocal;
+    private inspectRemote;
+    private scaffoldFromLocal;
+    private scaffoldFromRemote;
+    /**
+     * Resolve the fromPath using .boilerplates.json convention.
+     *
+     * Resolution order:
+     * 1. If explicit fromPath is provided and exists, use it directly
+     * 2. If useBoilerplatesConfig is true and .boilerplates.json exists with a dir field, prepend it to fromPath
+     * 3. Return the fromPath as-is
+     *
+     * @param templateDir - The template repository root directory
+     * @param fromPath - The subdirectory path to resolve
+     * @param useBoilerplatesConfig - Whether to use .boilerplates.json for fallback resolution (default: true)
+     */
+    private resolveFromPath;
+    private isLocalPath;
+    private resolveTemplatePath;
+}