Merge pull request #321 from projectlint/master

Various improvements and clean-ups

Author: Daniil Ryazanov

.huskyrc

@@ -1,6 +1,6 @@
 {
     "hooks": {
-        "pre-commit": "yarn util:pre-commit",
-        "commit-msg": "yarn util:commit-msg"
+        "pre-commit": "npm run util:pre-commit",
+        "commit-msg": "npm run util:commit-msg"
     }
 }

package.json

@@ -31,13 +31,15 @@
         "url": "https://github.com/keindev/tasktree/issues"
     },
     "scripts": {
-        "prepare:clean": "rimraf lib coverage",
         "check:lint": "eslint src/**/*.ts --fix",
         "check:spell": "cspell -c .vscode/cspell.json --no-summary \"*.*\" \"**/*.ts\" \"**/*.js\"",
-        "check:test": "jest",
-        "build:ts": "tsc",
-        "build:ghinfo": "ghinfo generate -d media -t utils",
+        "check:test": "npm test",
         "build": "npm-run-all prepare:* check:* build:*",
+        "build:ghinfo": "ghinfo generate -d media -t utils",
+        "build:ts": "tsc",
+        "prepare": "tsc",
+        "prepare:clean": "rimraf lib coverage",
+        "test": "jest --coverage --notify",
         "util:changelog": "changelog generate",
         "util:commit-msg": "changelog lint --message HUSKY_GIT_PARAMS --lowercase-only",
         "util:pre-commit": "npm-run-all check:*"
@@ -46,33 +48,33 @@
         "node": ">=10.0.0"
     },
     "dependencies": {
-        "chalk": "^3.0.0",
+        "chalk": "^4.0.0",
         "color-convert": "^2.0.1",
         "elegant-spinner": "^2.0.0",
-        "figures": "^3.1.0",
+        "figures": "^3.2.0",
         "stdout-update": "^1.4.1"
     },
     "devDependencies": {
         "@types/color-convert": "^1.9.0",
-        "@types/jest": "^25.1.1",
-        "@types/node": "^13.5.2",
-        "@typescript-eslint/eslint-plugin": "^2.18.0",
-        "@typescript-eslint/parser": "^2.18.0",
+        "@types/jest": "^25.2.1",
+        "@types/node": "^13.13.4",
+        "@typescript-eslint/eslint-plugin": "^2.30.0",
+        "@typescript-eslint/parser": "^2.30.0",
         "changelog-guru": "^1.0.0",
-        "cspell": "^4.0.46",
+        "cspell": "^4.0.57",
         "eslint": "^6.8.0",
-        "eslint-config-airbnb-base": "^14.0.0",
-        "eslint-config-prettier": "^6.10.0",
-        "eslint-plugin-import": "^2.20.0",
-        "eslint-plugin-jest": "^23.6.0",
+        "eslint-config-airbnb-base": "^14.1.0",
+        "eslint-config-prettier": "^6.11.0",
+        "eslint-plugin-import": "^2.20.2",
+        "eslint-plugin-jest": "^23.8.2",
         "ghinfo": "^1.0.6",
-        "husky": "^4.2.1",
-        "jest": "^25.1.0",
+        "husky": "^4.2.5",
+        "jest": "^25.5.4",
         "npm-run-all": "^4.1.5",
-        "prettier": "^1.19.1",
-        "rimraf": "^3.0.1",
+        "prettier": "^2.0.5",
+        "rimraf": "^3.0.2",
         "strip-ansi": "^6.0.0",
-        "ts-jest": "^25.1.0",
-        "typescript": "^3.7.5"
+        "ts-jest": "^25.4.0",
+        "typescript": "^3.8.3"
     }
 }

src/ProgressBar.ts

@@ -192,7 +192,7 @@ export class ProgressBar {
             result = result.replace(`:${key}`, value);
         });
 
