ember-cli-deploy-progress

1.3.0 verified Sat Apr 25 auth: no javascript

Flexible ASCII progress bar for Node.js, forked from the popular 'progress' package by visionmedia with an added cursor feature for the last completion character. Current stable version is 1.3.0. Release cadence is low; this is a specialized fork maintained by the ember-cli-deploy organization. Key differentiators include support for custom tokens, a cursor character distinct from the completion character, and a render throttle option. Commonly used in CLI tools and download progress displays.

Common errors

error Error: Cannot find module 'progress' ↓

cause Package not installed or not available in node_modules

fix

Run npm install progress (or ember-cli-deploy-progress if using the fork).

error TypeError: bar.tick is not a function ↓

cause ProgressBar not properly instantiated or bar is undefined

fix

Ensure you call new ProgressBar(...) and that bar is correctly assigned.

error ReferenceError: ProgressBar is not defined ↓

cause ProgressBar variable not imported/required

fix

Add const ProgressBar = require('progress'); at top of file.

error ProgressBar is not a constructor ↓

cause Importing wrong export (e.g., using named import)

fix

Use default import: import ProgressBar from 'progress' (ESM) or const ProgressBar = require('progress') (CJS).

Warnings

gotcha Node engines >= 0.4.0 specified; no longer supported in modern Node. May cause deprecation warnings. ↓

fix Use a more modern progress bar library or update to ember-cli-deploy-progress@1.3.0 (same engine range but Node 4+ works).

breaking The 'cursor' option is added in this fork. It is not available in the original 'progress' package. ↓

fix If you rely on 'cursor', use this fork only. If you need compatibility with the original, remove 'cursor'.

gotcha The library does not automatically clear the progress bar on completion; you must set 'clear: true' option. ↓

fix Pass `{ clear: true }` in options if you want the bar to be cleared upon completion.

gotcha Custom tokens passed to tick() are not validated; misspelled tokens will be silently ignored. ↓

fix Ensure token names match exactly the placeholders in the format string.

deprecated The 'renderThrottle' option default is 16ms. Changing it may cause performance issues or flickering. ↓

fix Keep the default unless you experience specific rendering problems.

Install

npm install ember-cli-deploy-progress

yarn add ember-cli-deploy-progress

pnpm add ember-cli-deploy-progress

Imports

ProgressBar
wrong
```
import ProgressBar from 'progress';
```
correct
```
const ProgressBar = require('progress');
```
This package does not provide an ESM export; CommonJS require is the correct method.

ProgressBar (ESM via import)

wrong

import { ProgressBar } from 'progress';

correct

import ProgressBar from 'progress';
// Requires Node >= 12 with 'type': 'module' or .mjs extension

Named import does not work because the module exports a single constructor function as default.

ProgressBar type (TypeScript)
wrong
```
const ProgressBar: ...
```
correct
```
import ProgressBar from 'progress';
// No built-in types; use @types/progress
```
TypeScript users must install @types/progress for type definitions.

Quickstart

Creates a progress bar with total 10 ticks, updates every 100ms until complete.

const ProgressBar = require('progress');
const bar = new ProgressBar(':bar', { total: 10 });
const timer = setInterval(() => {
  bar.tick();
  if (bar.complete) {
    console.log('\ncomplete\n');
    clearInterval(timer);
  }
}, 100);