@supertape/formatter-time 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) coderaiser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,31 @@
+# @supertape/formatter-time [![NPM version][NPMIMGURL]][NPMURL]
+
+[NPMIMGURL]: https://img.shields.io/npm/v/@supertape/formatter-time.svg?style=flat&longCache=true
+[NPMURL]: https://npmjs.org/package/@supertape/formatter-time "npm"
+
+📼[`Supertape`](https://github.com/coderaiser/supertape) formatter shows progress bar.
+
+## Install
+
+```
+npm i supertape @supertape/formatter-time
+```
+
+## Usage
+
+```
+supertape --format time lib
+```
+
+## Env Variables
+
+- `CI=1` - disable progress bar
+- `SUPERTAPE_TIME=1` - force enable/disable progress bar;
+- `SUPERTAPE_TIME_COLOR` - set color of progress bar;
+- `SUPERTAPE_TIME_MIN=100` - count of tests to show progress bar;
+- `SUPERTAPE_TIME_STACK=1` - force show/hide stack on fail;
+- `SUPERTAPE_TIME_CLOCK=⏳` - set clock icon;
+
+## License
+
+MIT

package/lib/time.js

@@ -0,0 +1,236 @@
+import {Writable} from 'node:stream';
+import cliProgress from 'cli-progress';
+import chalk from 'chalk';
+import fullstore from 'fullstore';
+import {isCI} from 'ci-info';
+import process from 'node:process';
+import {Timer} from 'timer-node';
+
+global._isCI = isCI;
+
+const OK = '👌';
+const YELLOW = '#218bff';
+
+const {red} = chalk;
+const formatErrorsCount = (a) => a ? red(a) : OK;
+
+const isStr = (a) => typeof a === 'string';
+
+const {stderr} = process;
+
+let SUPERTAPE_TIME;
+let SUPERTAPE_TIME_MIN = 100;
+let SUPERTAPE_TIME_COLOR;
+let SUPERTAPE_TIME_STACK = 1;
+let SUPERTAPE_TIME_CLOCK = '⏳';
+
+export function createFormatter(bar) {
+    ({
+        SUPERTAPE_TIME,
+        SUPERTAPE_TIME_MIN = 100,
+        SUPERTAPE_TIME_COLOR,
+        SUPERTAPE_TIME_STACK = 1,
+        SUPERTAPE_TIME_CLOCK = '⏳',
+    } = process.env);
+    
+    const out = createOutput();
+    const store = fullstore();
+    const barStore = fullstore(bar);
+    const timerStore = fullstore();
+    
+    return {
+        start: start({
+            barStore,
+            timerStore,
+            out,
+        }),
+        test: test({
+            store,
+        }),
+        testEnd: testEnd({
+            clock: SUPERTAPE_TIME_CLOCK,
+            barStore,
+            timerStore,
+        }),
+        fail: fail({
+            out,
+            store,
+        }),
+        end: end({
+            barStore,
+            out,
+        }),
+    };
+}
+
+export const start = ({barStore, timerStore, out}) => ({total}) => {
+    out('TAP version 13');
+    
+    const color = SUPERTAPE_TIME_COLOR || YELLOW;
+    const {bar, timer} = _createProgress({
+        total,
+        color,
+        test: '',
+    });
+    
+    barStore(bar);
+    timerStore(timer);
+};
+
+export const test = ({store}) => ({test}) => {
+    store(`# ${test}`);
+};
+
+export const testEnd = ({barStore, clock, timerStore}) => ({count, total, failed, test}) => {
+    const timer = timerStore();
+    
+    barStore().increment({
+        count,
+        total,
+        test,
+        failed: formatErrorsCount(failed),
+        time: !timer ? '' : getTime({
+            clock,
+            timer: timerStore(),
+        }),
+    });
+};
+
+export const fail = ({out, store}) => ({at, count, message, operator, result, expected, output, errorStack}) => {
+    out('');
+    out(store());
+    out(`❌ not ok ${count} ${message}`);
+    out('  ---');
+    out(`    operator: ${operator}`);
+    
+    if (output)
+        out(output);
+    
+    if (!isStr(output)) {
+        out('    expected: |-');
+        out(`      ${expected}`);
+        out('    result: |-');
+        out(`      ${result}`);
+    }
+    
+    out(`    ${at}`);
+    
+    if (SUPERTAPE_TIME_STACK !== '0') {
+        out('    stack: |-');
+        out(errorStack);
+    }
+    
+    out('  ...');
+    out('');
+};
+
+export const end = ({barStore, out}) => ({count, passed, failed, skiped}) => {
+    barStore().stop();
+    
+    out('');
+    
+    out(`1..${count}`);
+    out(`# tests ${count}`);
+    out(`# pass ${passed}`);
+    
+    if (skiped)
+        out(`# ⚠️  skip ${skiped}`);
+    
+    out('');
+    
+    if (failed)
+        out(`# ❌ fail ${failed}`);
+    
+    if (!failed)
+        out('# ✅ ok');
+    
+    out('');
+    out('');
+    
+    return `\r${out()}`;
+};
+
+function createOutput() {
+    let output = [];
+    
+    return (...args) => {
+        const [line] = args;
+        
+        if (!args.length) {
+            const result = output.join('\n');
+            
+            output = [];
+            
+            return result;
+        }
+        
+        output.push(line);
+    };
+}
+
+const getColorFn = (color) => {
+    if (color.startsWith('#'))
+        return chalk.hex(color);
+    
+    return chalk[color];
+};
+
+const defaultStreamOptions = {
+    total: Infinity,
+};
+
+const getStream = ({total} = defaultStreamOptions) => {
+    const is = total >= SUPERTAPE_TIME_MIN;
+    
+    if (is && !global._isCI || SUPERTAPE_TIME === '1')
+        return stderr;
+    
+    return new Writable();
+};
+
+export const _getStream = getStream;
+
+function _createProgress({total, color, test}) {
+    const timer = new Timer({
+        label: 'supertape-timer',
+    });
+    
+    const colorFn = getColorFn(color);
+    const bar = new cliProgress.SingleBar({
+        format: `${colorFn('{bar}')} {percentage}% | {failed} | {count}/{total} | {time} | {test}`,
+        barCompleteChar: '\u2588',
+        barIncompleteChar: '\u2591',
+        clearOnComplete: true,
+        stopOnComplete: true,
+        hideCursor: true,
+        stream: getStream({
+            total,
+        }),
+    }, cliProgress.Presets.react);
+    
+    bar.start(total, 0, {
+        test,
+        total,
+        count: 0,
+        failed: OK,
+        time: getTime({
+            clock: SUPERTAPE_TIME_CLOCK,
+            timer,
+        }),
+    });
+    
+    return {
+        bar,
+        timer,
+    };
+}
+
+export const maybeZero = (a) => a <= 9 ? '0' : '';
+
+function getTime({clock, timer}) {
+    const {m, s} = timer.time();
+    const minute = `${maybeZero(m)}${m}`;
+    const second = `${maybeZero(s)}${s}`;
+    
+    return `${clock} ${minute}:${second}`;
+}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@supertape/formatter-time",
+  "version": "1.0.0",
+  "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
+  "description": "📼 Supertape formatter progress bar",
+  "homepage": "http://github.com/coderaiser/supertape",
+  "main": "./lib/time.js",
+  "release": false,
+  "tag": false,
+  "changelog": false,
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/coderaiser/supertape.git"
+  },
+  "scripts": {
+    "test": "madrun test",
+    "watch:test": "madrun watch:test",
+    "lint": "madrun lint",
+    "fix:lint": "madrun fix:lint",
+    "coverage": "madrun coverage",
+    "report": "madrun report",
+    "wisdom": "madrun wisdom"
+  },
+  "dependencies": {
+    "chalk": "^4.1.0",
+    "ci-info": "^4.0.0",
+    "cli-progress": "^3.8.2",
+    "fullstore": "^3.0.0",
+    "once": "^1.4.0",
+    "timer-node": "^5.0.7"
+  },
+  "keywords": [
+    "formatter",
+    "time",
+    "supertape"
+  ],
+  "devDependencies": {
+    "c8": "^8.0.0",
+    "eslint": "^8.0.0-beta.0",
+    "eslint-plugin-n": "^16.0.1",
+    "eslint-plugin-putout": "^22.0.0",
+    "madrun": "^10.0.0",
+    "montag": "^1.0.0",
+    "nodemon": "^3.0.1",
+    "pullout": "^4.0.0",
+    "putout": "^34.0.0",
+    "supertape": "^9.0.0"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}