purgetss/src/cli/utils/cli-helpers.js

A package that simplifies mobile app creation for Titanium developers.

/**
 * PurgeTSS v7.1 - CLI Utilities
 *
 * Common utilities for CLI commands like timing and project detection.
 * Extracted from src/index.js during refactorization.
 *
 * @fileoverview CLI helper utilities
 * @version 7.1.0
 * @author César Estrada
 * @since 2025-06-15
 */

import chalk from 'chalk'
import { logger, getDebugMode } from '../../shared/logger.js'

// Global timing variables
let startTime
let localStartTime

/**
 * Start global timer for command execution
 * Maintains exact same logic as original start() function
 */
export function start() {
  startTime = new Date()
}

/**
 * Finish global timer and log execution time
 * Maintains exact same logic as original finish() function
 *
 * @param {string} customMessage - Custom message to display
 */
export function finish(customMessage = 'Finished purging in') {
  const endTime = new Date(new Date() - startTime)
  logger.info(customMessage, chalk.green(`${endTime.getSeconds()}s ${endTime.getMilliseconds()}ms`))
}

/**
 * Start local timer for sub-operations
 * Maintains exact same logic as original localStart() function
 */
export function localStart() {
  localStartTime = new Date()
}

/**
 * Finish local timer and log execution time (only in debug mode).
 *
 * Pass an empty string to print only the timing (without re-emitting the
 * label) — useful when the caller already showed the section title via
 * `logger.info` before calling `localStart()`. Anything else is printed
 * verbatim with the timing appended.
 *
 * @param {string} customMessage - Label to print alongside the timing, or
 *   `''` for timing-only mode.
 */
export function localFinish(customMessage = 'Finished purging in') {
  const localEndTime = new Date(new Date() - localStartTime)
  if (!getDebugMode()) return
  const timing = chalk.green(`${localEndTime.getSeconds()}s ${localEndTime.getMilliseconds()}ms`)
  if (customMessage === '') {
    // Timing-only mode: caller already printed the label.
    logger.info(timing)
  } else {
    logger.info(customMessage, timing)
  }
}

/**
 * Timer utilities grouped for convenience
 */
export const timer = {
  start,
  finish,
  localStart,
  localFinish
}

/**
 * Export for CLI usage
 */
export default {
  start,
  finish,
  localStart,
  localFinish,
  timer
}