@node-cli/timer 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Arno Versini
+
+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,35 @@
+# Node CLI timer package
+
+![npm](https://img.shields.io/npm/v/@node-cli/timer?label=version&logo=npm)
+
+> Timer is a dead simple command line tool to display the remaining time for a given duration.
+
+## Installation
+
+```sh
+> npm install --global @node-cli/timer
+```
+
+## Examples
+
+Start a timer for 4 hours, 2 minutes and 15 seconds
+
+```sh
+> timer 4h2m15s
+```
+
+Start a timer for 1 minute and 42 seconds
+
+```sh
+> timer 1m42s
+```
+
+Get help
+
+```sh
+> search --help
+```
+
+## License
+
+MIT © Arno Versini

package/dist/defaults.d.ts

@@ -0,0 +1,4 @@
+export declare const defaultFlags: {
+    boring: boolean;
+    notification: boolean;
+};

package/dist/defaults.js

@@ -0,0 +1,6 @@
+/* istanbul ignore file */ export const defaultFlags = {
+    boring: false,
+    notification: true
+};
+
+//# sourceMappingURL=defaults.js.map

package/dist/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/defaults.ts"],"sourcesContent":["/* istanbul ignore file */\nexport const defaultFlags = {\n\tboring: false,\n\tnotification: true,\n};\n"],"names":["defaultFlags","boring","notification"],"mappings":"AAAA,wBAAwB,GACxB,OAAO,MAAMA,eAAe;IAC3BC,QAAQ;IACRC,cAAc;AACf,EAAE"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+
+export * from "./defaults";
+export * from "./parse";
+export * from "./timer";
+export * from "./utilities";

package/dist/parse.d.ts

@@ -0,0 +1,9 @@
+export type Parameters = {
+    ["0"]?: string;
+};
+export type Configuration = {
+    flags?: any;
+    parameters?: Parameters;
+    showHelp?: () => void;
+};
+export declare const config: Configuration;

package/dist/parse.js

@@ -0,0 +1,47 @@
+import { defaultFlags } from "./defaults.js";
+import { parser } from "@node-cli/parser";
+/* istanbul ignore next */ export const config = parser({
+    meta: import.meta,
+    examples: [
+        {
+            command: "timer 4h2m15s",
+            comment: "## Start a timer for 4 hours, 2 minutes and 15 seconds"
+        },
+        {
+            command: "timer 1m42s",
+            comment: "## Start a timer for 1 minute and 42 seconds"
+        }
+    ],
+    flags: {
+        boring: {
+            shortFlag: "b",
+            default: defaultFlags.boring,
+            description: "Do not use color output",
+            type: "boolean"
+        },
+        help: {
+            shortFlag: "h",
+            description: "Display help instructions",
+            type: "boolean"
+        },
+        notification: {
+            shortFlag: "n",
+            default: defaultFlags.notification,
+            description: "Display a notification when the timer is done",
+            type: "boolean"
+        },
+        version: {
+            shortFlag: "v",
+            description: "Output the current version",
+            type: "boolean"
+        }
+    },
+    parameters: {
+        formattedTime: {
+            description: "Formatted time to start the timer"
+        }
+    },
+    usage: "timer [formattedTime]"
+});
+
+//# sourceMappingURL=parse.js.map

package/dist/parse.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/parse.ts"],"sourcesContent":["import { defaultFlags } from \"./defaults.js\";\nimport { parser } from \"@node-cli/parser\";\n\nexport type Parameters = {\n\t[\"0\"]?: string;\n};\nexport type Configuration = {\n\tflags?: any;\n\tparameters?: Parameters;\n\tshowHelp?: () => void;\n};\n\n/* istanbul ignore next */\nexport const config: Configuration = parser({\n\tmeta: import.meta,\n\texamples: [\n\t\t{\n\t\t\tcommand: \"timer 4h2m15s\",\n\t\t\tcomment: \"## Start a timer for 4 hours, 2 minutes and 15 seconds\",\n\t\t},\n\t\t{\n\t\t\tcommand: \"timer 1m42s\",\n\t\t\tcomment: \"## Start a timer for 1 minute and 42 seconds\",\n\t\t},\n\t],\n\tflags: {\n\t\tboring: {\n\t\t\tshortFlag: \"b\",\n\t\t\tdefault: defaultFlags.boring,\n\t\t\tdescription: \"Do not use color output\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t\thelp: {\n\t\t\tshortFlag: \"h\",\n\t\t\tdescription: \"Display help instructions\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t\tnotification: {\n\t\t\tshortFlag: \"n\",\n\t\t\tdefault: defaultFlags.notification,\n\t\t\tdescription: \"Display a notification when the timer is done\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t\tversion: {\n\t\t\tshortFlag: \"v\",\n\t\t\tdescription: \"Output the current version\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t},\n\tparameters: {\n\t\tformattedTime: {\n\t\t\tdescription: \"Formatted time to start the timer\",\n\t\t},\n\t},\n\n\tusage: \"timer [formattedTime]\",\n});\n"],"names":["defaultFlags","parser","config","meta","examples","command","comment","flags","boring","shortFlag","default","description","type","help","notification","version","parameters","formattedTime","usage"],"mappings":"AAAA,SAASA,YAAY,QAAQ,gBAAgB;AAC7C,SAASC,MAAM,QAAQ,mBAAmB;AAW1C,wBAAwB,GACxB,OAAO,MAAMC,SAAwBD,OAAO;IAC3CE,MAAM;IACNC,UAAU;QACT;YACCC,SAAS;YACTC,SAAS;QACV;QACA;YACCD,SAAS;YACTC,SAAS;QACV;KACA;IACDC,OAAO;QACNC,QAAQ;YACPC,WAAW;YACXC,SAASV,aAAaQ;YACtBG,aAAa;YACbC,MAAM;QACP;QACAC,MAAM;YACLJ,WAAW;YACXE,aAAa;YACbC,MAAM;QACP;QACAE,cAAc;YACbL,WAAW;YACXC,SAASV,aAAac;YACtBH,aAAa;YACbC,MAAM;QACP;QACAG,SAAS;YACRN,WAAW;YACXE,aAAa;YACbC,MAAM;QACP;IACD;IACAI,YAAY;QACXC,eAAe;YACdN,aAAa;QACd;IACD;IAEAO,OAAO;AACR,GAAG"}

