genomic 4.0.2 → 5.0.0

package/types.d.ts

@@ -0,0 +1,99 @@
+import { Question } from 'inquirerer';
+/**
+ * Questions configuration that can be loaded from .boilerplate.json or .boilerplate.js
+ * @typedef {Object} Questions
+ * @property {Question[]} questions - Array of genomic questions
+ */
+export interface Questions {
+    questions: Question[];
+}
+/**
+ * Variable extracted from filename patterns like ____variable____
+ */
+export interface FileReplacer {
+    variable: string;
+    pattern: RegExp;
+}
+/**
+ * Variable extracted from file content patterns like ____variable____
+ */
+export interface ContentReplacer {
+    variable: string;
+    pattern: RegExp;
+}
+/**
+ * Options for creating a new project from a template
+ */
+export interface CreateGenOptions {
+    /**
+     * URL or path to the template repository
+     */
+    templateUrl: string;
+    /**
+     * Optional branch or tag to checkout after cloning
+     */
+    fromBranch?: string;
+    /**
+     * Path inside the repository to use as the template root
+     */
+    fromPath?: string;
+    /**
+     * Destination directory for the generated project
+     */
+    outputDir: string;
+    /**
+     * Command-line arguments to pre-populate answers
+     */
+    argv?: Record<string, any>;
+    /**
+     * Whether to use TTY for interactive prompts
+     */
+    noTty?: boolean;
+    /**
+     * Optional caching configuration. Pass `false` to disable caching entirely.
+     */
+    cache?: CacheOptions | false;
+}
+/**
+ * Options that control template caching behavior
+ */
+export interface CacheOptions {
+    /**
+     * Enable or disable caching. Defaults to true.
+     */
+    enabled?: boolean;
+    /**
+     * Tool name used for appstash (affects ~/.<tool> dirs). Defaults to `pgpm`.
+     */
+    toolName?: string;
+    /**
+     * Optional base directory for appstash. Useful for tests to avoid touching the real home dir.
+     */
+    baseDir?: string;
+    /**
+     * Time-to-live in milliseconds. If set, cached templates older than this will be invalidated.
+     * Defaults to undefined (no expiration).
+     */
+    ttl?: number;
+    /**
+     * Alias for ttl. Maximum age in milliseconds for cached templates.
+     * Defaults to undefined (no expiration).
+     */
+    maxAge?: number;
+}
+/**
+ * Result of extracting variables from a template
+ */
+export interface ExtractedVariables {
+    fileReplacers: FileReplacer[];
+    contentReplacers: ContentReplacer[];
+    projectQuestions: Questions | null;
+}
+/**
+ * Context for processing a template
+ */
+export interface TemplateContext {
+    tempDir: string;
+    extractedVariables: ExtractedVariables;
+    answers: Record<string, any>;
+}

package/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/utils/npm-version-check.d.ts

@@ -0,0 +1,17 @@
+import { VersionCheckResult } from './types';
+/**
+ * Check if current package version is outdated compared to npm registry
+ * @param packageName - Package name to check
+ * @param currentVersion - Current version string
+ * @returns Version comparison result
+ */
+export declare function checkNpmVersion(packageName: string, currentVersion: string): Promise<VersionCheckResult>;
+/**
+ * Compare two semver version strings
+ * Returns: -1 if v1 < v2, 0 if equal, 1 if v1 > v2
+ */
+export declare function compareVersions(v1: string, v2: string): number;
+/**
+ * Print version warning to console if outdated
+ */
+export declare function warnIfOutdated(packageName: string, result: VersionCheckResult): void;

