movehat 0.2.3 → 0.2.5

package/src/ui/logger.ts

@@ -1,310 +0,0 @@
-import { colors } from './colors.js';
-import { coloredSymbol, symbols } from './symbols.js';
-
-/**
- * Available log levels
- */
-export type LogLevel = 'info' | 'success' | 'error' | 'warning' | 'debug';
-
-/**
- * Verbosity level for subprocess output and gray-prefixed chatter.
- * - `quiet`   — reserved; currently behaves like `normal`
- * - `normal`  — default; system logs only, subprocess chatter hidden
- * - `verbose` — surface subprocess stdout with a muted gray `›` prefix
- */
-export type Verbosity = 'quiet' | 'normal' | 'verbose';
-
-/**
- * Logger configuration options
- */
-export interface LoggerConfig {
-  /** Suppress all output when true */
-  silent?: boolean;
-  /** Minimum log level to display */
-  level?: LogLevel;
-  /** Include timestamps in log messages */
-  timestamp?: boolean;
-  /** Verbosity level for subprocess output */
-  verbosity?: Verbosity;
-}
-
-/**
- * Internal logger state
- */
-let config: LoggerConfig = {
-  silent: false,
-  level: 'info',
-  timestamp: false,
-  verbosity: process.env.MOVEHAT_VERBOSE === '1' ? 'verbose' : 'normal',
-};
-
-/**
- * Whether subprocess chatter should reach the user's terminal.
- * Honors both the in-process config (set by the `-v` CLI flag's
- * preAction hook) and the `MOVEHAT_VERBOSE=1` env var (which lets
- * callers opt in before the CLI parses args, e.g. in shell scripts).
- */
-export const isVerbose = (): boolean =>
-  config.verbosity === 'verbose' || process.env.MOVEHAT_VERBOSE === '1';
-
-/**
- * Configure logger globally
- *
- * @param newConfig - Partial configuration to merge with current config
- *
- * @example
- * // Silence all logs for testing
- * configureLogger({ silent: true });
- *
- * // Enable timestamps
- * configureLogger({ timestamp: true });
- */
-export const configureLogger = (newConfig: Partial<LoggerConfig>): void => {
-  config = { ...config, ...newConfig };
-};
-
-/**
- * Format message with optional indentation
- */
-const formatMessage = (message: string, indent: number = 0): string => {
-  const prefix = ' '.repeat(indent);
-  return message.split('\n').map(line => prefix + line).join('\n');
-};
-
-/**
- * Info message (cyan)
- * Use for general information and status updates
- *
- * @param message - Message to log
- * @param indent - Number of spaces to indent (default: 0)
- *
- * @example
- * logger.info('Starting compilation...');
- * logger.info('Network: testnet', 2);
- */
-export const info = (message: string, indent: number = 0): void => {
-  if (config.silent) return;
-  const formatted = formatMessage(message, indent);
-  console.log(`${coloredSymbol('info')} ${formatted}`);
-};
-
-/**
- * Success message (green)
- * Use for completed operations and positive outcomes
- *
- * @param message - Message to log
- * @param indent - Number of spaces to indent (default: 0)
- *
- * @example
- * logger.success('Compilation finished!');
- * logger.success('All tests passed', 2);
- */
-export const success = (message: string, indent: number = 0): void => {
-  if (config.silent) return;
-  const formatted = formatMessage(message, indent);
-  console.log(`${coloredSymbol('success')} ${formatted}`);
-};
-
-/**
- * Error message (red)
- * Use for errors and failures
- *
- * @param message - Message to log
- * @param indent - Number of spaces to indent (default: 0)
- *
- * @example
- * logger.error('Compilation failed');
- * logger.error('File not found: config.ts', 2);
- */
-export const error = (message: string, indent: number = 0): void => {
-  if (config.silent) return;
-  const formatted = formatMessage(message, indent);
-  console.error(`${coloredSymbol('error')} ${formatted}`);
-};
-
-/**
- * Warning message (yellow)
- * Use for warnings and deprecated features
- *
- * @param message - Message to log
- * @param indent - Number of spaces to indent (default: 0)
- *
- * @example
- * logger.warning('Deprecated API used');
- * logger.warning('This feature will be removed in v2.0', 2);
- */
-export const warning = (message: string, indent: number = 0): void => {
-  if (config.silent) return;
-  const formatted = formatMessage(message, indent);
-  console.warn(`${coloredSymbol('warning')} ${formatted}`);
-};
-
-/**
- * Action / progress message (dim chevron prefix)
- * Use for in-progress action lines like "Building package", "Publishing
- * to blockchain" — anything that's a status update during a multi-step
- * operation. Distinct from `info` (general updates) and `success`
- * (completion).
- *
- * @param message - Message to log
- * @param indent - Number of spaces to indent (default: 0)
- *
- * @example
- * logger.step('Building package...');
- * logger.step('Publishing to blockchain...');
- * logger.success('Module published successfully!');
- */
-export const step = (message: string, indent: number = 0): void => {
-  if (config.silent) return;
-  const formatted = formatMessage(message, indent);
-  console.log(`${colors.dim(symbols.step)} ${formatted}`);
-};
-
-/**
- * Plain message without symbol
- * Use for continuation lines or when symbol is not appropriate
- *
- * @param message - Message to log
- *
- * @example
- * logger.info('Fork Details:');
- * logger.plain('   Chain ID: 126');
- * logger.plain('   Network: testnet');
- */
-export const plain = (message: string): void => {
-  if (config.silent) return;
-  console.log(message);
-};
-
-/**
- * Empty line
- * Use for visual spacing between sections
- *
- * @example
- * logger.success('Build complete');
- * logger.newline();
- * logger.info('Next steps:');
- */
-export const newline = (): void => {
-  if (config.silent) return;
-  console.log();
-};
-
-/**
- * Section header (bold, brand color)
- * Use for major section dividers
- *
- * @param title - Section title
- *
- * @example
- * logger.section('Fork Details');
- * logger.kv('Chain ID', '126', 2);
- * logger.kv('Network', 'testnet', 2);
- */
-export const section = (title: string): void => {
-  if (config.silent) return;
-  console.log(`\n${colors.brandBright(title)}`);
-};
-
-/**
- * Width of the `━` rule used by `phase` and `divider`. Matched to a
- * comfortable terminal width that fits in a side-by-side dev layout.
- */
-const PHASE_RULE_WIDTH = 52;
-
-/**
- * Single muted horizontal rule. Use to close out a phase or to
- * visually separate output sections.
- */
-export const divider = (): void => {
-  if (config.silent) return;
-  console.log(colors.muted('━'.repeat(PHASE_RULE_WIDTH)));
-};
-
-/**
- * Phase header — renders a muted top rule, a bold brand-colored title
- * indented two spaces, and a muted bottom rule. Use at top-level phase
- * boundaries (local node start, deploy flow, test orchestrator
- * sections) so the user can visually anchor where one phase ends and
- * the next begins.
- *
- * @param title - Phase title (e.g. "Local Movement node")
- *
- * @example
- * logger.phase('Local Movement node');
- * // Renders:
- * // ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
- * //   Local Movement node
- * // ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
- */
-export const phase = (title: string): void => {
-  if (config.silent) return;
-  const rule = colors.muted('━'.repeat(PHASE_RULE_WIDTH));
-  console.log(rule);
-  console.log(`  ${colors.brandBright(title)}`);
-  console.log(rule);
-};
-
-/**
- * Key-value pair
- * Use for displaying structured data
- *
- * @param key - The key/label
- * @param value - The value
- * @param indent - Number of spaces to indent (default: 0)
- *
- * @example
- * logger.kv('Network', 'testnet', 2);
- * logger.kv('Chain ID', '126', 2);
- */
-export const kv = (key: string, value: string, indent: number = 0): void => {
-  if (config.silent) return;
-  const prefix = ' '.repeat(indent);
-  console.log(`${prefix}${colors.dim(key)}: ${value}`);
-};
-
-/**
- * List item with bullet
- * Use for lists and enumerated items
- *
- * @param text - Item text
- * @param indent - Number of spaces to indent (default: 0)
- *
- * @example
- * logger.info('Next steps:');
- * logger.item('cd my-project', 2);
- * logger.item('npm install', 2);
- * logger.item('npm test', 2);
- */
-export const item = (text: string, indent: number = 0): void => {
-  if (config.silent) return;
-  const prefix = ' '.repeat(indent);
-  console.log(`${prefix}${symbols.bullet} ${text}`);
-};
-
-/**
- * Logger namespace export
- * Provides all logging functions in a single namespace
- *
- * @example
- * import { logger } from './ui/index.js';
- *
- * logger.info('Starting...');
- * logger.success('Done!');
- */
-export const logger = {
-  configure: configureLogger,
-  isVerbose,
-  info,
-  success,
-  error,
-  warning,
-  step,
-  plain,
-  newline,
-  section,
-  phase,
-  divider,
-  kv,
-  item,
-};

