@constructive-io/cli 0.0.2 → 5.1.0

package/esm/commands/tag.js

@@ -1,133 +0,0 @@
-import { LaunchQLPackage } from '@launchql/core';
-import { Logger } from '@launchql/logger';
-import { errors } from '@launchql/types';
-import * as path from 'path';
-import { extractFirst } from '../utils/argv';
-import { selectPackage } from '../utils/module-utils';
-const log = new Logger('tag');
-const tagUsageText = `
-Tag Command:
-
-  constructive tag [tag_name] [OPTIONS]
-
-  Add tags to changes for versioning.
-
-Arguments:
-  tag_name                Name of the tag to create
-
-Options:
-  --help, -h              Show this help message
-  --package <name>        Target specific package
-  --changeName <name>     Target specific change (default: latest)
-  --comment <text>        Optional tag comment
-  --cwd <directory>       Working directory (default: current directory)
-
-Examples:
-  constructive tag v1.0.0                                    Add tag to latest change
-  constructive tag v1.0.0 --comment "Initial release"       Add tag with comment
-  constructive tag v1.1.0 --package mypackage --changeName my-change  Tag specific change in package
-`;
-export default async (argv, prompter, _options) => {
-    // Show usage if explicitly requested
-    if (argv.help || argv.h) {
-        console.log(tagUsageText);
-        process.exit(0);
-    }
-    const { first: tagName, newArgv } = extractFirst(argv);
-    const cwdResult = await prompter.prompt(newArgv, [
-        {
-            type: 'text',
-            name: 'cwd',
-            message: 'Working directory',
-            required: false,
-            default: process.cwd(),
-            useDefault: true
-        }
-    ]);
-    const cwd = cwdResult.cwd || process.cwd();
-    const pkg = new LaunchQLPackage(cwd);
-    let packageName;
-    if (argv.package) {
-        packageName = argv.package;
-        log.info(`Using specified package: ${packageName}`);
-    }
-    else if (pkg.isInModule()) {
-        packageName = pkg.getModuleName();
-        log.info(`Using current module: ${packageName}`);
-    }
-    else if (pkg.isInWorkspace()) {
-        packageName = await selectPackage(newArgv, prompter, cwd, 'add tag to', log);
-        if (!packageName) {
-            throw new Error('No package selected. Cannot add tag without specifying a target package.');
-        }
-    }
-    else {
-        throw new Error('This command must be run inside a LaunchQL workspace or module.');
-    }
-    const questions = [];
-    if (!tagName) {
-        questions.push({
-            type: 'text',
-            name: 'tagName',
-            message: 'Tag name',
-            required: true,
-            validate: (value) => {
-                if (!value || value.trim().length === 0) {
-                    return false;
-                }
-                if (value.includes('/')) {
-                    return false;
-                }
-                if (value.includes('@')) {
-                    return false;
-                }
-                return true;
-            }
-        });
-    }
-    questions.push({
-        type: 'text',
-        name: 'changeName',
-        message: 'Target change name (leave empty for latest change)',
-        required: false
-    }, {
-        type: 'text',
-        name: 'comment',
-        message: 'Tag comment (optional)',
-        required: false
-    });
-    const answers = await prompter.prompt(newArgv, questions);
-    const finalTagName = tagName || answers.tagName;
-    const changeName = answers.changeName;
-    const comment = answers.comment;
-    try {
-        if (argv.package || !pkg.isInModule()) {
-            const moduleMap = pkg.getModuleMap();
-            const module = moduleMap[packageName];
-            if (!module) {
-                throw errors.MODULE_NOT_FOUND({ name: packageName });
-            }
-            const workspacePath = pkg.getWorkspacePath();
-            const absoluteModulePath = path.resolve(workspacePath, module.path);
-            const originalCwd = process.cwd();
-            process.chdir(absoluteModulePath);
-            try {
-                const modulePkg = new LaunchQLPackage(absoluteModulePath);
-                modulePkg.addTag(finalTagName.trim(), changeName?.trim() || undefined, comment?.trim() || undefined);
-                log.info(`Successfully added tag '${finalTagName}' to ${changeName || 'latest change'} in package '${packageName}'`);
-            }
-            finally {
-                process.chdir(originalCwd);
-            }
-        }
-        else {
-            pkg.addTag(finalTagName.trim(), changeName?.trim() || undefined, comment?.trim() || undefined);
-            log.info(`Successfully added tag '${finalTagName}' to ${changeName || 'latest change'}`);
-        }
-    }
-    catch (error) {
-        log.error(`Failed to add tag: ${error instanceof Error ? error.message : String(error)}`);
-        throw error;
-    }
-    return newArgv;
-};