package/dist/timer.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/timer.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+/* istanbul ignore file */ import { Timer } from "./utilities.js";
+import { config } from "./parse.js";
+const timer = new Timer(config);
+timer.start();
+
+//# sourceMappingURL=timer.js.map

package/dist/timer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/timer.ts"],"sourcesContent":["#!/usr/bin/env node\n/* istanbul ignore file */\n\nimport { Timer } from \"./utilities.js\";\nimport { config } from \"./parse.js\";\n\nconst timer = new Timer(config);\ntimer.start();\n"],"names":["Timer","config","timer","start"],"mappings":";AACA,wBAAwB,GAExB,SAASA,KAAK,QAAQ,iBAAiB;AACvC,SAASC,MAAM,QAAQ,aAAa;AAEpC,MAAMC,QAAQ,IAAIF,MAAMC;AACxBC,MAAMC"}

package/dist/utilities.d.ts

@@ -0,0 +1,14 @@
+import { Duration } from "moment";
+import { Configuration } from "./parse.js";
+export declare const timeToMicroseconds: (value: string, unit: string) => number;
+export declare const extractDuration: (config: Configuration) => Duration;
+export declare class Timer {
+    config: Configuration;
+    startTime: number;
+    timerDurationMilliSeconds: number;
+    introMessage: string;
+    timerDurationSeconds: number;
+    constructor(config: Configuration);
+    start: () => void;
+    private printRemainingTime;
+}

package/dist/utilities.js