package/utils/npm-version-check.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkNpmVersion = checkNpmVersion;
+exports.compareVersions = compareVersions;
+exports.warnIfOutdated = warnIfOutdated;
+const child_process_1 = require("child_process");
+/**
+ * Check if current package version is outdated compared to npm registry
+ * @param packageName - Package name to check
+ * @param currentVersion - Current version string
+ * @returns Version comparison result
+ */
+async function checkNpmVersion(packageName, currentVersion) {
+    try {
+        const latestVersion = (0, child_process_1.execSync)(`npm view ${packageName} version`, { encoding: 'utf8', stdio: ['pipe', 'pipe', 'ignore'] }).trim();
+        const isOutdated = compareVersions(currentVersion, latestVersion) < 0;
+        return {
+            currentVersion,
+            latestVersion,
+            isOutdated,
+        };
+    }
+    catch (error) {
+        return {
+            currentVersion,
+            latestVersion: null,
+            isOutdated: false,
+            error: error instanceof Error ? error.message : String(error),
+        };
+    }
+}
+/**
+ * Compare two semver version strings
+ * Returns: -1 if v1 < v2, 0 if equal, 1 if v1 > v2
+ */
+function compareVersions(v1, v2) {
+    const parts1 = v1.split('.').map(Number);
+    const parts2 = v2.split('.').map(Number);
+    for (let i = 0; i < Math.max(parts1.length, parts2.length); i++) {
+        const p1 = parts1[i] || 0;
+        const p2 = parts2[i] || 0;
+        if (p1 < p2)
+            return -1;
+        if (p1 > p2)
+            return 1;
+    }
+    return 0;
+}
+/**
+ * Print version warning to console if outdated
+ */
+function warnIfOutdated(packageName, result) {
+    if (result.isOutdated && result.latestVersion) {
+        console.warn(`\n⚠️  New version available: ${result.currentVersion} → ${result.latestVersion}`);
+        console.warn(`   Run: npm install -g ${packageName}@latest\n`);
+    }
+}

package/utils/types.d.ts

@@ -0,0 +1,6 @@
+export interface VersionCheckResult {
+    currentVersion: string;
+    latestVersion: string | null;
+    isOutdated: boolean;
+    error?: string;
+}

package/utils/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/commander.d.ts

@@ -1,21 +0,0 @@
-import { Opts, ParsedArgs } from 'minimist';
-import { Readable, Writable } from 'stream';
-import { Prompter } from './prompt';
-export type CommandHandler = (argv: ParsedArgs, prompter: Prompter, options: CLIOptions) => void;
-export interface CLIOptions {
-    noTty: boolean;
-    input: Readable;
-    output: Writable;
-    minimistOpts: Opts;
-    version: string;
-}
-export declare const defaultCLIOptions: CLIOptions;
-export declare class CLI {
-    private argv;
-    private prompter;
-    private commandHandler;
-    private options;
-    constructor(commandHandler: CommandHandler, options: Partial<CLIOptions>, argv?: any);
-    run(): Promise<void>;
-}
-export default CLI;

package/commander.js

@@ -1,57 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLI = exports.defaultCLIOptions = void 0;
-const deepmerge_1 = __importDefault(require("deepmerge"));
-const minimist_1 = __importDefault(require("minimist"));
-const prompt_1 = require("./prompt");
-const utils_1 = require("./utils");
-exports.defaultCLIOptions = {
-    version: `genomic@${(0, utils_1.getVersion)()}`,
-    noTty: false,
-    input: process.stdin,
-    output: process.stdout,
-    minimistOpts: {
-        alias: {
-            v: 'version'
-        }
-    }
-};
-class CLI {
-    argv;
-    prompter;
-    commandHandler;
-    options;
-    constructor(commandHandler, options, argv) {
-        const { input, output, ...optionsWithoutIO } = options;
-        const { input: defaultInput, output: defaultOutput, ...defaultOptionsWithoutIO } = exports.defaultCLIOptions;
-        const mergedOptions = (0, deepmerge_1.default)(defaultOptionsWithoutIO, optionsWithoutIO);
-        mergedOptions.input = input || defaultInput;
-        mergedOptions.output = output || defaultOutput;
-        this.options = mergedOptions;
-        this.argv = argv ? argv : (0, minimist_1.default)(process.argv.slice(2), this.options.minimistOpts);
-        this.prompter = new prompt_1.Prompter({
-            noTty: this.options.noTty,
-            input: this.options.input,
-            output: this.options.output
-        });
-        this.commandHandler = commandHandler;
-    }
-    async run() {
-        if (!('tty' in this.argv)) {
-            this.argv.tty = true;
-        }
-        if (this.argv.version) {
-            console.log(this.options.version);
-            process.exit(0);
-        }
-        const args = await this.commandHandler(this.argv, this.prompter, this.options);
-        // this.prompter.exit();
-        this.prompter.close();
-        return args;
-    }
-}
-exports.CLI = CLI;
-exports.default = CLI;

package/esm/commander.js