package/esm/commands/verify.js

@@ -1,83 +0,0 @@
-import { LaunchQLPackage } from '@launchql/core';
-import { getEnvOptions } from '@launchql/env';
-import { Logger } from '@launchql/logger';
-import { getPgEnvOptions } from 'pg-env';
-import { getTargetDatabase } from '../utils';
-import { cliExitWithError } from '../utils/cli-error';
-import { selectDeployedChange, selectDeployedPackage } from '../utils/deployed-changes';
-const log = new Logger('verify');
-const verifyUsageText = `
-Verify Command:
-
-  constructive verify [OPTIONS]
-
-  Verify database state matches expected migrations.
-
-Options:
-  --help, -h         Show this help message
-  --recursive        Verify recursively through dependencies
-  --package <name>   Verify specific package
-  --to <target>      Verify up to specific change or tag
-  --to               Interactive selection of deployed changes
-  --cwd <directory>  Working directory (default: current directory)
-
-Examples:
-  constructive verify                    Verify current database state
-  constructive verify --package mypackage  Verify specific package
-  constructive verify --to              Interactive selection from deployed changes
-`;
-export default async (argv, prompter, _options) => {
-    // Show usage if explicitly requested
-    if (argv.help || argv.h) {
-        console.log(verifyUsageText);
-        process.exit(0);
-    }
-    const database = await getTargetDatabase(argv, prompter, {
-        message: 'Select database'
-    });
-    const questions = [
-        {
-            name: 'recursive',
-            type: 'confirm',
-            message: 'Deploy recursively through dependencies?',
-            useDefault: true,
-            default: true,
-            required: false
-        },
-    ];
-    let { recursive, cwd } = await prompter.prompt(argv, questions);
-    log.debug(`Using current directory: ${cwd}`);
-    let packageName;
-    if (recursive && argv.to !== true) {
-        packageName = await selectDeployedPackage(database, argv, prompter, log, 'verify');
-        if (!packageName) {
-            await cliExitWithError('No package found to verify');
-        }
-    }
-    const project = new LaunchQLPackage(cwd);
-    const opts = getEnvOptions({
-        pg: getPgEnvOptions({ database })
-    });
-    let target;
-    if (argv.to === true) {
-        target = await selectDeployedChange(database, argv, prompter, log, 'verify');
-        if (!target) {
-            await cliExitWithError('No target selected, operation cancelled');
-        }
-    }
-    else if (packageName && argv.to) {
-        target = `${packageName}:${argv.to}`;
-    }
-    else if (packageName) {
-        target = packageName;
-    }
-    else if (argv.package && argv.to) {
-        target = `${argv.package}:${argv.to}`;
-    }
-    else if (argv.package) {
-        target = argv.package;
-    }
-    await project.verify(opts, target, recursive);
-    log.success('Verify complete.');
-    return argv;
-};

package/esm/package.js

@@ -1,26 +0,0 @@
-import { existsSync, readFileSync } from 'fs';
-import { dirname, join } from 'path';
-// need to search due to the dist/ folder and src/, etc.
-function findPackageJson(currentDir) {
-    const filePath = join(currentDir, 'package.json');
-    // Check if package.json exists in the current directory
-    if (existsSync(filePath)) {
-        return filePath;
-    }
-    // Get the parent directory
-    const parentDir = dirname(currentDir);
-    // If reached the root directory, package.json is not found
-    if (parentDir === currentDir) {
-        throw new Error('package.json not found in any parent directory');
-    }
-    // Recursively look in the parent directory
-    return findPackageJson(parentDir);
-}
-export function readAndParsePackageJson() {
-    // Start searching from the current directory
-    const pkgPath = findPackageJson(__dirname);
-    // Read and parse the package.json
-    const str = readFileSync(pkgPath, 'utf8');
-    const pkg = JSON.parse(str);
-    return pkg;
-}

package/esm/utils/argv.js