package/src/ui/spinner.ts

@@ -1,218 +0,0 @@
-import ora, { type Ora, type Options as OraOptions } from 'ora';
-import { shouldUseColor } from './colors.js';
-
-/**
- * Spinner color options
- */
-export type SpinnerColor = 'yellow' | 'green' | 'cyan' | 'red' | 'blue' | 'magenta' | 'white' | 'gray';
-
-/**
- * Spinner configuration options
- */
-export interface SpinnerOptions {
-  /** Text to display next to the spinner */
-  text: string;
-  /** Spinner color (default: 'yellow' for Movehat brand) */
-  color?: SpinnerColor;
-  /** Spinner animation type (default: 'dots') */
-  spinner?: OraOptions['spinner'];
-  /** Number of spaces to indent (default: 0) */
-  indent?: number;
-}
-
-/**
- * Create and start a spinner
- * Automatically disabled in non-TTY environments (CI, pipes)
- *
- * @param options - Spinner configuration
- * @returns Ora spinner instance
- *
- * @example
- * const spin = spinner({ text: 'Compiling contracts...' });
- * await longRunningTask();
- * spin.succeed('Compilation complete!');
- *
- * @example
- * const spin = spinner({ text: 'Fetching data...', color: 'cyan' });
- * try {
- *   await fetchData();
- *   spin.succeed('Data fetched!');
- * } catch (error) {
- *   spin.fail('Failed to fetch data');
- * }
- */
-export const spinner = (options: SpinnerOptions): Ora => {
-  const { text, color = 'yellow', spinner = 'dots', indent = 0 } = options;
-
-  const prefixSpaces = ' '.repeat(indent);
-
-  const oraOptions: OraOptions = {
-    text: prefixSpaces + text,
-    color,
-    spinner,
-    // Disable spinner if not TTY (CI environments, piped output)
-    isEnabled: shouldUseColor() && Boolean(process.stdout.isTTY),
-  };
-
-  return ora(oraOptions).start();
-};
-
-/**
- * Execute async task with spinner
- * Handles success/error automatically and always cleans up
- *
- * @param startText - Initial spinner text
- * @param task - Async function to execute
- * @param successText - Text to show on success (optional, defaults to startText without '...')
- * @param errorText - Text to show on error (optional, defaults to error message)
- * @param indent - Number of spaces to indent (default: 0)
- * @returns Promise resolving to task result
- *
- * @example
- * const data = await withSpinner(
- *   'Fetching network data...',
- *   async () => await fetchData(),
- *   'Data fetched successfully'
- * );
- *
- * @example
- * await withSpinner(
- *   'Creating fork...',
- *   async () => await createFork(),
- *   'Fork created!',
- *   'Failed to create fork'
- * );
- */
-export const withSpinner = async <T>(
-  startText: string,
-  task: () => Promise<T>,
-  successText?: string,
-  errorText?: string,
-  indent: number = 0
-): Promise<T> => {
-  const spin = spinner({ text: startText, indent });
-
-  try {
-    const result = await task();
-    spin.succeed(successText || startText.replace(/\.\.\.?$/, ''));
-    return result;
-  } catch (error) {
-    const errMsg = error instanceof Error ? error.message : String(error);
-    spin.fail(errorText || `Failed: ${errMsg}`);
-    throw error;
-  }
-};
-
-/**
- * Execute async task with a spinner that updates its label with
- * elapsed seconds while the task runs. Use for long-running phases
- * (local node startup, publish + tx wait) where the user wants
- * visible progress feedback in lieu of subprocess chatter.
- *
- * Pairs with the `§9` console-UX convention: any phase that
- * empirically takes ≥3s in normal use should wrap its body in
- * `withTimedSpinner` so the terminal never goes silent while work
- * happens.
- *
- * @param label - Stable label shown next to the spinner (e.g. "Starting node")
- * @param task - Async function to execute
- * @param indent - Number of spaces to indent (default: 0)
- * @returns Promise resolving to task result
- *
- * @example
- * await withTimedSpinner('Starting local node', async () => {
- *   await this.waitForReady(60_000);
- * });
- * // Renders: ⠋ Starting local node — 0.0s ... ⠼ Starting local node — 14.2s
- * // On success: ✔ Starting local node (14.2s)
- * // On error:   ✖ <error.message>
- */
-export const withTimedSpinner = async <T>(
-  label: string,
-  task: () => Promise<T>,
-  indent: number = 0
-): Promise<T> => {
-  const start = Date.now();
-  const spin = spinner({ text: `${label} — 0.0s`, indent });
-  const timer = setInterval(() => {
-    spin.text = `${label} — ${((Date.now() - start) / 1000).toFixed(1)}s`;
-  }, 500);
-  try {
-    const result = await task();
-    spin.succeed(`${label} (${((Date.now() - start) / 1000).toFixed(1)}s)`);
-    return result;
-  } catch (error) {
-    const errMsg = error instanceof Error ? error.message : String(error);
-    spin.fail(errMsg);
-    throw error;
-  } finally {
-    clearInterval(timer);
-  }
-};
-
-/**
- * Spinner chain for sequential operations
- * Manages multiple spinners in sequence
- */
-export interface SpinnerChain {
-  /**
-   * Add and execute a step in the chain
-   */
-  add<T>(text: string, task: () => Promise<T>, indent?: number): Promise<T>;
-
-  /**
-   * Complete the chain (cleanup)
-   */
-  complete(): void;
-}
-
-/**
- * Create a sequential spinner chain
- * Useful for multi-step processes like initialization
- *
- * @returns SpinnerChain interface
- *
- * @example
- * const steps = createSpinnerChain();
- *
- * await steps.add('Creating directories...', async () => {
- *   await mkdir(projectPath);
- * });
- *
- * await steps.add('Copying templates...', async () => {
- *   await copyFiles();
- * });
- *
- * await steps.add('Installing dependencies...', async () => {
- *   await npmInstall();
- * });
- *
- * steps.complete();
- */
-export const createSpinnerChain = (): SpinnerChain => {
-  let currentSpinner: Ora | null = null;
-
-  return {
-    async add<T>(
-      text: string,
-      task: () => Promise<T>,
-      indent: number = 0
-    ): Promise<T> {
-      currentSpinner = spinner({ text, indent });
-      try {
-        const result = await task();
-        currentSpinner.succeed();
-        return result;
-      } catch (error) {
-        currentSpinner.fail();
-        throw error;
-      }
-    },
-
-    complete() {
-      if (currentSpinner) {
-        currentSpinner.stop();
-      }
-    },
-  };
-};

