Registry / database / east-migration-progress-indicator-helper

east-migration-progress-indicator-helper

library1.1.0jsnpmunverified

A plugin for the East database migration tool that provides a progress indicator helper for migrations. Current stable version 1.1.0, maintained with low release cadence. It integrates with East's client object to create progress bars that display in TTY terminals or log text progress in non-TTY environments. Differentiator: simple drop-in plugin that requires no additional configuration beyond adding to .eastrc.

database devops

npm install east-migration-progress-indicator-helper

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · EAST-MIGRATION-PRO

east-migration-progress-indicator-helper

databasejavascriptv1.1.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

client.createIndicator

✓ Add plugin to .eastrc, then use client.createIndicator({total})

✗ const createIndicator = require('east-migration-progress-indicator-helper')

The helper is not directly imported; it is loaded as an East plugin and then available via client.createIndicator()

Creates a progress indicator with total steps and calls tick() at various intervals to show progress.

// In migration file, e.g. 1_test.js exports.migrate = function(client, done) { const indicator = client.createIndicator({total: 150}); indicator.tick(5); setTimeout(() => { indicator.tick(45); }, 100); setTimeout(() => { indicator.tick(50); }, 100); setTimeout(() => { indicator.tick(50); }, 500); setTimeout(done, 1000); };

Debug

Known issues

gotchaThe plugin requires East version >=1.2.0-rc.1 and <3.0.0. Using with newer East versions may break.

fix

Ensure East version satisfies peer dependency.

affects: <1.2.0-rc.1 || >=3.0.0

gotchaclient.createIndicator() is only available if the plugin is added to .eastrc; otherwise the method is undefined.

fix

Add 'east-migration-progress-indicator-helper' to plugins in .eastrc.

affects: all

deprecatedThe package has not been updated in years; it may have unpatched vulnerabilities in dependencies.

fix

Consider using a more actively maintained migration tool or update dependencies manually.

affects: all

Errors

Common errors & fixes

TypeError: client.createIndicator is not a function

Plugin not installed or not listed in .eastrc plugins array.

fix

Install plugin and add "east-migration-progress-indicator-helper" to plugins in .eastrc.

Upgrade

Version history

1.1.0latest on npm

Audit

Dependencies

eastrequiredPeer dependency: the plugin is designed to work with East migration framework versions >=1.2.0-rc.1 and <3.0.0

Agent activity

7 hits · last 30 days

node

Resources

githubhttps://github.com/okv/east-migration-progress-indicator-helper ↗

packageeast-migration-progress-indicator-helper ↗

homepagehttps://github.com/okv/east-migration-progress-indicator-helper#readme ↗