@v4fire/client/build/webpack/plugins/progress-plugin/progressbar-view.js

V4Fire client core library

'use strict';

/*!
 * V4Fire Client Core
 * https://github.com/V4Fire/Client
 *
 * Released under the MIT license
 * https://github.com/V4Fire/Client/blob/master/LICENSE
 */

const
	config = require('@config/config'),
	cliProgress = require('cli-progress');

const
	ProgressView = include('build/webpack/plugins/progress-plugin/progress-view');

/**
 * Class to print progress status by using a dynamic terminal progressbar
 */
module.exports = class ProgressbarView extends ProgressView {
	/**
	 * Formatter for a `cli-progress` MultiBar widget
	 *
	 * @see https://www.npmjs.com/package/cli-progress
	 * @param opts
	 * @param params
	 * @param payload
	 * @returns {string}
	 */
	static formatter(opts, params, payload) {
		const
			name = payload.processName.padEnd(15),
			completeSize = Math.round(params.progress * opts.barsize),
			incompleteSize = opts.barsize - completeSize;

		const bar =
			opts.barCompleteString.substring(0, completeSize) +
			opts.barGlue +
			opts.barIncompleteString.substring(0, incompleteSize);

		return `# ${name} ${bar} ${params.value}%`;
	}

	constructor() {
		super();

		this.multibar = new cliProgress.MultiBar(
			{
				format: ProgressbarView.formatter,
				...config.webpack.progress()?.opts
			},

			cliProgress.Presets.shades_grey
		);
	}

	_createProgressBar(processName) {
		this.handlers[processName] = this.multibar.create(100, 0, {processName});
	}

	_removeProgressBar(processName) {
		this.multibar.remove(this.handlers[processName]);
	}

	/** @override */
	getProgressHandler(processName) {
		this._createProgressBar(processName);

		return this._updateProgress.bind(this, processName);
	}

	/** @override */
	_updateProgress(processName, newProgress) {
		if (!this.handlers[processName].isActive) {
			this._removeProgressBar(processName);
			this._createProgressBar(processName);
		}

		this.handlers[processName].update(this._convertProgressToPercent(newProgress));

		super._updateProgress(processName, newProgress);
	}
};