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 { 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)
 */
export const ProgressBarSymbol = {
    NONE: '',
    WAITING: chalk.grey(process.platform === 'win32' ? '…' : '⋯'),
    DONE: chalk.green(process.platform === 'win32' ? '√' : '✓'),
    // Files
    FILE_SCANNING: chalk.magenta(process.platform === 'win32' ? '○' : '↻'),
    DAT_DOWNLOADING: chalk.magenta('↓'),
    DAT_PARSING: chalk.magenta('Σ'),
    ROM_HASHING: chalk.magenta('#'),
    ROM_HEADER_DETECTION: chalk.magenta('^'),
    ROM_INDEXING: chalk.magenta('♦'),
    // Processing a single DAT
    DAT_GROUPING_SIMILAR: chalk.cyan('∩'),
    DAT_MERGE_SPLIT: chalk.cyan('↔'),
    DAT_FILTERING: chalk.cyan('∆'),
    DAT_PREFERRING: chalk.cyan(process.platform === 'win32' ? '↨' : '⇅'),
    // Candidates
    CANDIDATE_GENERATING: chalk.cyan('Σ'),
    CANDIDATE_EXTENSION_CORRECTION: chalk.cyan('.'),
    CANDIDATE_HASHING: chalk.yellow('#'),
    CANDIDATE_VALIDATING: chalk.cyan(process.platform === 'win32' ? '?' : '≟'),
    CANDIDATE_COMBINING: chalk.cyan(process.platform === 'win32' ? 'U' : '∪'),
    TESTING: chalk.yellow(process.platform === 'win32' ? '?' : '≟'),
    WRITING: chalk.yellow(process.platform === 'win32' ? '»' : '✎'),
    RECYCLING: chalk.blue(process.platform === 'win32' ? '»' : '♻'),
    DELETING: chalk.red(process.platform === 'win32' ? 'X' : '✕'),
};
/**
 * 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.
     */
    doneItems(count, noun, verb) {
        let pluralSuffix = 's';
        if (noun.toLowerCase().endsWith('ch') || noun.toLowerCase().endsWith('s')) {
            pluralSuffix = 'es';
        }
        this.done(`${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);
    }
}
//# sourceMappingURL=progressBar.js.map