@@ -1,92 +0,0 @@
-import { Logger } from '@launchql/logger';
-const log = new Logger('argv-utils');
-export const extractFirst = (argv) => {
-    const first = argv._?.[0];
-    const newArgv = {
-        ...argv,
-        _: argv._?.slice(1) ?? []
-    };
-    return { first, newArgv };
-};
-/**
- * Validates and normalizes common CLI arguments
- */
-export function validateCommonArgs(argv) {
-    const validated = {
-        ...argv,
-        cwd: argv.cwd || process.cwd(),
-        _: argv._ || []
-    };
-    const booleanFlags = ['recursive', 'yes', 'tx', 'fast', 'logOnly', 'createdb', 'usePlan', 'cache', 'drop', 'all', 'summary', 'help', 'h'];
-    for (const flag of booleanFlags) {
-        if (argv[flag] !== undefined && typeof argv[flag] !== 'boolean') {
-            log.warn(`--${flag} flag should be boolean, converting to true`);
-            validated[flag] = true;
-        }
-    }
-    const stringFlags = ['package', 'to', 'database'];
-    for (const flag of stringFlags) {
-        if (argv[flag] !== undefined && typeof argv[flag] !== 'string') {
-            log.warn(`--${flag} should be a string, converting`);
-            validated[flag] = String(argv[flag]);
-        }
-    }
-    return validated;
-}
-/**
- * Checks if required flags are provided when certain conditions are met
- */
-export function validateFlagDependencies(argv) {
-    if (argv.to && !argv.package && !argv.recursive) {
-        log.warn('--to flag provided without --package or --recursive. Target may not work as expected.');
-    }
-    if (argv.package && argv.recursive) {
-        if (argv.package.includes(':')) {
-            log.warn('--package should not contain ":" when using --recursive. Use --to for target specification.');
-        }
-    }
-}
-/**
- * Logs the effective CLI arguments for debugging
- */
-export function logEffectiveArgs(argv, commandName) {
-    const relevantArgs = {
-        cwd: argv.cwd,
-        database: argv.database,
-        package: argv.package,
-        to: argv.to,
-        recursive: argv.recursive,
-        yes: argv.yes,
-        tx: argv.tx,
-        fast: argv.fast,
-        logOnly: argv.logOnly,
-        createdb: argv.createdb,
-        usePlan: argv.usePlan,
-        cache: argv.cache,
-        drop: argv.drop,
-        all: argv.all,
-        summary: argv.summary
-    };
-    const definedArgs = Object.fromEntries(Object.entries(relevantArgs).filter(([_, value]) => value !== undefined));
-    if (Object.keys(definedArgs).length > 1) { // More than just cwd
-        log.debug(`${commandName} effective arguments:`, definedArgs);
-    }
-}
-/**
- * Constructs a deployment target string from package and to arguments
- */
-export function constructTarget(argv, packageName) {
-    if (packageName && argv.to) {
-        return `${packageName}:${argv.to}`;
-    }
-    else if (packageName) {
-        return packageName;
-    }
-    else if (argv.package && argv.to) {
-        return `${argv.package}:${argv.to}`;
-    }
-    else if (argv.package) {
-        return argv.package;
-    }
-    return undefined;
-}

package/esm/utils/cli-error.js

@@ -1,48 +0,0 @@
-import { Logger } from '@launchql/logger';
-import { LaunchQLError } from '@launchql/types';
-import { teardownPgPools } from 'pg-cache';
-const log = new Logger('cli');
-/**
- * CLI error utility that logs error information and exits with code 1.
- * Provides consistent error handling and user experience across all CLI commands.
- *
- * IMPORTANT: This function properly cleans up PostgreSQL connections before exiting.
- */
-export const cliExitWithError = async (error, context) => {
-    if (error instanceof LaunchQLError) {
-        // For LaunchQLError instances, use structured logging
-        log.error(`Error: ${error.message}`);
-        // Log additional context if available
-        if (error.context && Object.keys(error.context).length > 0) {
-            log.debug('Error context:', error.context);
-        }
-        // Log any additional context provided
-        if (context) {
-            log.debug('Additional context:', context);
-        }
-    }
-    else if (error instanceof Error) {
-        // For generic Error instances
-        log.error(`Error: ${error.message}`);
-        if (context) {
-            log.debug('Context:', context);
-        }
-    }
-    else if (typeof error === 'string') {
-        // For simple string messages
-        log.error(`Error: ${error}`);
-        if (context) {
-            log.debug('Context:', context);
-        }
-    }
-    // Perform cleanup before exiting
-    try {
-        await teardownPgPools();
-        log.debug('Database connections cleaned up');
-    }
-    catch (cleanupError) {
-        log.warn('Failed to cleanup database connections:', cleanupError);
-        // Don't let cleanup errors prevent the exit
-    }
-    process.exit(1);
-};

package/esm/utils/database.js

