Add timeStart function (#5)

src/Logger.spec.ts

@@ -1,8 +1,9 @@
 import { expect } from 'chai';
 import type { LogLevel, LogMessage } from './Logger';
-import { Logger, LogLevelColor, LogLevelNumeric } from './Logger';
+import { Logger, LogLevelColor, LogLevelNumeric, chalk } from './Logger';
 import { ConsoleTransport } from './transports/ConsoleTransport';
 import { createSandbox } from 'sinon';
+import { Stopwatch } from './Stopwatch';
 const sinon = createSandbox();
 
 describe('Logger', () => {
@@ -17,6 +18,8 @@ describe('Logger', () => {
         sinon.restore();
         sinon.stub(Logger.prototype as any, 'getCurrentDate').returns(now);
         logger = new Logger();
+        //disable chalk colors for this test
+        chalk.level = 0;
     });
 
     afterEach(() => {
@@ -509,6 +512,32 @@ describe('Logger', () => {
         });
     });
 
+    describe('timeStart', () => {
+        it('skips logging when logLevel is disabled', async () => {
+            const stub = sinon.stub(logger, 'write').callThrough();
+            logger.logLevel = 'log';
+            const stop = logger.timeStart('info', 'message');
+            await sleep(10);
+            stop();
+            expect(stub.called).to.be.false;
+        });
+
+        it('logs when logLevel is enabled', async () => {
+            sinon.stub(Stopwatch.prototype, 'getDurationText').callsFake(() => '10ms');
+            const stub = sinon.stub(logger, 'write').callThrough();
+            logger.logLevel = 'info';
+            const stop = logger.timeStart('info', 'message');
+            await sleep(10);
+            stop();
+            expect(
+                stub.getCalls().map(x => x.args)
+            ).to.eql([
+                ['info', 'message'],
+                ['info', 'message', `finished. (10ms)`]
+            ]);
+        });
+    });
+
     describe('time', () => {
         it('calls action even if logLevel is wrong', () => {
             logger.logLevel = 'error';
@@ -555,3 +584,9 @@ describe('Logger', () => {
         });
     });
 });
+
+async function sleep(ms: number) {
+    return new Promise(resolve => {
+        setTimeout(resolve, ms);
+    });
+}

src/Logger.ts

@@ -291,6 +291,27 @@ export class Logger {
         this.write('error', ...messages);
     }
 
+    /**
+     * Writes to the log (if logLevel matches), and also provides a function that can be called to mark the end of a time.
+     */
+    public timeStart(logLevel: LogLevel, ...messages: unknown[]) {
+        //call the log if loglevel is in range
+        if (this.isLogLevelEnabled(logLevel)) {
+            const stopwatch = new Stopwatch();
+
+            //write the initial log
+            this.write(logLevel, ...messages);
+
+            stopwatch.start();
+
+            return (status = 'finished') => {
+                stopwatch.stop();
+                this.write(logLevel, ...messages, `${status}. (${chalk.blue(stopwatch.getDurationText())})`);
+            };
+        }
+        return noop;
+    }
+
     /**
      * Writes to the log (if logLevel matches), and also times how long the action took to occur.
      * `action` is called regardless of logLevel, so this function can be used to nicely wrap

tsconfig.json

@@ -1,14 +1,26 @@
 {
     "compilerOptions": {
-        "module": "commonjs",
-        "strict": true,
-        "noUnusedLocals": true,
-        "noUnusedParameters": true,
-        "target": "es2018",
-        "declaration": true,
+        "noImplicitAny": false,
+        "target": "ES2017",
+        "module": "CommonJS",
         "sourceMap": true,
+        "rootDir": "src",
         "outDir": "dist",
-        "preserveConstEnums": true
+        "declaration": true,
+        "strict": true,
+        "strictNullChecks": false,
+        "forceConsistentCasingInFileNames": true,
+        "experimentalDecorators": true,
+        "preserveConstEnums": true,
+        "downlevelIteration": true,
+        "noUnusedLocals": true,
+        "allowSyntheticDefaultImports": true,
+        "resolveJsonModule": true,
+        "lib": [
+            "es2017",
+            "es2019.array",
+            "dom"
+        ]
     },
     "include": [
         "src/**/*.ts"
@@ -20,4 +32,4 @@
     "ts-node": {
         "transpileOnly": true
     }
-}
+}