@figliolia/chalk-animation 1.0.1 → 1.0.3

package/README.md

@@ -1,6 +1,6 @@
 # chalk-animation
 
-> Colorful animations in terminal output
+Colorful animations in terminal output
 
 
 ## Available animations

package/dist/cjs/Animation.js

@@ -1,18 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Animation = void 0;
-const InstanceTracker_1 = require("./InstanceTracker");
-class Animation extends InstanceTracker_1.InstanceTracker {
+const FrameRate_1 = require("./FrameRate");
+const Decor_1 = require("./Decor");
+class Animation extends FrameRate_1.FrameRate {
     constructor(effect, str, delay = 0, speed = 0) {
-        super();
+        super(delay, speed);
         this.stopped = false;
-        this.currentFrame = 0;
         this.initialized = false;
-        this.controller = null;
+        this.replace = Decor_1.Decor.chainable(this, (str) => {
+            this.text = str.split(Animation.LINE_BREAKS);
+            this.lines = this.text.length;
+        });
+        this.stop = Decor_1.Decor.chainable(this, () => {
+            this.clearFrames();
+            this.stopped = true;
+        });
+        this.start = Decor_1.Decor.chainable(this, () => {
+            this.clearFrames();
+            this.stopped = false;
+            this.render();
+        });
         this.effect = effect;
-        this.speed = speed;
-        this.delay = delay;
-        this.text = str.split(/\r\n|\r|\n/);
+        this.text = str.split(Animation.LINE_BREAKS);
         this.lines = this.text.length;
     }
     render() {
@@ -20,41 +30,20 @@ class Animation extends InstanceTracker_1.InstanceTracker {
             Animation.LOG("\n".repeat(this.lines - 1));
             this.initialized = true;
         }
-        Animation.LOG(this.frame());
-        this.controller = setTimeout(() => {
+        Animation.LOG(this.nextFrame());
+        this.schedule(() => {
             if (!this.stopped) {
                 this.render();
             }
-        }, this.delay / this.speed);
+        });
     }
-    frame() {
-        this.currentFrame++;
+    nextFrame() {
+        this.increment();
         return ("\u001B[" +
             `${this.lines}` +
             "F\u001B[G\u001B[2K" +
-            this.text.map((str) => this.effect(str, this.currentFrame)).join("\n"));
-    }
-    replace(str) {
-        this.text = str.split(/\r\n|\r|\n/);
-        this.lines = this.text.length;
-        return this;
-    }
-    stop() {
-        this.clearFrames();
-        this.stopped = true;
-        return this;
-    }
-    start() {
-        this.clearFrames();
-        this.stopped = false;
-        this.render();
-        return this;
-    }
-    clearFrames() {
-        if (this.controller) {
-            clearTimeout(this.controller);
-            this.controller = null;
-        }
+            this.text.map(str => this.effect(str, this.current)).join("\n"));
     }
 }
 exports.Animation = Animation;
+Animation.LINE_BREAKS = /\r\n|\r|\n/;

package/dist/cjs/ChalkAnimation.js

@@ -1,30 +1,35 @@
 "use strict";
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChalkAnimation = void 0;
 const Effects_1 = require("./Effects");
 const Animation_1 = require("./Animation");
-const animateString_1 = require("./animateString");
+/**
+ * Chalk Animation
+ *
+ * Console animations for your CLI tools
+ *
+ * ```typescript
+ * const animation = ChalkAnimation.rainbow("hello!");
+ * animation.stop();
+ * animation.start();
+ * ```
+ */
 class ChalkAnimation {
-    static rainbow(str, speed = 1) {
-        return (0, animateString_1.animateString)(Effects_1.Effects.rainbow, str, 15, speed);
-    }
-    static pulse(str, speed = 1) {
-        return (0, animateString_1.animateString)(Effects_1.Effects.pulse, str, 16, speed);
-    }
-    static glitch(str, speed = 1) {
-        return (0, animateString_1.animateString)(Effects_1.Effects.glitch, str, 55, speed);
-    }
-    static radar(str, speed = 1) {
-        return (0, animateString_1.animateString)(Effects_1.Effects.radar, str, 50, speed);
-    }
-    static neon(str, speed = 1) {
-        return (0, animateString_1.animateString)(Effects_1.Effects.neon, str, 500, speed);
-    }
-    static karaoke(str, speed = 1) {
-        return (0, animateString_1.animateString)(Effects_1.Effects.karaoke, str, 50, speed);
-    }
-    static clearAllAnimations() {
-        return Animation_1.Animation.clearAll();
+    static configure(effect, delay) {
+        return (str, speed = 1) => {
+            if (!speed || speed <= 0) {
+                throw new Error("Expected `speed` to be an number greater than 0");
+            }
+            return new Animation_1.Animation(Effects_1.Effects[effect], str, delay, speed).start();
+        };
     }
 }
 exports.ChalkAnimation = ChalkAnimation;
+_a = ChalkAnimation;
+ChalkAnimation.neon = _a.configure("neon", 500);
+ChalkAnimation.radar = _a.configure("radar", 50);
+ChalkAnimation.pulse = _a.configure("pulse", 16);
+ChalkAnimation.glitch = _a.configure("glitch", 55);
+ChalkAnimation.rainbow = _a.configure("rainbow", 15);
+ChalkAnimation.karaoke = _a.configure("karaoke", 50);

package/dist/cjs/Decor.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Decor = void 0;
+class Decor {
+    static bound(target, _propertyKey, descriptor) {
+        const operation = descriptor.value;
+        if (operation) {
+            descriptor.value = operation.bind(target);
+        }
+    }
+    static chainable(instance, func) {
+        return (...params) => {
+            func(...params);
+            return instance;
+        };
+    }
+}
+exports.Decor = Decor;

package/dist/cjs/Effects.js

@@ -1,4 +1,10 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -6,12 +12,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Effects = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const gradient_string_1 = __importDefault(require("gradient-string"));
+const Decor_1 = require("./Decor");
 class Effects {
     static rainbow(str, frame) {
         const hue = 5 * frame;
         const leftColor = { h: hue % 360, s: 1, v: 1 };
         const rightColor = { h: (hue + 1) % 360, s: 1, v: 1 };
-        return (0, gradient_string_1.default)(leftColor, rightColor)(str, Effects.longHsv);
+        return (0, gradient_string_1.default)(leftColor, rightColor)(str, this.longHsv);
     }
     static pulse(str, frame) {
         frame = (frame % 120) + 1;
@@ -56,7 +63,7 @@ class Effects {
             i += skip;
             if (str[i]) {
                 if (str[i] !== "\n" && str[i] !== "\r" && Math.random() > 0.995) {
-                    chunks.push(Effects.glitchChars[Math.floor(Math.random() * Effects.glitchChars.length)]);
+                    chunks.push(this.glitchChars[Math.floor(Math.random() * this.glitchChars.length)]);
                 }
                 else if (Math.random() > 0.005) {
                     chunks.push(str[i]);
@@ -104,6 +111,24 @@ class Effects {
             chalk_1.default.white(str.substr(chars)));
     }
 }
-exports.Effects = Effects;
 Effects.longHsv = { interpolation: "hsv", hsvSpin: "long" };
 Effects.glitchChars = "x*0987654321[]0-~@#(____!!!!\\|?????....0000\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t";
+__decorate([
+    Decor_1.Decor.bound
+], Effects, "rainbow", null);
+__decorate([
+    Decor_1.Decor.bound
+], Effects, "pulse", null);
+__decorate([
+    Decor_1.Decor.bound
+], Effects, "glitch", null);
+__decorate([
+    Decor_1.Decor.bound
+], Effects, "radar", null);
+__decorate([
+    Decor_1.Decor.bound
+], Effects, "neon", null);
+__decorate([
+    Decor_1.Decor.bound
+], Effects, "karaoke", null);
+exports.Effects = Effects;

package/dist/cjs/FrameRate.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FrameRate = void 0;
+const InstanceTracker_1 = require("./InstanceTracker");
+class FrameRate extends InstanceTracker_1.InstanceTracker {
+    constructor(delay, speed) {
+        super();
+        this.current = 0;
+        this.controller = null;
+        this.delay = delay;
+        this.speed = speed;
+    }
+    schedule(func) {
+        this.controller = setTimeout(func, this.delay / this.speed);
+    }
+    increment() {
+        this.current++;
+    }
+    clearFrames() {
+        if (this.controller) {
+            clearTimeout(this.controller);
+            this.controller = null;
+        }
+    }
+}
+exports.FrameRate = FrameRate;

package/dist/cjs/InstanceTracker.js

@@ -1,4 +1,5 @@
 "use strict";
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InstanceTracker = void 0;
 const event_emitter_1 = require("@figliolia/event-emitter");
@@ -19,12 +20,13 @@ class InstanceTracker {
     }
 }
 exports.InstanceTracker = InstanceTracker;
+_a = InstanceTracker;
 InstanceTracker.LOG = console.log;
 InstanceTracker.IDs = new event_emitter_1.AutoIncrementingID();
 InstanceTracker.bucket = new Map();
+InstanceTracker.loggers = ["log", "warn", "info", "error"];
 (() => {
-    const methods = ["log", "warn", "info", "error"];
-    methods.forEach((method) => {
+    _a.loggers.forEach(method => {
         const original = console[method];
         console[method] = function (...args) {
             InstanceTracker.clearAll();

package/dist/cjs/__tests__/ChalkAnimation.test.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ChalkAnimation_1 = require("../ChalkAnimation");
+const Effects_1 = require("../Effects");
+const InstanceTracker_1 = require("../InstanceTracker");
+const animations = [
+    "rainbow",
+    "pulse",
+    "glitch",
+    "radar",
+    "neon",
+    "karaoke",
+];
+describe("Chalk Animation", () => {
+    afterAll(() => {
+        jest.restoreAllMocks();
+    });
+    describe("Spawn", () => {
+        beforeAll(() => {
+            jest.spyOn(InstanceTracker_1.InstanceTracker, "LOG").mockImplementation(() => { });
+        });
+        afterEach(() => {
+            InstanceTracker_1.InstanceTracker.clearAll();
+            InstanceTracker_1.InstanceTracker.IDs.reset();
+        });
+        animations.forEach(name => {
+            it(`ChalkAnimation.${name} - returns an initialized animation instance`, () => {
+                const animation = ChalkAnimation_1.ChalkAnimation[name]("hello");
+                expect(animation.effect).toEqual(Effects_1.Effects[name]);
+                expect(typeof animation.ID).toEqual("string");
+                expect(animation.text).toEqual(["hello"]);
+                expect(animation.lines).toEqual(1);
+                expect(animation.speed).toEqual(1);
+                expect(animation.current).toEqual(1);
+                expect(animation.initialized).toEqual(true);
+                expect(animation.stopped).toEqual(false);
+                expect(animation.controller).not.toEqual(null);
+                expect(InstanceTracker_1.InstanceTracker.bucket.size).toEqual(1);
+                animation.stop();
+                expect(animation.stopped).toEqual(true);
+                expect(animation.controller).toEqual(null);
+            });
+            InstanceTracker_1.InstanceTracker.loggers.forEach(method => {
+                it(`ChalkAnimation.${name} - subsequent console.${method} stop the animation`, () => {
+                    const animation = ChalkAnimation_1.ChalkAnimation[name]("hello");
+                    expect(animation.stopped).toEqual(false);
+                    console[method]("");
+                    expect(animation.stopped).toEqual(true);
+                });
+            });
+            it(`ChalkAnimation.${name} - can be stopped and restarted`, () => {
+                const animation = ChalkAnimation_1.ChalkAnimation[name]("hello");
+                animation.stop();
+                expect(animation.stopped).toEqual(true);
+                animation.start();
+                expect(animation.current).toEqual(2);
+            });
+            it(`ChalkAnimation.${name} - can be manually rendered at a desired frame rate`, () => {
+                const animation = ChalkAnimation_1.ChalkAnimation[name]("hello").stop();
+                expect(animation.current).toEqual(1);
+                animation.render();
+                expect(animation.current).toEqual(2);
+                animation.render();
+                expect(animation.current).toEqual(3);
+            });
+            it(`ChalkAnimation.${name} - text can be replaced`, () => {
+                if (name === "radar") {
+                    return;
+                }
+                const animation = ChalkAnimation_1.ChalkAnimation[name]("Y Y Y").stop();
+                const f1 = animation.nextFrame();
+                animation.replace("Z Z Z");
+                const f2 = animation.nextFrame();
+                expect(f1.includes("Y")).toEqual(true);
+                expect(f1.includes("Z")).toEqual(false);
+                expect(f2.includes("Y")).toEqual(false);
+                expect(f2.includes("Z")).toEqual(true);
+            });
+            it(`ChalkAnimation.${name} - supports multiline strings`, () => {
+                const animation = ChalkAnimation_1.ChalkAnimation[name]("Lorem\nipsum\ndolor\nsit\namet").stop();
+                const frame = animation.nextFrame();
+                expect(animation.lines).toEqual(5);
+                expect(frame.split("\n")).toHaveLength(5);
+            });
+            it(`ChalkAnimation.${name} - supports 5K+ frames`, () => {
+                const animation = ChalkAnimation_1.ChalkAnimation[name]("Lorem\nipsum\ndolor\nsit\namet").stop();
+                for (let i = 0; i < 5000; i++) {
+                    expect(() => {
+                        animation.nextFrame();
+                    }).not.toThrow();
+                }
+            });
+        });
+    });
+});

package/dist/cjs/package.json

@@ -1,3 +1,3 @@
 {
-    "type": "commonjs"
-}
+  "type": "commonjs"
+}

package/dist/mjs/Animation.js

@@ -1,20 +1,16 @@
-import { InstanceTracker } from "./InstanceTracker";
-export class Animation extends InstanceTracker {
-    effect;
+import { FrameRate } from "./FrameRate.js";
+import { Decor } from "./Decor.js";
+export class Animation extends FrameRate {
     lines;
-    speed;
-    delay;
     text;
     stopped = false;
-    currentFrame = 0;
     initialized = false;
-    controller = null;
+    effect;
+    static LINE_BREAKS = /\r\n|\r|\n/;
     constructor(effect, str, delay = 0, speed = 0) {
-        super();
+        super(delay, speed);
         this.effect = effect;
-        this.speed = speed;
-        this.delay = delay;
-        this.text = str.split(/\r\n|\r|\n/);
+        this.text = str.split(Animation.LINE_BREAKS);
         this.lines = this.text.length;
     }
     render() {
@@ -22,40 +18,31 @@ export class Animation extends InstanceTracker {
             Animation.LOG("\n".repeat(this.lines - 1));
             this.initialized = true;
         }
-        Animation.LOG(this.frame());
-        this.controller = setTimeout(() => {
+        Animation.LOG(this.nextFrame());
+        this.schedule(() => {
             if (!this.stopped) {
                 this.render();
             }
-        }, this.delay / this.speed);
+        });
     }
-    frame() {
-        this.currentFrame++;
+    nextFrame() {
+        this.increment();
         return ("\u001B[" +
             `${this.lines}` +
             "F\u001B[G\u001B[2K" +
-            this.text.map((str) => this.effect(str, this.currentFrame)).join("\n"));
+            this.text.map(str => this.effect(str, this.current)).join("\n"));
     }
-    replace(str) {
-        this.text = str.split(/\r\n|\r|\n/);
+    replace = Decor.chainable(this, (str) => {
+        this.text = str.split(Animation.LINE_BREAKS);
         this.lines = this.text.length;
-        return this;
-    }
-    stop() {
+    });
+    stop = Decor.chainable(this, () => {
         this.clearFrames();
         this.stopped = true;
-        return this;
-    }
-    start() {
+    });
+    start = Decor.chainable(this, () => {
         this.clearFrames();
         this.stopped = false;
         this.render();
-        return this;
-    }
-    clearFrames() {
-        if (this.controller) {
-            clearTimeout(this.controller);
-            this.controller = null;
-        }
-    }
+    });
 }

package/dist/mjs/ChalkAnimation.js

@@ -1,26 +1,29 @@
-import { Effects } from "./Effects";
-import { Animation } from "./Animation";
-import { animateString } from "./animateString";
+import { Effects } from "./Effects.js";
+import { Animation } from "./Animation.js";
+/**
+ * Chalk Animation
+ *
+ * Console animations for your CLI tools
+ *
+ * ```typescript
+ * const animation = ChalkAnimation.rainbow("hello!");
+ * animation.stop();
+ * animation.start();
+ * ```
+ */
 export class ChalkAnimation {
-    static rainbow(str, speed = 1) {
-        return animateString(Effects.rainbow, str, 15, speed);
-    }
-    static pulse(str, speed = 1) {
-        return animateString(Effects.pulse, str, 16, speed);
-    }
-    static glitch(str, speed = 1) {
-        return animateString(Effects.glitch, str, 55, speed);
-    }
-    static radar(str, speed = 1) {
-        return animateString(Effects.radar, str, 50, speed);
-    }
-    static neon(str, speed = 1) {
-        return animateString(Effects.neon, str, 500, speed);
-    }
-    static karaoke(str, speed = 1) {
-        return animateString(Effects.karaoke, str, 50, speed);
-    }
-    static clearAllAnimations() {
-        return Animation.clearAll();
+    static neon = this.configure("neon", 500);
+    static radar = this.configure("radar", 50);
+    static pulse = this.configure("pulse", 16);
+    static glitch = this.configure("glitch", 55);
+    static rainbow = this.configure("rainbow", 15);
+    static karaoke = this.configure("karaoke", 50);
+    static configure(effect, delay) {
+        return (str, speed = 1) => {
+            if (!speed || speed <= 0) {
+                throw new Error("Expected `speed` to be an number greater than 0");
+            }
+            return new Animation(Effects[effect], str, delay, speed).start();
+        };
     }
 }

package/dist/mjs/Decor.js

@@ -0,0 +1,14 @@
+export class Decor {
+    static bound(target, _propertyKey, descriptor) {
+        const operation = descriptor.value;
+        if (operation) {
+            descriptor.value = operation.bind(target);
+        }
+    }
+    static chainable(instance, func) {
+        return (...params) => {
+            func(...params);
+            return instance;
+        };
+    }
+}

package/dist/mjs/Effects.js

@@ -1,5 +1,12 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 import chalk from "chalk";
 import gradient from "gradient-string";
+import { Decor } from "./Decor.js";
 export class Effects {
     static longHsv = { interpolation: "hsv", hsvSpin: "long" };
     static glitchChars = "x*0987654321[]0-~@#(____!!!!\\|?????....0000\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t";
@@ -7,7 +14,7 @@ export class Effects {
         const hue = 5 * frame;
         const leftColor = { h: hue % 360, s: 1, v: 1 };
         const rightColor = { h: (hue + 1) % 360, s: 1, v: 1 };
-        return gradient(leftColor, rightColor)(str, Effects.longHsv);
+        return gradient(leftColor, rightColor)(str, this.longHsv);
     }
     static pulse(str, frame) {
         frame = (frame % 120) + 1;
@@ -52,7 +59,7 @@ export class Effects {
             i += skip;
             if (str[i]) {
                 if (str[i] !== "\n" && str[i] !== "\r" && Math.random() > 0.995) {
-                    chunks.push(Effects.glitchChars[Math.floor(Math.random() * Effects.glitchChars.length)]);
+                    chunks.push(this.glitchChars[Math.floor(Math.random() * this.glitchChars.length)]);
                 }
                 else if (Math.random() > 0.005) {
                     chunks.push(str[i]);
@@ -100,3 +107,21 @@ export class Effects {
             chalk.white(str.substr(chars)));
     }
 }
+__decorate([
+    Decor.bound
+], Effects, "rainbow", null);
+__decorate([
+    Decor.bound
+], Effects, "pulse", null);
+__decorate([
+    Decor.bound
+], Effects, "glitch", null);
+__decorate([
+    Decor.bound
+], Effects, "radar", null);
+__decorate([
+    Decor.bound
+], Effects, "neon", null);
+__decorate([
+    Decor.bound
+], Effects, "karaoke", null);

package/dist/mjs/FrameRate.js

@@ -0,0 +1,24 @@
+import { InstanceTracker } from "./InstanceTracker.js";
+export class FrameRate extends InstanceTracker {
+    current = 0;
+    speed;
+    delay;
+    controller = null;
+    constructor(delay, speed) {
+        super();
+        this.delay = delay;
+        this.speed = speed;
+    }
+    schedule(func) {
+        this.controller = setTimeout(func, this.delay / this.speed);
+    }
+    increment() {
+        this.current++;
+    }
+    clearFrames() {
+        if (this.controller) {
+            clearTimeout(this.controller);
+            this.controller = null;
+        }
+    }
+}

package/dist/mjs/InstanceTracker.js

@@ -4,14 +4,14 @@ export class InstanceTracker {
     static LOG = console.log;
     static IDs = new AutoIncrementingID();
     static bucket = new Map();
+    static loggers = ["log", "warn", "info", "error"];
     constructor() {
         InstanceTracker.clearAll();
         this.ID = InstanceTracker.IDs.get();
         InstanceTracker.bucket.set(this.ID, this.instance);
     }
     static {
-        const methods = ["log", "warn", "info", "error"];
-        methods.forEach((method) => {
+        this.loggers.forEach(method => {
             const original = console[method];
             console[method] = function (...args) {
                 InstanceTracker.clearAll();