@@ -0,0 +1,89 @@
+import { Logger, Spinner } from "@node-cli/logger";
+import moment from "moment";
+import notifier from "node-notifier";
+const logger = new Logger();
+const spinner = new Spinner();
+const UNITS = {
+    ms: 1000,
+    s: 1000 * 1000,
+    m: 1000 * 1000 * 60,
+    h: 1000 * 1000 * 60 * 60,
+    d: 1000 * 1000 * 60 * 60 * 24,
+    w: 1000 * 1000 * 60 * 60 * 24 * 7
+};
+export const timeToMicroseconds = (value, unit)=>{
+    const result = UNITS[unit];
+    return result ? Number.parseInt(value, 10) * result : 0;
+};
+export const extractDuration = (config)=>{
+    const { parameters , showHelp  } = config;
+    let totalMicroseconds = 0;
+    /* istanbul ignore if */ if (Object.entries(parameters).length === 0 || Object.entries(parameters).length > 1) {
+        showHelp();
+    }
+    const groups = parameters["0"].toLowerCase().match(/[+-]?[\d.]+[a-z]+/g);
+    /* istanbul ignore if */ if (groups === null) {
+        showHelp();
+    } else {
+        for (const g of groups){
+            const value = g.match(/[\d.]+/g)[0];
+            const unit = g.match(/[a-z]+/g)[0];
+            totalMicroseconds += timeToMicroseconds(value, unit);
+        }
+        return moment.duration(totalMicroseconds / UNITS.ms);
+    }
+};
+/* istanbul ignore next */ export class Timer {
+    config;
+    startTime;
+    timerDurationMilliSeconds;
+    introMessage;
+    timerDurationSeconds;
+    constructor(config){
+        this.config = config;
+        const result = extractDuration(this.config);
+        this.timerDurationMilliSeconds = result.asMilliseconds();
+        this.timerDurationSeconds = result.asSeconds();
+        this.introMessage = `${result.hours()}h ${result.minutes()}m ${result.seconds()}s`;
+    }
+    start = ()=>{
+        if (this.timerDurationMilliSeconds > 0) {
+            logger.printBox(`${this.introMessage}  `, {
+                padding: 0,
+                borderColor: "cyan",
+                title: "Timer Configuration"
+            });
+            this.startTime = Date.now();
+            spinner.start(this.introMessage);
+            // update the spinner every second
+            this.printRemainingTime();
+            const timer = setInterval(this.printRemainingTime, 1000);
+            // kill the spinner when the timer is done
+            setTimeout(()=>{
+                const message = "Time's up!";
+                if (this.config.flags.notification) {
+                    notifier.notify({
+                        message,
+                        sound: "Funk",
+                        title: "Timer Notification",
+                        wait: true
+                    });
+                }
+                clearInterval(timer);
+                this.printRemainingTime(message);
+                spinner.stop();
+            }, this.timerDurationMilliSeconds);
+        }
+    };
+    printRemainingTime = (message)=>{
+        if (message) {
+            spinner.text = message;
+        } else {
+            const elapsed = (Date.now() - this.startTime) / 1000;
+            const duration = moment.duration((this.timerDurationSeconds - elapsed) * 1000);
+            spinner.text = `${duration.hours()}h ${duration.minutes()}m ${duration.seconds()}s`;
+        }
+    };
+}
+
+//# sourceMappingURL=utilities.js.map

