Trackster

A customizable and lightweight CLI progress bar for Node.js, with support for dynamic colors, fill characters and progress updates.

Features

• Customizable Fill Characters: Use different characters to represent progress (#, ., *, etc.)
• Support for Colors: Change the color of the progress bar.
• Flexible Length: Control the length of the progress bar.
• Real-time Updates: Easily update the progress bar during long-running tasks.

Installation

To install trackster run the following command:

npm install trackster

Usage

Once installed, you can import and use the progress bar in your project.

Basic Usage

import { createProgressBar } from 'trackster';

const config = {
  fillChar: 'hash', // optional, default is 'hash'
  color: 'green',   // optional, default is no color
  length: 50,       // optional, default is 100
  showBounds: true,  // optional, default is true
  textMode: 'percentage'  // optional, default is 'none'
};

const progressBar = createProgressBar(100, config);

for (let i = 0; i <= 100; i++) {
  // Update progress bar
  progressBar.updateProgressBar(i);
  setTimeout(() => {}, 100);
}

// Complete the progress bar once done
progressBar.completeProgressBar();

Available Configuration Options

• fillChar: The character used to fill the progress bar. Options include:

  • 'dot'
  • 'hash'
  • 'asterisk'
  • 'equals'
  • 'hyphen'
  • 'bar'
  • 'empty-block'
  • 'light-block'
  • 'medium-block'
  • 'full-block'

  Default: 'hash'

• color: The color of the progress bar. You can use the following colors:

  • 'red'
  • 'green'
  • 'blue'
  • 'yellow'
  • 'cyan'
  • 'magenta'
  • 'white'
  • 'black'

  Default: No color (use terminal defaults)

• length: The length of the progress bar in characters.

  Default: 100

• showBounds: Whether to show square brackets around the progress bar.

  Default: true

• emptyChar: The character used to represent the empty space in the progress bar.

  Default: ' ' (space)

• textMode: Controls the display of progress text. Options include:

  • none: no text displayed
  • count: shows progress as "n/m" (e.g. 5/10)
  • percentage: shows progress as percentage (e.g. 50%)

  Default: none