message-await 1.0.0 → 2.0.0

package/.github/workflows/build.yml

@@ -13,10 +13,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
-        node-version: 14.x
+        node-version: 20.x
     - run: npm ci
     - run: npm run verify-release

package/.github/workflows/release.yml

@@ -6,12 +6,12 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     # Setup .npmrc file to publish to npm
-    - uses: actions/setup-node@v2
+    - uses: actions/setup-node@v4
       with:
-        node-version: 14.x
+        node-version: 20.x
     - run: npm ci
-    - uses: JS-DevTools/npm-publish@v1
+    - uses: JS-DevTools/npm-publish@v3
       with:
         token: ${{ secrets.NPM_TOKEN }}

package/eslint.config.js

@@ -0,0 +1,26 @@
+import typescriptParser from '@typescript-eslint/parser';
+import typescriptPlugin from '@typescript-eslint/eslint-plugin';
+import prettierPlugin from 'eslint-plugin-prettier';
+
+export default [
+    {
+        ignores: ['dist/'],
+    },
+    {
+        languageOptions: {
+            parser: typescriptParser,
+            parserOptions: {
+                ecmaVersion: 2020,
+                sourceType: 'module',
+            },
+        },
+        plugins: {
+            '@typescript-eslint': typescriptPlugin,
+            prettier: prettierPlugin,
+        },
+        rules: {
+            'prettier/prettier': ['error', { endOfLine: 'auto', tabWidth: 4, singleQuote: true, printWidth: 120 }],
+        },
+        files: ['**/*.ts', '**/*.js'],
+    },
+];

package/package.json

@@ -1,45 +1,50 @@
 {
-    "name": "message-await",
-    "version": "1.0.0",
-    "description": "A utility to print message with an async success or failure in node.js",
-    "main": "dist/src/index.js",
-    "scripts": {
-        "clean": "rimraf dist",
-        "build": "tsc",
-        "build:watch": "tsc --watch",
-        "lint": "eslint . --ext .ts,.d.ts,.js",
-        "lint:fix": "eslint . --ext .ts,.d.ts,.js --fix",
-        "verify-release": "concurrently npm:lint npm:build",
-        "prepublishOnly": "npm run clean && npm run verify-release"
-    },
-    "keywords": [
-        "async",
-        "node",
-        "await",
-        "print",
-        "message"
-    ],
-    "author": "Giles Roadnight",
-    "license": "ISC",
-    "dependencies": {
-        "cli-cursor": "^3.1.0",
-        "log-symbols": "^4.1.0"
-    },
-    "devDependencies": {
-        "@types/node": "^14.17.9",
-        "@typescript-eslint/eslint-plugin": "^4.29.0",
-        "@typescript-eslint/parser": "^4.29.0",
-        "chalk": "^4.1.2",
-        "concurrently": "^6.2.0",
-        "eslint": "^7.32.0",
-        "eslint-config-prettier": "^7.2.0",
-        "eslint-config-standard": "^16.0.3",
-        "eslint-plugin-import": "^2.23.4",
-        "eslint-plugin-node": "^11.1.0",
-        "eslint-plugin-prettier": "^3.4.0",
-        "eslint-plugin-promise": "^4.3.1",
-        "prettier": "^2.3.2",
-        "rimraf": "^3.0.2",
-        "typescript": "^4.3.5"
-    }
+	"name": "message-await",
+	"version": "2.0.0",
+	"description": "A utility to print message with an async success or failure in node.js",
+	"main": "dist/src/index.js",
+	"scripts": {
+		"clean": "rimraf dist",
+		"build": "tsc",
+		"build:watch": "tsc --watch",
+		"lint": "eslint .",
+		"lint:fix": "eslint . --fix",
+		"verify-release": "concurrently npm:lint npm:build",
+		"prepublishOnly": "npm run clean && npm run verify-release"
+	},
+	"keywords": [
+		"async",
+		"node",
+		"await",
+		"print",
+		"message"
+	],
+	"author": "Giles Roadnight",
+	"license": "ISC",
+	"dependencies": {
+		"cli-cursor": "^3.1.0",
+		"log-symbols": "^4.1.0"
+	},
+	"devDependencies": {
+		"@types/node": "^14.17.9",
+		"@typescript-eslint/eslint-plugin": "^8.57.0",
+		"@typescript-eslint/parser": "^8.57.0",
+		"chalk": "^4.1.2",
+		"concurrently": "^9.2.1",
+		"eslint": "^10.0.3",
+		"eslint-plugin-prettier": "^5.5.5",
+		"prettier": "^3.0.0",
+		"rimraf": "^6.1.3",
+		"typescript": "^4.3.5"
+	},
+	"types": "./dist/src/index.d.ts",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Roaders/message-await.git"
+	},
+	"bugs": {
+		"url": "https://github.com/Roaders/message-await/issues"
+	},
+	"homepage": "https://github.com/Roaders/message-await#readme",
+	"type": "module"
 }

