Merge pull request #219 from keindev/dev

build: release v3.0.0

Author: Daniil Ryazanov

.dependabot/config.yml

@@ -0,0 +1,10 @@
+version: 1
+update_configs:
+    - package_manager: 'javascript'
+      directory: '/'
+      update_schedule: 'daily'
+      target_branch: 'dev'
+      default_assignees:
+          - keindev
+      default_labels:
+          - dependencies

.eslintrc

@@ -5,9 +5,6 @@
         "commonjs": true
     },
     "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "project": "./tsconfig.eslint.json"
-    },
     "extends": [
         "airbnb-base",
         "plugin:@typescript-eslint/recommended",
@@ -18,23 +15,16 @@
     "plugins": ["@typescript-eslint", "jest"],
     "rules": {
         "@typescript-eslint/member-ordering": "error",
+        "@typescript-eslint/interface-name-prefix": ["error", { "prefixWithI": "always" }],
+        "max-lines-per-function": ["error", { "max": 40 }],
         "import/prefer-default-export": 0,
-        "max-len": [
-            "error",
-            {
-                "code": 120
-            }
-        ],
+        "import/extensions": 0,
+        "max-len": ["error", { "code": 120 }],
         "indent": ["error", 4, { "SwitchCase": 1 }],
         "lines-between-class-members": 0,
         "no-bitwise": 0,
         "no-plusplus": 0,
-        "no-underscore-dangle": [
-            "error",
-            {
-                "allowAfterThis": true
-            }
-        ],
+        "no-underscore-dangle": ["error", { "allowAfterThis": true }],
         "padding-line-between-statements": [
             "error",
             { "blankLine": "always", "prev": "*", "next": "return" },
@@ -44,11 +34,19 @@
             { "blankLine": "any", "prev": "if", "next": "if" }
         ]
     },
+    "overrides": [
+        {
+            "files": "*.test.ts",
+            "rules": {
+                "max-lines-per-function": ["error", { "max": 200 }]
+            }
+        }
+    ],
     "settings": {
         "import/resolver": {
             "node": {
-                "paths": ["src", "test"],
-                "extensions": [".js", ".jsx", ".ts", ".tsx"]
+                "paths": ["src"],
+                "extensions": [".ts", ".d.ts", ".js"]
             }
         }
     }

.ghinfo

@@ -0,0 +1,32 @@
+{
+    "name": "tasktree-cli",
+    "version": "3.0.0",
+    "description": "Simple terminal task tree - helps you keep track of your tasks in a tree structure.",
+    "keywords": [
+        "cli",
+        "task",
+        "tree",
+        "terminal",
+        "term",
+        "console",
+        "ascii",
+        "loading",
+        "indicator",
+        "progress",
+        "busy",
+        "wait",
+        "idle"
+    ],
+    "repo": "keindev/tasktree",
+    "type": "utils",
+    "links": {
+        "git": "https://github.com/keindev/tasktree",
+        "npm": "https://www.npmjs.com/package/tasktree-cli",
+        "homepage": "https://github.com/keindev/tasktree#readme"
+    },
+    "files": {
+        "demo": "media/demo.gif",
+        "logo": "media/logo.svg",
+        "social-preview": "media/social-preview.png"
+    }
+}

.huskyrc

@@ -1,6 +1,6 @@
 {
     "hooks": {
-        "pre-commit": "npm-run-all clean test",
-        "commit-msg": "changelog lint --message HUSKY_GIT_PARAMS --lowercase-only"
+        "pre-commit": "yarn util:pre-commit",
+        "commit-msg": "yarn util:commit-msg"
     }
 }

.npmignore

@@ -1,14 +1,14 @@
-# Src folders
-test/
+
+# folders
+**/__mocks__/**
+**/__tests__/**
+node_modules/
 coverage/
 media/
 src/
 docs/
 
-# Dependency directories
-node_modules/
-
-# Configs
+# configs
 .github
 .vscode
 .env
@@ -22,14 +22,16 @@ node_modules/
 .travis.yml
 .yarnclean
 .changelogrc.yml
+.ghinfo
+.dependabot
 jest.config.js
 tsconfig.json
 yarn.lock
 
-# Docs
+# docs
 README.md
 CHANGELOG.md
 CODE_OF_CONDUCT.md
 
-# Yarn logs
+# logs
 yarn-error.log

.travis.yml

@@ -1,11 +1,12 @@
 language: node_js
-sudo: false
 node_js:
     - 12
-    - 10
 os:
     - linux
     - osx
+    - windows
+env:
+    - YARN_GPG=no
 cache: yarn
 install: yarn
 script:
@@ -17,14 +18,15 @@ jobs:
     include:
         - stage: npm release
           if: tag IS present
-          node_js: 10
+          node_js: 12
           os: linux
           script: yarn build
           deploy:
               provider: npm
               email: $NPM_EMAIL
-              api_key: $NPM_TOKEN
-              skip_cleanup: true
+              api_token: $NPM_TOKEN
+              cleanup: false
+              edge: true
               on:
                   tags: true
 notifications:

example/app.js

@@ -1,4 +1,4 @@
-const { TaskTree } = require('../lib/tasktree');
+const { TaskTree } = require('../lib/TaskTree');
 const tree = TaskTree.tree();
 
 // start task tree log update in terminal

jest.config.js

@@ -3,4 +3,7 @@ module.exports = {
     testEnvironment: 'node',
     collectCoverage: true,
     coverageReporters: ['text-summary', 'json'],
+    testRegex: '(/__tests__/.*|(\\.|/)(test))\\.(tsx?)$',
+    moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+    testPathIgnorePatterns: ['/lib/', '/node_modules/'],
 };

media/demo.yml renamed to media/demo.config.yml

@@ -1,6 +1,6 @@
 {
     "name": "tasktree-cli",
-    "version": "2.0.2",
+    "version": "3.0.0",
     "description": "Simple terminal task tree - helps you keep track of your tasks in a tree structure.",
     "homepage": "https://github.com/keindev/tasktree#readme",
     "license": "MIT",
@@ -20,9 +20,9 @@
         "wait",
         "idle"
     ],
-    "main": "lib/tasktree.js",
-    "types": "lib/tasktree.d.ts",
-    "module": "lib/tasktree.js",
+    "main": "lib/TaskTree.js",
+    "types": "lib/TaskTree.d.ts",
+    "module": "lib/TaskTree.js",
     "repository": {
         "type": "git",
         "url": "https://github.com/keindev/tasktree.git"
@@ -31,44 +31,48 @@
         "url": "https://github.com/keindev/tasktree/issues"
     },
     "scripts": {
-        "clean": "rimraf rmdir lib coverage",
-        "lint": "eslint src/**/*.ts test/**/*.ts",
-        "spellcheck": "cspell -c .vscode/cspell.json --no-summary \"*.*\" \"docs/**/*\" \"**/*.ts\" \"**/*.js\"",
-        "test": "jest",
-        "changelog": "changelog generate",
+        "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": "npm-run-all clean spellcheck lint build:* test"
+        "build:ghinfo": "ghinfo generate -d media -t utils",
+        "build": "npm-run-all prepare:* check:* build:*",
+        "util:changelog": "changelog generate",
+        "util:commit-msg": "changelog lint --message HUSKY_GIT_PARAMS --lowercase-only",
+        "util:pre-commit": "npm-run-all check:*"
     },
     "engines": {
         "node": ">=10.0.0"
     },
     "dependencies": {
-        "chalk": "^2.4.2",
+        "chalk": "^3.0.0",
         "color-convert": "^2.0.1",
         "elegant-spinner": "^2.0.0",
-        "figures": "^3.0.0",
-        "stdout-update": "^1.3.7"
+        "figures": "^3.1.0",
+        "stdout-update": "^1.4.1"
     },
     "devDependencies": {
         "@types/color-convert": "^1.9.0",
-        "@types/jest": "^24.0.18",
-        "@types/node": "^12.7.4",
-        "@typescript-eslint/eslint-plugin": "^2.1.0",
-        "@typescript-eslint/parser": "^2.1.0",
+        "@types/jest": "^25.1.0",
+        "@types/node": "^13.5.1",
+        "@typescript-eslint/eslint-plugin": "^2.18.0",
+        "@typescript-eslint/parser": "^2.18.0",
         "changelog-guru": "^1.0.0",
-        "cspell": "^4.0.30",
-        "eslint": "^6.3.0",
+        "cspell": "^4.0.46",
+        "eslint": "^6.8.0",
         "eslint-config-airbnb-base": "^14.0.0",
-        "eslint-config-prettier": "^6.2.0",
-        "eslint-plugin-import": "^2.18.2",
-        "eslint-plugin-jest": "^22.17.0",
-        "husky": "^3.0.5",
-        "jest": "^24.9.0",
+        "eslint-config-prettier": "^6.10.0",
+        "eslint-plugin-import": "^2.20.0",
+        "eslint-plugin-jest": "^23.6.0",
+        "ghinfo": "^1.0.6",
+        "husky": "^4.2.1",
+        "jest": "^25.1.0",
         "npm-run-all": "^4.1.5",
-        "prettier": "^1.18.2",
-        "rimraf": "^3.0.0",
-        "strip-ansi": "^5.2.0",
-        "ts-jest": "^24.0.2",
-        "typescript": "^3.6.2"
+        "prettier": "^1.19.1",
+        "rimraf": "^3.0.1",
+        "strip-ansi": "^6.0.0",
+        "ts-jest": "^25.0.0",
+        "typescript": "^3.7.5"
     }
 }

