igir/dist/src/console/progressBar.js

🕹 A zero-setup ROM collection manager that sorts, filters, extracts or archives, patches, and reports on collections of any size on any OS.

import chalk from 'chalk';
import isUnicodeSupported from 'is-unicode-supported';
import { LogLevel } from './logLevel.js';
/**
 * @see https://www.toptal.com/designers/htmlarrows/symbols/
 * @see https://www.htmlsymbols.xyz/
 * @see https://www.fileformat.info/info/unicode/font/lucida_console/grid.htm (win32)
 */
const UNICODE_SUPPORTED = isUnicodeSupported();
export const ProgressBarSymbol = {
    NONE: { symbol: '', color: chalk.reset },
    WAITING: { symbol: UNICODE_SUPPORTED ? '⋯' : '…', color: chalk.grey },
    DONE: { symbol: UNICODE_SUPPORTED ? '✓' : '√', color: chalk.green },
    // Files
    FILE_SCANNING: { symbol: UNICODE_SUPPORTED ? '↻' : '○', color: chalk.magenta },
    DAT_DOWNLOADING: { symbol: '↓', color: chalk.magenta },
    DAT_PARSING: { symbol: 'Σ', color: chalk.magenta },
    ROM_HASHING: { symbol: '#', color: chalk.magenta },
    ROM_HEADER_DETECTION: { symbol: '^', color: chalk.magenta },
    ROM_TRIMMING_DETECTION: { symbol: UNICODE_SUPPORTED ? '⌵' : 'v', color: chalk.magenta },
    ROM_INDEXING: { symbol: '♦', color: chalk.magenta },
    // Processing a single DAT
    DAT_GROUPING_SIMILAR: { symbol: '∩', color: chalk.cyan },
    DAT_MERGE_SPLIT: { symbol: '↔', color: chalk.cyan },
    DAT_FILTERING: { symbol: '∆', color: chalk.cyan },
    DAT_PREFERRING: { symbol: UNICODE_SUPPORTED ? '⇅' : '↨', color: chalk.cyan },
    // Candidates
    CANDIDATE_GENERATING: { symbol: 'Σ', color: chalk.cyan },
    CANDIDATE_EXTENSION_CORRECTION: { symbol: '.', color: chalk.cyan },
    CANDIDATE_HASHING: { symbol: '#', color: chalk.yellow },
    CANDIDATE_VALIDATING: { symbol: UNICODE_SUPPORTED ? '≟' : '?', color: chalk.cyan },
    CANDIDATE_COMBINING: { symbol: UNICODE_SUPPORTED ? '∪' : 'U', color: chalk.cyan },
    TESTING: { symbol: UNICODE_SUPPORTED ? '≟' : '?', color: chalk.yellow },
    WRITING: { symbol: UNICODE_SUPPORTED ? '✎' : '»', color: chalk.yellow },
    RECYCLING: { symbol: UNICODE_SUPPORTED ? '♻' : '»', color: chalk.blue },
    DELETING: { symbol: UNICODE_SUPPORTED ? '✕' : 'X', color: chalk.red },
};
/**
 * ProgressBar represents a single progress bar (of potentially many) to present completion
 * information about an operation.
 */
export default class ProgressBar {
    /**
     * Call the `done()` method with a completion message that indicates how many items were
     * processed.
     */
    finishWithItems(count, noun, verb) {
        let pluralSuffix = 's';
        if (noun.toLowerCase().endsWith('ch') || noun.toLowerCase().endsWith('s')) {
            pluralSuffix = 'es';
        }
        this.finish(`${count.toLocaleString()} ${noun.trim()}${count === 1 ? '' : pluralSuffix} ${verb}`);
    }
    /**
     * Log a TRACE message.
     *
     * This should be used to log internal actions that most users shouldn't care about, but could be
     * helpful in bug reports.
     */
    logTrace(message) {
        this.log(LogLevel.TRACE, message);
    }
    /**
     * Log a DEBUG message.
     *
     * This should be used to log actions that weren't taken (i.e. skipped writing a ROM because it
     * already exists, etc.).
     */
    logDebug(message) {
        this.log(LogLevel.DEBUG, message);
    }
    /**
     * Log an INFO message.
     *
     * This should be used to log actions that were taken (i.e. copying/moving ROMs, recycling files,
     * writing DATs, etc.).
     */
    logInfo(message) {
        this.log(LogLevel.INFO, message);
    }
    /**
     * Log a WARN message.
     */
    logWarn(message) {
        this.log(LogLevel.WARN, message);
    }
    /**
     * Log an ERROR message.
     */
    logError(message) {
        this.log(LogLevel.ERROR, message);
    }
}