package/tsconfig.json

@@ -1,72 +1,13 @@
 {
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    /* Basic Options */
-    // "incremental": true,                         /* Enable incremental compilation */
-    "target": "es5",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */
-    "module": "commonjs",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    // "lib": [],                                   /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                             /* Allow javascript files to be compiled. */
-    // "checkJs": true,                             /* Report errors in .js files. */
-    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
-    "declaration": true,                            /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
-    // "outFile": "./",                             /* Concatenate and emit output to single file. */
-     "outDir": "./dist",                            /* Redirect output structure to the directory. */
-    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                           /* Enable project compilation */
-    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
-    // "removeComments": true,                      /* Do not emit comments to output. */
-    // "noEmit": true,                              /* Do not emit outputs. */
-    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                                 /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,                    /* Enable strict null checks. */
-    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
-    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
-    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
-    // "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
-    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                             /* List of folders to include type definitions from. */
-    // "types": [],                                 /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
-
-    /* Advanced Options */
-    "skipLibCheck": true,                           /* Skip type checking of declaration files. */
-    "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */
-  }
-}
+	"compilerOptions": {
+		"target": "es5",
+		"module": "nodenext",
+		"declaration": true,
+		"outDir": "./dist",
+		"strict": true,
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"forceConsistentCasingInFileNames": true,
+		"moduleResolution": "nodenext"
+	}
+}

package/.eslintrc.js

@@ -1,32 +0,0 @@
-module.exports = {
-    env: {
-        browser: true,
-        node: true,
-    },
-    extends: [
-        'eslint:recommended',
-        'plugin:@typescript-eslint/eslint-recommended',
-        'plugin:@typescript-eslint/recommended',
-        'prettier',
-        'prettier/@typescript-eslint',
-        'plugin:prettier/recommended',
-    ],
-    parser: '@typescript-eslint/parser',
-    parserOptions: {
-        ecmaVersion: 11,
-        sourceType: 'module',
-    },
-    plugins: ['@typescript-eslint'],
-    ignorePatterns: ['dist/'],
-    rules: {
-        'prettier/prettier': ['error', { endOfLine: 'auto', tabWidth: 4, singleQuote: true, printWidth: 120 }],
-    },
-    overrides: [
-        {
-            files: ['*.js'],
-            rules: {
-                '@typescript-eslint/no-var-requires': 'off',
-            },
-        },
-    ],
-};

package/dist/src/constants.d.ts

@@ -1,2 +0,0 @@
-import { MessageAwaitOptions } from './contracts';
-export declare const defaultOptions: MessageAwaitOptions;

package/dist/src/constants.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultOptions = void 0;
-exports.defaultOptions = {
-    spinner: false,
-    format: function (value) { return value; },
-    hideCursor: true,
-};

package/dist/src/contracts.d.ts

@@ -1,58 +0,0 @@
-export declare type MessageAwaitOptions = {
-    /**
-     * Display an animated ellipses (...) at the end of the message
-     * Defaults to false
-     */
-    spinner: boolean;
-    /**
-     * An optional function to format the message. for example: chalk.blue
-     */
-    format: (message: string) => string;
-    /**
-     * If true hides the cursor whilst the message is displayed to avoid flickering.
-     * Defaults to true.
-     */
-    hideCursor: boolean;
-};
-export interface UpdateMessage {
-    /**
-     * marks the message as complete.
-     * @param success - defaults to true. Adds a tick or a cross to the message
-     * @param updateMessage - optionally updates the displayed message
-     */
-    complete: (success?: boolean, updateMessage?: string) => void;
-    /**
-     * Marks the message as complete with a tick.
-     * Optionally update the displayed message
-     */
-    success: (updateMessage?: string) => void;
-    /**
-     * Marks the message as failed with a cross.
-     * Optionally update the displayed message
-     */
-    fail: (updateMessage?: string) => void;
-    /**
-     * logs a message whilst waiting for the main message to complete pass any number of items to be logged using console.log
-     */
-    log: (message: string, ...optional: unknown[]) => void;
-    /**
-     * Updates the message. For example could display progress: updateMessage(`Loaded 3/4`);
-     * Optionally start or stop the spinner.
-     */
-    updateMessage: (message: string, spinner?: boolean) => void;
-    /**
-     * gets the currently displayed message
-     */
-    getMessage: () => string;
-}
-export interface MessageAwait extends UpdateMessage {
-    /**
-     * awaits the completion of a promise and marks the message as success or failure based on the promise
-     * @param promise
-     * @param exitProcess - if the promise is rejected exits the node process. Defaults to false
-     * @param printError - if the promise is rejected prints the error that is returned. Defaults to false
-     * @param updateSuccessMessage - optional. update the message on success
-     * @param updateFailureMessage - optional. update the message on rejection
-     */
-    await: <T>(promise: Promise<T> | ((updateMessage: UpdateMessage) => Promise<T>), exitProcess?: boolean, printError?: boolean, updateSuccessMessage?: string | ((result: T) => string), updateFailureMessage?: string | ((error: unknown) => string)) => Promise<T>;
-}