@@ -1,78 +0,0 @@
-import { getPgPool } from 'pg-cache';
-import { getPgEnvOptions } from 'pg-env';
-/**
- * Get list of available databases from PostgreSQL
- */
-export async function getAvailableDatabases(options = {}) {
-    const { excludeTemplates = true, excludePostgres = true, excludeSystemDbs = true } = options;
-    const db = await getPgPool({
-        database: 'postgres'
-    });
-    let query = `
-    SELECT datname FROM pg_catalog.pg_database
-    WHERE 1=1
-  `;
-    if (excludeTemplates) {
-        query += ` AND datistemplate = FALSE`;
-    }
-    if (excludePostgres) {
-        query += ` AND datname NOT IN ('postgres')`;
-    }
-    if (excludeSystemDbs) {
-        query += ` AND datname !~ '^pg_'`;
-    }
-    query += ` ORDER BY datname`;
-    const result = await db.query(query);
-    return result.rows.map((row) => row.datname);
-}
-/**
- * Prompt user to select a database
- */
-export async function selectDatabase(argv, prompter, options = {}) {
-    const { message = 'Select target database', multiple = false } = options;
-    // Check if database is already specified
-    if (!multiple && (argv.db || argv.database)) {
-        return argv.db || argv.database;
-    }
-    // Get available databases
-    const databases = await getAvailableDatabases(options);
-    if (databases.length === 0) {
-        throw new Error('No databases found');
-    }
-    // If only one database and not forcing selection, use it
-    if (!multiple && databases.length === 1 && !argv.interactive) {
-        return databases[0];
-    }
-    // Prompt for selection
-    const answer = await prompter.prompt(argv, [
-        {
-            type: multiple ? 'checkbox' : 'autocomplete',
-            name: 'database',
-            message,
-            options: databases,
-            required: true
-        }
-    ]);
-    return answer.database;
-}
-/**
- * Get target database with fallback to environment
- */
-export async function getTargetDatabase(argv, prompter, options = {}) {
-    // If database is specified in args, use it
-    if (argv.db || argv.database) {
-        return argv.db || argv.database;
-    }
-    // Try to select from available databases
-    try {
-        return await selectDatabase(argv, prompter, options);
-    }
-    catch (error) {
-        // Fall back to environment database
-        const pgEnv = getPgEnvOptions();
-        if (pgEnv.database) {
-            return pgEnv.database;
-        }
-        throw new Error('No database specified and no default database found');
-    }
-}

package/esm/utils/deployed-changes.js

@@ -1,68 +0,0 @@
-import { LaunchQLMigrate } from '@launchql/core';
-import { getPgEnvOptions } from 'pg-env';
-export async function selectDeployedChange(database, argv, prompter, log, action = 'revert') {
-    const pgEnv = getPgEnvOptions({ database });
-    const client = new LaunchQLMigrate(pgEnv);
-    let selectedPackage;
-    if (argv.package) {
-        selectedPackage = argv.package;
-    }
-    else {
-        const packageStatuses = await client.status();
-        if (packageStatuses.length === 0) {
-            log.warn('No deployed packages found in database');
-            return undefined;
-        }
-        const packageAnswer = await prompter.prompt(argv, [{
-                type: 'autocomplete',
-                name: 'package',
-                message: `Select package to ${action} from:`,
-                options: packageStatuses.map(status => ({
-                    name: status.package,
-                    value: status.package,
-                    description: `${status.totalDeployed} changes, last: ${status.lastChange}`
-                }))
-            }]);
-        selectedPackage = packageAnswer.package;
-    }
-    const deployedChanges = await client.getDeployedChanges(database, selectedPackage);
-    if (deployedChanges.length === 0) {
-        log.warn(`No deployed changes found for package ${selectedPackage}`);
-        return undefined;
-    }
-    const changeAnswer = await prompter.prompt(argv, [{
-            type: 'autocomplete',
-            name: 'change',
-            message: `Select change to ${action} to in ${selectedPackage}:`,
-            options: deployedChanges.map(change => ({
-                name: change.change_name,
-                value: change.change_name,
-                description: `Deployed: ${new Date(change.deployed_at).toLocaleString()}`
-            }))
-        }]);
-    const selectedChange = changeAnswer.change;
-    return `${selectedPackage}:${selectedChange}`;
-}
-export async function selectDeployedPackage(database, argv, prompter, log, action = 'revert') {
-    if (argv.package) {
-        return argv.package;
-    }
-    const pgEnv = getPgEnvOptions({ database });
-    const client = new LaunchQLMigrate(pgEnv);
-    const packageStatuses = await client.status();
-    if (packageStatuses.length === 0) {
-        log.warn('No deployed packages found in database');
-        return undefined;
-    }
-    const packageAnswer = await prompter.prompt(argv, [{
-            type: 'autocomplete',
-            name: 'package',
-            message: `Select package to ${action}:`,
-            options: packageStatuses.map(status => ({
-                name: status.package,
-                value: status.package,
-                description: `${status.totalDeployed} changes, last: ${status.lastChange}`
-            }))
-        }]);
-    return packageAnswer.package;
-}

