Add animated status bar creation method

* AnimatedStatusBarItem now implements vscode.StatusBarItem interface
* setAnimatedStatusBarMessage methods provides a simple way of creating an animated status message

Author: Kapil Borle

src/animatedStatusBar.ts

@@ -0,0 +1,115 @@
+import {
+    StatusBarItem,
+    StatusBarAlignment,
+    Disposable,
+    window} from "vscode";
+
+export function setAnimatedStatusBarMessage(text: string, hideWhenDone: Thenable<any>): Disposable {
+    let animatedStatusBarItem: AnimatedStatuBarItem = new AnimatedStatuBarItem(text);
+    animatedStatusBarItem.show(hideWhenDone);
+    return animatedStatusBarItem;
+}
+
+class AnimatedStatuBarItem implements StatusBarItem {
+    private statusBarItem: StatusBarItem;
+    private maxCount: number;
+    private counter: number;
+    private baseText: string;
+    private timerInterval: number;
+    private ticks: number;
+    private intervalId: NodeJS.Timer;
+
+    get alignment(): StatusBarAlignment {
+        return this.statusBarItem.alignment;
+    }
+
+    get priority(): number {
+        return this.statusBarItem.priority;
+    }
+
+    get text(): string {
+        return this.statusBarItem.text;
+    }
+
+    set text(value: string) {
+        this.statusBarItem.text = value;
+    }
+
+    get tooltip(): string {
+        return this.statusBarItem.tooltip;
+    }
+
+    set tooltip(value: string) {
+        this.statusBarItem.tooltip = value;
+    }
+
+    get color(): string {
+        return this.statusBarItem.color;
+    }
+
+    set color(value: string) {
+        this.statusBarItem.color = value;
+    }
+
+    get command(): string {
+        return this.statusBarItem.command;
+    }
+
+    set command(value: string) {
+        this.statusBarItem.command = value;
+    }
+
+    constructor(baseText: string, alignment?: StatusBarAlignment, priority?: number) {
+        this.statusBarItem = window.createStatusBarItem(alignment, priority);
+        this.baseText = baseText;
+        this.maxCount = 4;
+        this.counter = 0;
+        this.timerInterval = 300;
+        this.ticks = 0;
+    }
+
+    show(hideWhenDone?: Thenable<any>): void {
+        this.statusBarItem.show();
+        this._start();
+        if (hideWhenDone !== undefined) {
+            hideWhenDone.then(() => this.hide());
+        }
+    }
+
+    hide(): void {
+        this._stop();
+        this.statusBarItem.hide();
+    }
+
+    dispose(): void {
+        this.statusBarItem.dispose();
+    }
+
+    _updateCounter(): void {
+        this.counter = (this.counter + 1) % this.maxCount;
+        this.ticks = this.ticks + 1;
+    }
+
+    _updateText(): void {
+        this.text = this.baseText + ".".repeat(this.counter) + " ".repeat(this.maxCount - this.counter - 1);
+    }
+
+    _update(): void {
+        this._updateCounter();
+        this._updateText();
+    }
+
+    _reset(): void {
+        this.counter = 0;
+        this._updateText();
+    }
+
+    _start(): void {
+        this._reset();
+        this.intervalId = setInterval(() => this._update(), this.timerInterval);
+    }
+
+    _stop(): void {
+        clearInterval(this.intervalId);
+    }
+}

src/features/DocumentFormatter.ts

@@ -18,6 +18,7 @@ import Window = vscode.window;
 import { IFeature } from '../feature';
 import * as Settings from '../settings';
 import * as Utils from '../utils';
+import * as AnimatedStatusBar from '../animatedStatusBar';
 
 export namespace ScriptFileMarkersRequest {
     export const type: RequestType<any, any, void> = { get method(): string { return "powerShell/getScriptFileMarkers"; } };
@@ -80,66 +81,6 @@ function editComparer(leftOperand: ScriptRegion, rightOperand: ScriptRegion): nu
     }
 }
 
-class AnimatedStatuBarItem {
-    private statusBarItem: vscode.StatusBarItem;
-    private maxCount: number;
-    private counter: number;
-    private baseText: string;
-    private text: string;
-    private timerInterval: number;
-    private ticks: number;
-    private intervalId: NodeJS.Timer;
-
-    constructor() {
-        this.statusBarItem = Window.createStatusBarItem();
-        this.baseText = "formatting";
-        this.maxCount = 4;
-        this.counter = 0;
-        this.timerInterval = 300;
-        this.ticks = 0;
-    }
-
-    updateCounter() {
-        this.counter = (this.counter + 1) % this.maxCount;
-        this.ticks = this.ticks + 1;
-    }
-
-    updateText() {
-        this.text = this.baseText + ".".repeat(this.counter) + " ".repeat(this.maxCount - this.counter - 1);
-    }
-
-    update() {
-        this.updateCounter();
-        this.updateText();
-        this.statusBarItem.text = this.text;
-    }
-
-    reset() {
-        this.counter = 0;
-    }
-
-    start(hideWhenDone?: Thenable<any>) {
-        this.intervalId = setInterval(() => this.update(), this.timerInterval);
-        this.show();
-        if (hideWhenDone !== undefined) {
-            hideWhenDone.then(() => this.stop());
-        }
-    }
-
-    stop() {
-        clearInterval(this.intervalId);
-        this.hide();
-    }
-
-    show() {
-        this.statusBarItem.show();
-    }
-
-    hide() {
-        this.statusBarItem.hide();
-    }
-}
-
 class PSDocumentFormattingEditProvider implements DocumentFormattingEditProvider, DocumentRangeFormattingEditProvider {
     private languageClient: LanguageClient;
 
@@ -171,9 +112,8 @@ class PSDocumentFormattingEditProvider implements DocumentFormattingEditProvider
         options: FormattingOptions,
         token: CancellationToken): TextEdit[] | Thenable<TextEdit[]> {
 
-        let status: AnimatedStatuBarItem = new AnimatedStatuBarItem();
         let textEdits: Thenable<TextEdit[]> = this.executeRulesInOrder(document, range, options, 0);
-        status.start(textEdits);
+        AnimatedStatusBar.setAnimatedStatusBarMessage("formatting", textEdits);
         return textEdits;
     }