package/dist/src/contracts.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/index.d.ts

@@ -1,9 +0,0 @@
-import { MessageAwait, MessageAwaitOptions } from './contracts';
-export * from './contracts';
-/**
- * prints the initial message
- * @param message - message to display
- * @param options - MessageAwaitOptions
- * @returns MessageAwait - options to complete the message when done or update the message with progress info
- */
-export default function print(message: string, options?: Partial<MessageAwaitOptions>): MessageAwait;

package/dist/src/index.js

@@ -1,171 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var readline_1 = require("readline");
-var cli_cursor_1 = require("cli-cursor");
-var constants_1 = require("./constants");
-__exportStar(require("./contracts"), exports);
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-var logSymbols = require('log-symbols');
-/**
- * prints the initial message
- * @param message - message to display
- * @param options - MessageAwaitOptions
- * @returns MessageAwait - options to complete the message when done or update the message with progress info
- */
-function print(message, options) {
-    var requiredOptions = __assign(__assign({}, constants_1.defaultOptions), options);
-    var timeout;
-    var isComplete = false;
-    var dotCount = 3;
-    function generateMessage() {
-        var dots = Array.from({ length: dotCount })
-            .map(function () { return '.'; })
-            .join('');
-        while (dots.length < 3) {
-            dots = dots + ' ';
-        }
-        return requiredOptions.format(message + dots);
-    }
-    function resetCursor() {
-        (0, readline_1.cursorTo)(process.stdout, 0);
-        (0, readline_1.clearLine)(process.stdout, 1);
-    }
-    function writeMessage() {
-        resetCursor();
-        process.stdout.write(generateMessage());
-    }
-    function startTimer() {
-        dotCount = 0;
-        writeMessage();
-        timeout = setInterval(function () {
-            switch (dotCount) {
-                case 3:
-                    dotCount = 0;
-                    writeMessage();
-                    break;
-                default:
-                    dotCount++;
-                    writeMessage();
-            }
-        }, 300).unref();
-    }
-    function updateMessage(messageUpdate, spinner) {
-        if (isComplete) {
-            throw new Error("Progress Message is complete");
-        }
-        if (spinner === true && timeout == null) {
-            startTimer();
-        }
-        else if (spinner === false && timeout != null) {
-            dotCount = 0;
-            clearInterval(timeout);
-            timeout = undefined;
-        }
-        message = messageUpdate;
-        writeMessage();
-    }
-    function log(logMessage) {
-        var optional = [];
-        for (var _i = 1; _i < arguments.length; _i++) {
-            optional[_i - 1] = arguments[_i];
-        }
-        if (isComplete) {
-            throw new Error("Progress Message is complete");
-        }
-        resetCursor();
-        console.log.apply(console, __spreadArray([logMessage], optional, false));
-        writeMessage();
-    }
-    function complete(success, updateMessage) {
-        if (success === void 0) { success = true; }
-        isComplete = true;
-        if (timeout != null) {
-            clearInterval(timeout);
-        }
-        dotCount = 3;
-        resetCursor();
-        message = updateMessage || message;
-        if (success) {
-            console.log("".concat(generateMessage(), " ").concat(logSymbols.success));
-        }
-        else {
-            console.log("".concat(generateMessage(), " ").concat(logSymbols.error));
-        }
-        if (requiredOptions.hideCursor) {
-            (0, cli_cursor_1.show)();
-        }
-    }
-    function success(updateMessage) {
-        return complete(true, updateMessage);
-    }
-    function fail(updateMessage) {
-        return complete(false, updateMessage);
-    }
-    function getMessage() {
-        return message;
-    }
-    function await(promise, exitProcess, printError, updateSuccessMessage, updateFailureMessage) {
-        return (typeof promise === 'function'
-            ? promise({ complete: complete, log: log, updateMessage: updateMessage, getMessage: getMessage, success: success, fail: fail })
-            : promise)
-            .then(function (value) {
-            complete(true, typeof updateSuccessMessage === 'function' ? updateSuccessMessage(value) : updateSuccessMessage);
-            return value;
-        })
-            .catch(function (err) {
-            complete(false, typeof updateFailureMessage === 'function' ? updateFailureMessage(err) : updateFailureMessage);
-            if (printError) {
-                console.error(err);
-            }
-            if (exitProcess) {
-                process.exit();
-            }
-            return Promise.reject(err);
-        });
-    }
-    if (requiredOptions.hideCursor) {
-        (0, cli_cursor_1.hide)();
-    }
-    if (requiredOptions.spinner) {
-        startTimer();
-    }
-    else {
-        writeMessage();
-    }
-    return { complete: complete, log: log, updateMessage: updateMessage, getMessage: getMessage, success: success, fail: fail, await: await };
-}
-exports.default = print;