-        return this.badges ? Theme.join(Wrapper.SPACE, result, theme.badge(type)) : result;
+        return this.badges ? Theme.join(Wrapper.SPACE, result, theme.badge(theme.type2badge(type))) : result;
     }
 
     private getBlocks(theme: Theme, type: IndicationType, length: number): string {

src/Task.ts

@@ -10,6 +10,7 @@ export enum TaskStatus {
     Completed = 1,
     Failed = 2,
     Skipped = 3,
+    Warning = 4,
 }
 
 export interface ITaskOptions {
@@ -20,6 +21,7 @@ export interface ITaskOptions {
 export class Task {
     private uid: number;
     private text: string;
+    private badge = '';
     private status: TaskStatus;
     private autoClear: boolean;
     private bars: ProgressBar[] = [];
@@ -113,10 +115,10 @@ export class Task {
         this.bars = [];
     }
 
-    public complete(text?: string, clear = this.autoClear): Task {
+    public complete(text?: string, clear = this.autoClear, status = TaskStatus.Completed): Task {
         if (this.havePendingSubtasks()) this.fail('Subtasks is not complete.');
 
-        this.setStatus(TaskStatus.Completed, text, clear);
+        this.setStatus(status, text, clear);
         this.bars = this.bars.filter((bar): boolean => {
             bar.complete();
 
@@ -179,6 +181,16 @@ export class Task {
         return rows.map((row): string => theme.paint(row, type));
     }
 
+    public setBadge(badge: string): Task {
+        this.badge = badge;
+
+        return this;
+    }
+
+    public getBadge(): string {
+        return this.badge;
+    }
+
     private setStatus(status: TaskStatus, text?: string, clear?: boolean): void {
         if (this.isPending()) {
             if (text) this.text = text;

src/TaskTree.ts

@@ -25,15 +25,15 @@ export class TaskTree {
     private started = false;
     private offset = 0;
 
-    private constructor(theme?: ThemeOptions) {
+    private constructor(theme?: ThemeOptions, stdout?: NodeJS.WriteStream, stderr?: NodeJS.WriteStream) {
         this.tasks = [];
         this.theme = new Theme(theme);
-        this.manager = UpdateManager.getInstance();
+        this.manager = UpdateManager.getInstance(stdout, stderr);
     }
 
-    public static tree(theme?: ThemeOptions): TaskTree {
+    public static tree(theme?: ThemeOptions, stdout?: NodeJS.WriteStream, stderr?: NodeJS.WriteStream): TaskTree {
         if (!TaskTree.instance) {
-            TaskTree.instance = new TaskTree(theme);
+            TaskTree.instance = new TaskTree(theme, stdout, stderr);
         }
 
         return TaskTree.instance;

src/Theme.ts

@@ -39,7 +39,8 @@ export enum IndicationColor {
 
 export enum IndicationBadge {
     Default = '',
-    Error = '[fail]',
+    Error = '[error]',
+    Fail = '[fail]',
     Skip = '[skip]',
 }
 
@@ -109,6 +110,9 @@ export class Theme {
             case TaskStatus.Skipped:
                 type = IndicationType.Skip;
                 break;
+            case TaskStatus.Warning:
+                type = IndicationType.Warning;
+                break;
             case TaskStatus.Failed:
                 type = IndicationType.Error;
                 break;
@@ -204,28 +208,36 @@ export class Theme {
         return symbol ? this.paint(symbol, type) : symbol;
     }
 
-    public badge(type: IndicationType): string {
+    public type2badge(type: IndicationType): string {
         const { badges } = this;
         const badge = Theme.getValueBy(badges, type, (): string => {
             if (type === IndicationType.Error) return IndicationBadge.Error;
+            // if (type === IndicationType.Fail) return IndicationBadge.Fail;
             if (type === IndicationType.Skip) return IndicationBadge.Skip;
 
             return badges.get(IndicationType.Default) || IndicationBadge.Default;
         });
 
+        return badge;
+    }
+
+    public badge(badge: string): string {
         return badge ? this.paint(badge, IndicationType.Dim) : badge;
     }
 
     public title(task: Task, level: number): string {
         const type = Theme.type(task.getStatus(), task.haveSubtasks());
-        const badge = this.badge(type);
+        const badge = this.badge(task.getBadge() || this.type2badge(type));
         const symbol = this.symbol(type);
         let prefix = Wrapper.EMPTY;
 
         if (level)
             prefix = task.haveSubtasks() ? this.symbol(IndicationType.Subtask) : this.symbol(IndicationType.Default);
 
-        return Theme.indent(level, prefix, symbol, task.getText(), badge);
+        const text = (type === IndicationType.Error || type === IndicationType.Warning)
+            ? this.paint(task.getText(), type) : task.getText()
+
+        return Theme.indent(level, prefix, symbol, text, badge);
     }
 
     public errors(errors: string[], level: number): string[] {

src/__tests__/Theme.test.ts

@@ -18,9 +18,9 @@ describe('Theme', (): void => {
         expect(stripAnsi(theme.symbol(IndicationType.Skip))).toBe(stripAnsi(Figures.arrowDown));
         expect(stripAnsi(theme.symbol(IndicationType.Error))).toBe(stripAnsi(Figures.cross));
 
-        expect(theme.badge(IndicationType.Default)).toBe(IndicationBadge.Default);
-        expect(stripAnsi(theme.badge(IndicationType.Skip))).toBe(IndicationBadge.Skip);
-        expect(stripAnsi(theme.badge(IndicationType.Error))).toBe(IndicationBadge.Error);
+        expect(theme.badge(theme.type2badge(IndicationType.Default))).toBe(IndicationBadge.Default);
+        expect(stripAnsi(theme.badge(theme.type2badge(IndicationType.Skip)))).toBe(IndicationBadge.Skip);
+        expect(stripAnsi(theme.badge(theme.type2badge(IndicationType.Error)))).toBe(IndicationBadge.Error);
     });
 
     it('Custom', (): void => {
@@ -43,9 +43,9 @@ describe('Theme', (): void => {
         expect(stripAnsi(theme.symbol(IndicationType.Skip))).toBe(symbol);
         expect(stripAnsi(theme.symbol(IndicationType.Error))).toBe(symbol);
 
-        expect(theme.badge(IndicationType.Default)).toBe(IndicationBadge.Default);
-        expect(stripAnsi(theme.badge(IndicationType.Success))).toBe(badge);
-        expect(stripAnsi(theme.badge(IndicationType.Skip))).toBe(badge);
-        expect(stripAnsi(theme.badge(IndicationType.Error))).toBe(badge);
+        expect(theme.badge(theme.type2badge(IndicationType.Default))).toBe(IndicationBadge.Default);
+        expect(stripAnsi(theme.badge(theme.type2badge(IndicationType.Success)))).toBe(badge);
+        expect(stripAnsi(theme.badge(theme.type2badge(IndicationType.Skip)))).toBe(badge);
+        expect(stripAnsi(theme.badge(theme.type2badge(IndicationType.Error)))).toBe(badge);
     });
 });

src/__tests__/__snapshots__/ProgressBar.test.ts.snap

@@ -4,6 +4,6 @@ exports[`ProgressBar Default 1`] = `"******************** 100% 0.0s test"`;
 
 exports[`ProgressBar Statuses Complete 1`] = `"******************** 100% 0.0s :custom"`;
 
-exports[`ProgressBar Statuses Fail 1`] = `"**********__________ 50% 0.0s :custom [fail]"`;
+exports[`ProgressBar Statuses Fail 1`] = `"**********__________ 50% 0.0s :custom [error]"`;
 
 exports[`ProgressBar Statuses Skip 1`] = `"**********__________ 50% 0.0s :custom [skip]"`;