package/dist/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utilities.ts"],"sourcesContent":["import { Logger, Spinner } from \"@node-cli/logger\";\nimport moment, { Duration } from \"moment\";\n\nimport { Configuration } from \"./parse.js\";\nimport notifier from \"node-notifier\";\n\nconst logger = new Logger();\nconst spinner = new Spinner();\n\nconst UNITS = {\n\tms: 1000,\n\ts: 1000 * 1000,\n\tm: 1000 * 1000 * 60,\n\th: 1000 * 1000 * 60 * 60,\n\td: 1000 * 1000 * 60 * 60 * 24,\n\tw: 1000 * 1000 * 60 * 60 * 24 * 7,\n};\n\nexport const timeToMicroseconds = (value: string, unit: string) => {\n\tconst result = UNITS[unit];\n\treturn result ? Number.parseInt(value, 10) * result : 0;\n};\n\nexport const extractDuration = (config: Configuration): Duration => {\n\tconst { parameters, showHelp } = config;\n\tlet totalMicroseconds = 0;\n\n\t/* istanbul ignore if */\n\tif (\n\t\tObject.entries(parameters).length === 0 ||\n\t\tObject.entries(parameters).length > 1\n\t) {\n\t\tshowHelp();\n\t}\n\n\tconst groups = parameters[\"0\"].toLowerCase().match(/[+-]?[\\d.]+[a-z]+/g);\n\n\t/* istanbul ignore if */\n\tif (groups === null) {\n\t\tshowHelp();\n\t} else {\n\t\tfor (const g of groups) {\n\t\t\tconst value = g.match(/[\\d.]+/g)[0];\n\t\t\tconst unit = g.match(/[a-z]+/g)[0];\n\t\t\ttotalMicroseconds += timeToMicroseconds(value, unit);\n\t\t}\n\t\treturn moment.duration(totalMicroseconds / UNITS.ms);\n\t}\n};\n\n/* istanbul ignore next */\nexport class Timer {\n\tconfig: Configuration;\n\tstartTime: number;\n\ttimerDurationMilliSeconds: number;\n\tintroMessage: string;\n\ttimerDurationSeconds: number;\n\n\tconstructor(config: Configuration) {\n\t\tthis.config = config;\n\t\tconst result: Duration = extractDuration(this.config);\n\t\tthis.timerDurationMilliSeconds = result.asMilliseconds();\n\t\tthis.timerDurationSeconds = result.asSeconds();\n\t\tthis.introMessage = `${result.hours()}h ${result.minutes()}m ${result.seconds()}s`;\n\t}\n\n\tstart = () => {\n\t\tif (this.timerDurationMilliSeconds > 0) {\n\t\t\tlogger.printBox(`${this.introMessage}  `, {\n\t\t\t\tpadding: 0,\n\t\t\t\tborderColor: \"cyan\",\n\t\t\t\ttitle: \"Timer Configuration\",\n\t\t\t});\n\n\t\t\tthis.startTime = Date.now();\n\t\t\tspinner.start(this.introMessage);\n\n\t\t\t// update the spinner every second\n\t\t\tthis.printRemainingTime();\n\t\t\tconst timer = setInterval(this.printRemainingTime, 1000);\n\n\t\t\t// kill the spinner when the timer is done\n\t\t\tsetTimeout(() => {\n\t\t\t\tconst message = \"Time's up!\";\n\t\t\t\tif (this.config.flags.notification) {\n\t\t\t\t\tnotifier.notify({\n\t\t\t\t\t\tmessage,\n\t\t\t\t\t\tsound: \"Funk\",\n\t\t\t\t\t\ttitle: \"Timer Notification\",\n\t\t\t\t\t\twait: true,\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t\tclearInterval(timer);\n\t\t\t\tthis.printRemainingTime(message);\n\t\t\t\tspinner.stop();\n\t\t\t}, this.timerDurationMilliSeconds);\n\t\t}\n\t};\n\n\tprivate printRemainingTime = (message: string | void) => {\n\t\tif (message) {\n\t\t\tspinner.text = message;\n\t\t} else {\n\t\t\tconst elapsed = (Date.now() - this.startTime) / 1000;\n\t\t\tconst duration = moment.duration(\n\t\t\t\t(this.timerDurationSeconds - elapsed) * 1000\n\t\t\t);\n\t\t\tspinner.text = `${duration.hours()}h ${duration.minutes()}m ${duration.seconds()}s`;\n\t\t}\n\t};\n}\n"],"names":["Logger","Spinner","moment","notifier","logger","spinner","UNITS","ms","s","m","h","d","w","timeToMicroseconds","value","unit","result","Number","parseInt","extractDuration","config","parameters","showHelp","totalMicroseconds","Object","entries","length","groups","toLowerCase","match","g","duration","Timer","startTime","timerDurationMilliSeconds","introMessage","timerDurationSeconds","constructor","asMilliseconds","asSeconds","hours","minutes","seconds","start","printBox","padding","borderColor","title","Date","now","printRemainingTime","timer","setInterval","setTimeout","message","flags","notification","notify","sound","wait","clearInterval","stop","text","elapsed"],"mappings":"AAAA,SAASA,MAAM,EAAEC,OAAO,QAAQ,mBAAmB;AACnD,OAAOC,YAA0B,SAAS;AAG1C,OAAOC,cAAc,gBAAgB;AAErC,MAAMC,SAAS,IAAIJ;AACnB,MAAMK,UAAU,IAAIJ;AAEpB,MAAMK,QAAQ;IACbC,IAAI;IACJC,GAAG,OAAO;IACVC,GAAG,OAAO,OAAO;IACjBC,GAAG,OAAO,OAAO,KAAK;IACtBC,GAAG,OAAO,OAAO,KAAK,KAAK;IAC3BC,GAAG,OAAO,OAAO,KAAK,KAAK,KAAK;AACjC;AAEA,OAAO,MAAMC,qBAAqB,CAACC,OAAeC;IACjD,MAAMC,SAASV,KAAK,CAACS,KAAK;IAC1B,OAAOC,SAASC,OAAOC,SAASJ,OAAO,MAAME,SAAS;AACvD,EAAE;AAEF,OAAO,MAAMG,kBAAkB,CAACC;IAC/B,MAAM,EAAEC,WAAU,EAAEC,SAAQ,EAAE,GAAGF;IACjC,IAAIG,oBAAoB;IAExB,sBAAsB,GACtB,IACCC,OAAOC,QAAQJ,YAAYK,WAAW,KACtCF,OAAOC,QAAQJ,YAAYK,SAAS,GACnC;QACDJ;IACD;IAEA,MAAMK,SAASN,UAAU,CAAC,IAAI,CAACO,cAAcC,MAAM;IAEnD,sBAAsB,GACtB,IAAIF,WAAW,MAAM;QACpBL;IACD,OAAO;QACN,KAAK,MAAMQ,KAAKH,OAAQ;YACvB,MAAMb,QAAQgB,EAAED,MAAM,UAAU,CAAC,EAAE;YACnC,MAAMd,OAAOe,EAAED,MAAM,UAAU,CAAC,EAAE;YAClCN,qBAAqBV,mBAAmBC,OAAOC;QAChD;QACA,OAAOb,OAAO6B,SAASR,oBAAoBjB,MAAMC;IAClD;AACD,EAAE;AAEF,wBAAwB,GACxB,OAAO,MAAMyB;IACZZ,OAAsB;IACtBa,UAAkB;IAClBC,0BAAkC;IAClCC,aAAqB;IACrBC,qBAA6B;IAE7BC,YAAYjB,MAAqB,CAAE;QAClC,IAAI,CAACA,SAASA;QACd,MAAMJ,SAAmBG,gBAAgB,IAAI,CAACC;QAC9C,IAAI,CAACc,4BAA4BlB,OAAOsB;QACxC,IAAI,CAACF,uBAAuBpB,OAAOuB;QACnC,IAAI,CAACJ,eAAe,CAAC,EAAEnB,OAAOwB,QAAQ,EAAE,EAAExB,OAAOyB,UAAU,EAAE,EAAEzB,OAAO0B,UAAU,CAAC,CAAC;IACnF;IAEAC,QAAQ;QACP,IAAI,IAAI,CAACT,4BAA4B,GAAG;YACvC9B,OAAOwC,SAAS,CAAC,EAAE,IAAI,CAACT,aAAa,EAAE,CAAC,EAAE;gBACzCU,SAAS;gBACTC,aAAa;gBACbC,OAAO;YACR;YAEA,IAAI,CAACd,YAAYe,KAAKC;YACtB5C,QAAQsC,MAAM,IAAI,CAACR;YAEnB,kCAAkC;YAClC,IAAI,CAACe;YACL,MAAMC,QAAQC,YAAY,IAAI,CAACF,oBAAoB;YAEnD,0CAA0C;YAC1CG,WAAW;gBACV,MAAMC,UAAU;gBAChB,IAAI,IAAI,CAAClC,OAAOmC,MAAMC,cAAc;oBACnCrD,SAASsD,OAAO;wBACfH;wBACAI,OAAO;wBACPX,OAAO;wBACPY,MAAM;oBACP;gBACD;gBACAC,cAAcT;gBACd,IAAI,CAACD,mBAAmBI;gBACxBjD,QAAQwD;YACT,GAAG,IAAI,CAAC3B;QACT;IACD,EAAE;IAEMgB,qBAAqB,CAACI;QAC7B,IAAIA,SAAS;YACZjD,QAAQyD,OAAOR;QAChB,OAAO;YACN,MAAMS,UAAU,AAACf,CAAAA,KAAKC,QAAQ,IAAI,CAAChB,SAAQ,IAAK;YAChD,MAAMF,WAAW7B,OAAO6B,SACvB,AAAC,CAAA,IAAI,CAACK,uBAAuB2B,OAAM,IAAK;YAEzC1D,QAAQyD,OAAO,CAAC,EAAE/B,SAASS,QAAQ,EAAE,EAAET,SAASU,UAAU,EAAE,EAAEV,SAASW,UAAU,CAAC,CAAC;QACpF;IACD,EAAE;AACH"}