@@ -1,50 +0,0 @@
-import deepmerge from 'deepmerge';
-import minimist from 'minimist';
-import { Prompter } from './prompt';
-import { getVersion } from './utils';
-export const defaultCLIOptions = {
-    version: `genomic@${getVersion()}`,
-    noTty: false,
-    input: process.stdin,
-    output: process.stdout,
-    minimistOpts: {
-        alias: {
-            v: 'version'
-        }
-    }
-};
-export class CLI {
-    argv;
-    prompter;
-    commandHandler;
-    options;
-    constructor(commandHandler, options, argv) {
-        const { input, output, ...optionsWithoutIO } = options;
-        const { input: defaultInput, output: defaultOutput, ...defaultOptionsWithoutIO } = defaultCLIOptions;
-        const mergedOptions = deepmerge(defaultOptionsWithoutIO, optionsWithoutIO);
-        mergedOptions.input = input || defaultInput;
-        mergedOptions.output = output || defaultOutput;
-        this.options = mergedOptions;
-        this.argv = argv ? argv : minimist(process.argv.slice(2), this.options.minimistOpts);
-        this.prompter = new Prompter({
-            noTty: this.options.noTty,
-            input: this.options.input,
-            output: this.options.output
-        });
-        this.commandHandler = commandHandler;
-    }
-    async run() {
-        if (!('tty' in this.argv)) {
-            this.argv.tty = true;
-        }
-        if (this.argv.version) {
-            console.log(this.options.version);
-            process.exit(0);
-        }
-        const args = await this.commandHandler(this.argv, this.prompter, this.options);
-        // this.prompter.exit();
-        this.prompter.close();
-        return args;
-    }
-}
-export default CLI;

package/esm/keypress.js

@@ -1,95 +0,0 @@
-const defaultProcessWrapper = {
-    exit: (code) => process.exit(code)
-};
-export const KEY_CODES = {
-    UP_ARROW: '\u001b[A',
-    DOWN_ARROW: '\u001b[B',
-    RIGHT_ARROW: '\u001b[C',
-    LEFT_ARROW: '\u001b[D',
-    ENTER: '\r',
-    SPACE: ' ',
-    CTRL_C: '\u0003',
-    BACKSPACE: '\x7f', // Commonly used BACKSPACE key in Unix-like systems
-    BACKSPACE_LEGACY: '\x08' // For compatibility with some systems
-};
-/**
- * Handles keyboard input for interactive prompts.
- *
- * **Important**: Only one TerminalKeypress instance should be actively listening
- * on a given input stream at a time. If you need multiple Prompter instances,
- * call `close()` on the first instance before using the second, or reuse a single
- * instance for all prompts.
- *
- * Multiple instances sharing the same input stream (e.g., process.stdin) will
- * each receive all keypresses, which can cause duplicate or unexpected behavior.
- */
-export class TerminalKeypress {
-    listeners = {};
-    active = true;
-    noTty;
-    input;
-    proc;
-    dataHandler = null;
-    constructor(noTty = false, input = process.stdin, proc = defaultProcessWrapper) {
-        this.noTty = noTty;
-        this.input = input;
-        this.proc = proc;
-        if (this.isTTY()) {
-            this.input.resume();
-            this.input.setEncoding('utf8');
-        }
-        this.setupListeners();
-    }
-    isTTY() {
-        return !this.noTty;
-    }
-    setupListeners() {
-        this.dataHandler = (key) => {
-            if (!this.active)
-                return;
-            const handlers = this.listeners[key];
-            handlers?.forEach(handler => handler());
-            if (key === KEY_CODES.CTRL_C) {
-                this.proc.exit(0);
-            }
-        };
-        this.input.on('data', this.dataHandler);
-    }
-    on(key, callback) {
-        if (!this.listeners[key]) {
-            this.listeners[key] = [];
-        }
-        this.listeners[key].push(callback);
-    }
-    off(key, callback) {
-        if (this.listeners[key]) {
-            const index = this.listeners[key].indexOf(callback);
-            if (index !== -1) {
-                this.listeners[key].splice(index, 1);
-            }
-        }
-    }
-    clearHandlers() {
-        this.listeners = {};
-    }
-    pause() {
-        this.active = false;
-        this.clearHandlers();
-    }
-    resume() {
-        this.active = true;
-        if (this.isTTY() && typeof this.input.setRawMode === 'function') {
-            this.input.setRawMode(true);
-        }
-    }
-    destroy() {
-        if (typeof this.input.setRawMode === 'function') {
-            this.input.setRawMode(false);
-        }
-        this.input.pause();
-        if (this.dataHandler) {
-            this.input.removeListener('data', this.dataHandler);
-            this.dataHandler = null;
-        }
-    }
-}