package/src/ui/symbols.ts

@@ -1,80 +0,0 @@
-import figures from 'figures';
-import { colors } from './colors.js';
-
-/**
- * Platform-aware symbols using the figures library
- * Automatically falls back to ASCII on unsupported terminals
- *
- * @example
- * console.log(`${symbols.success} Task completed`);
- * console.log(`${symbols.error} Task failed`);
- */
-export const symbols = {
-  // Status symbols
-  success: figures.tick,          // ✔ or √
-  error: figures.cross,           // ✖ or ×
-  warning: figures.warning,       // ⚠ or ‼
-  info: figures.info,             // ℹ or i
-
-  // Action / progress symbols
-  step: '▸',                 // ▸  — used to prefix in-progress action lines
-                                  // (e.g. "▸ Building package"). Plain Unicode
-                                  // BLACK RIGHT-POINTING SMALL TRIANGLE, supported
-                                  // in every UTF-8 terminal. If a non-UTF-8
-                                  // environment ever surfaces, switch to
-                                  // figures.pointerSmall ('›' with ASCII fallback).
-  pointer: figures.pointer,       // ❯ or >
-  checkboxOn: figures.checkboxOn, // ☑ or [×]
-  checkboxOff: figures.checkboxOff, // ☐ or [ ]
-
-  // UI symbols
-  bullet: figures.bullet,         // ● or *
-  ellipsis: figures.ellipsis,     // … or ...
-  line: figures.line,             // ─ or -
-  arrow: figures.arrowRight,      // → or ->
-
-  // Box drawing characters
-  boxTop: '─',
-  boxBottom: '─',
-  boxLeft: '│',
-  boxRight: '│',
-  boxTopLeft: '┌',
-  boxTopRight: '┐',
-  boxBottomLeft: '└',
-  boxBottomRight: '┘',
-
-  // Semantic aliases for better code readability
-  check: figures.tick,
-  cross: figures.cross,
-  radioOn: figures.radioOn,
-  radioOff: figures.radioOff,
-};
-
-/**
- * Symbol types for colored symbol function
- */
-export type SymbolType = 'success' | 'error' | 'warning' | 'info';
-
-/**
- * Get a symbol with appropriate semantic color
- * Automatically applies the correct color based on symbol type
- *
- * @param type - The type of symbol ('success', 'error', 'warning', 'info')
- * @returns Colored symbol ready for console output
- *
- * @example
- * console.log(`${coloredSymbol('success')} Build successful`);
- * console.log(`${coloredSymbol('error')} Build failed`);
- */
-export const coloredSymbol = (type: SymbolType): string => {
-  switch (type) {
-    case 'success':
-      return colors.success(symbols.success);
-    case 'error':
-      return colors.error(symbols.error);
-    case 'warning':
-      return colors.warning(symbols.warning);
-    case 'info':
-      return colors.info(symbols.info);
-  }
-};