media/social-preview.png

@@ -1,7 +1,7 @@
 import { Wrapper } from 'stdout-update/lib/wrapper';
 import * as Figures from 'figures';
-import { Theme, IndicationType } from './theme';
-import { TaskStatus } from './task';
+import { Theme, IndicationType } from './Theme';
+import { TaskStatus } from './Task';
 
 export enum Progress {
     Default = -1,
@@ -26,7 +26,7 @@ export enum TemplateToken {
     Rate = ':rate',
 }
 
-export interface ProgressBarOptions {
+export interface IProgressBarOptions {
     // current completed index
     current?: number;
     // total number of ticks to complete
@@ -45,7 +45,7 @@ export interface ProgressBarOptions {
     gradient?: boolean;
 }
 
-export interface ProgressBarToken {
+export interface IProgressBarToken {
     [key: string]: string;
 }
 
@@ -74,7 +74,7 @@ export class ProgressBar {
     private status = TaskStatus.Pending;
     private tokens: Map<TemplateToken | string, string> = new Map();
 
-    public constructor(template?: string, options?: ProgressBarOptions) {
+    public constructor(template?: string, options?: IProgressBarOptions) {
         this.template =
             template ||
             Theme.join(
@@ -130,7 +130,7 @@ export class ProgressBar {
         return this.current >= this.total || !!this.end;
     }
 
-    public tick(step?: number, tokens?: ProgressBarToken): ProgressBar {
+    public tick(step?: number, tokens?: IProgressBarToken): ProgressBar {
         this.current = Math.min(this.total, this.current + (step || ProgressBar.TICK));
         this.tokens = typeof tokens === 'object' ? new Map(Object.entries(tokens)) : new Map();
 
@@ -162,17 +162,6 @@ export class ProgressBar {
     public render(theme: Theme): string {
         const length = Math.round(this.width * this.getRatio());
         const type = Theme.type(this.status);
-        let blocks = Wrapper.EMPTY.padStart(length, this.completeBlock);
-
-        if (!this.isCompleted() && this.gradient) {
-            blocks = theme.gradient(blocks, {
-                position: this.getRatio(),
-                begin: Theme.type(this.status),
-                end: IndicationType.Success,
-            });
-        } else {
-            blocks = theme.paint(blocks, type);
-        }
 
         let result = this.template
             .replace(TemplateToken.Current, this.current.toString())
@@ -191,7 +180,7 @@ export class ProgressBar {
                 TemplateToken.Bar,
                 Theme.join(
                     Wrapper.EMPTY,
-                    blocks,
+                    this.getBlocks(theme, type, length),
                     theme.paint(
                         Wrapper.EMPTY.padStart(this.width - length, this.incompleteBlock),
                         IndicationType.Subtask
@@ -205,4 +194,20 @@ export class ProgressBar {
 
         return this.badges ? Theme.join(Wrapper.SPACE, result, theme.badge(type)) : result;
     }
+
+    private getBlocks(theme: Theme, type: IndicationType, length: number): string {
+        let blocks = Wrapper.EMPTY.padStart(length, this.completeBlock);
+
+        if (!this.isCompleted() && this.gradient) {
+            blocks = theme.gradient(blocks, {
+                position: this.getRatio(),
+                begin: Theme.type(this.status),
+                end: IndicationType.Success,
+            });
+        } else {
+            blocks = theme.paint(blocks, type);
+        }
+
+        return blocks;
+    }
 }