package/package.json

@@ -0,0 +1,38 @@
+{
+	"name": "@node-cli/timer",
+	"version": "1.0.0",
+	"license": "MIT",
+	"author": "Arno Versini",
+	"description": "Dead simpler CLI timer",
+	"type": "module",
+	"types": "./dist/index.d.ts",
+	"exports": "./dist/timer.js",
+	"bin": {
+		"timer": "dist/timer.js"
+	},
+	"files": [
+		"dist"
+	],
+	"node": ">=16",
+	"scripts": {
+		"build": "yarn run clean && yarn run build:types && yarn run build:js && yarn run build:barrel",
+		"build:barrel": "barrelsby --delete --directory dist --pattern \"**/*.d.ts\" --name \"index.d\"",
+		"build:js": "swc --source-maps --out-dir dist src",
+		"build:types": "tsc",
+		"clean": "rimraf dist types coverage",
+		"lint": "prettier --write \"src/*.ts\" && eslint --fix \"src/*.ts\"",
+		"test": "cross-env-shell NODE_OPTIONS=--experimental-vm-modules TZ=UTC jest",
+		"test:coverage": "npm run test -- --coverage",
+		"watch": "swc --watch --out-dir dist src"
+	},
+	"dependencies": {
+		"@node-cli/logger": ">=1.0.0",
+		"@node-cli/parser": ">=2.0.0",
+		"moment": "2.29.4",
+		"node-notifier": "10.0.1"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"gitHead": "04fc495165a21ef51a94175dac632e733759eab4"
+}