package/esm/utils/module-utils.js

@@ -1,51 +0,0 @@
-import { LaunchQLPackage } from '@launchql/core';
-import { errors } from '@launchql/types';
-/**
- * Handle package selection for operations that need a specific package
- * Returns the selected package name, or undefined if validation fails or no packages exist
- */
-export async function selectPackage(argv, prompter, cwd, operationName, log) {
-    const pkg = new LaunchQLPackage(cwd);
-    const modules = await pkg.getModules();
-    const moduleNames = modules.map(mod => mod.getModuleName());
-    // Check if any modules exist
-    if (!moduleNames.length) {
-        const errorMsg = 'No modules found in the specified directory.';
-        if (log) {
-            log.error(errorMsg);
-            return undefined;
-        }
-        else {
-            prompter.close();
-            throw errors.NOT_FOUND({}, errorMsg);
-        }
-    }
-    // If a specific package was provided, validate it
-    if (argv.package) {
-        const packageName = argv.package;
-        if (log)
-            log.info(`Using specified package: ${packageName}`);
-        if (!moduleNames.includes(packageName)) {
-            const errorMsg = `Package '${packageName}' not found. Available packages: ${moduleNames.join(', ')}`;
-            if (log) {
-                log.error(errorMsg);
-                return undefined;
-            }
-            else {
-                throw errors.NOT_FOUND({}, errorMsg);
-            }
-        }
-        return packageName;
-    }
-    // Interactive selection
-    const { package: selectedPackage } = await prompter.prompt(argv, [{
-            type: 'autocomplete',
-            name: 'package',
-            message: `Choose a package to ${operationName}`,
-            options: moduleNames,
-            required: true
-        }]);
-    if (log)
-        log.info(`Selected package: ${selectedPackage}`);
-    return selectedPackage;
-}

package/package.d.ts

@@ -1 +0,0 @@
-export declare function readAndParsePackageJson(): any;

package/package.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readAndParsePackageJson = readAndParsePackageJson;
-const fs_1 = require("fs");
-const path_1 = require("path");
-// need to search due to the dist/ folder and src/, etc.
-function findPackageJson(currentDir) {
-    const filePath = (0, path_1.join)(currentDir, 'package.json');
-    // Check if package.json exists in the current directory
-    if ((0, fs_1.existsSync)(filePath)) {
-        return filePath;
-    }
-    // Get the parent directory
-    const parentDir = (0, path_1.dirname)(currentDir);
-    // If reached the root directory, package.json is not found
-    if (parentDir === currentDir) {
-        throw new Error('package.json not found in any parent directory');
-    }
-    // Recursively look in the parent directory
-    return findPackageJson(parentDir);
-}
-function readAndParsePackageJson() {
-    // Start searching from the current directory
-    const pkgPath = findPackageJson(__dirname);
-    // Read and parse the package.json
-    const str = (0, fs_1.readFileSync)(pkgPath, 'utf8');
-    const pkg = JSON.parse(str);
-    return pkg;
-}

package/utils/argv.d.ts

@@ -1,46 +0,0 @@
-import { ParsedArgs } from 'minimist';
-export declare const extractFirst: (argv: Partial<ParsedArgs>) => {
-    first: string;
-    newArgv: {
-        _: string[];
-        "--"?: string[] | undefined;
-    };
-};
-/**
- * Common CLI argument validation and processing utilities
- */
-export interface ValidatedArgv extends ParsedArgs {
-    cwd: string;
-    database?: string;
-    package?: string;
-    to?: string;
-    recursive?: boolean;
-    yes?: boolean;
-    tx?: boolean;
-    fast?: boolean;
-    logOnly?: boolean;
-    createdb?: boolean;
-    usePlan?: boolean;
-    cache?: boolean;
-    drop?: boolean;
-    all?: boolean;
-    summary?: boolean;
-    help?: boolean;
-    h?: boolean;
-}
-/**
- * Validates and normalizes common CLI arguments
- */
-export declare function validateCommonArgs(argv: Partial<ParsedArgs>): ValidatedArgv;
-/**
- * Checks if required flags are provided when certain conditions are met
- */
-export declare function validateFlagDependencies(argv: ValidatedArgv): void;
-/**
- * Logs the effective CLI arguments for debugging
- */
-export declare function logEffectiveArgs(argv: ValidatedArgv, commandName: string): void;
-/**
- * Constructs a deployment target string from package and to arguments
- */
-export declare function constructTarget(argv: ValidatedArgv, packageName?: string): string | undefined;