Logs

Author: fisker

package.json

@@ -23,6 +23,7 @@
     "@actions/core": "2.0.1",
     "@actions/github": "6.0.1",
     "nano-spawn": "2.0.0",
+    "node-style-text": "^2.1.2",
     "pretty-ms": "9.3.0"
   },
   "devDependencies": {

src/execute-command.ts

@@ -1,4 +1,3 @@
-import prettyMilliseconds from "pretty-ms";
 import { runPrettier } from "./run-prettier.ts";
 import * as logger from "./logger.ts";
 import { installPrettier } from "./install-prettier.ts";

src/install-prettier.ts

@@ -2,21 +2,22 @@ import path from "node:path";
 import fs from "node:fs/promises";
 import assert from "node:assert/strict";
 import spawn from "nano-spawn";
-import prettyMilliseconds from "pretty-ms";
 import {
   type PrettierVersion,
   PRETTIER_PACKAGE_TYPE_PULL_REQUEST,
 } from "./parse-command.ts";
 import { writeFile, clearDirectory } from "./utilities.ts";
+import { Timing } from "./timing.ts";
 
 export type InstalledPrettier = Awaited<ReturnType<typeof installPrettier>>;
 
 export async function installPrettier(
   version: PrettierVersion,
   { cwd }: { cwd: string },
 ) {
-  const startTime = process.hrtime.bigint();
-  console.log(`Installing Prettier(${version.kind}) '${version.raw}' ...`);
+  const timing = new Timing(
+    `Install Prettier[${version.kind}] '${version.raw}'`,
+  );
   const directory = await clearDirectory(
     path.join(cwd, `${version.kind}-prettier`),
   );
@@ -40,9 +41,8 @@ export async function installPrettier(
   ]);
   assert.ok(typeof installedVersion === "string");
 
-  console.log(
-    `Prettier(${version.kind}) '${version.raw}' installed in ${prettyMilliseconds((process.hrtime.bigint() - startTime) / 1_000_000n)}.`,
-  );
+  timing.end();
+
   return {
     bin: prettierBinary,
     version: version,

src/repositories.ts

@@ -1,10 +1,10 @@
-import prettyMilliseconds from "pretty-ms";
 import spawn from "nano-spawn";
 import path from "node:path";
 import assert from "node:assert/strict";
 import { repositoriesDirectory } from "./constants.ts";
 import { clearDirectory, getCommitHash } from "./utilities.ts";
 import rawRepositories from "../repositories.json" with { type: "json" };
+import { Timing } from "./timing.ts";
 
 type RawRepository = {
   repository: string;
@@ -80,8 +80,7 @@ export async function cloneRepository(repository: Repository) {
     // No op
   }
 
-  const startTime = process.hrtime.bigint();
-  console.log(`Cloning repository '${repository.repository}' ...`);
+  const timing = new Timing(`Cloning repository '${repository.repository}'`);
 
   await clearDirectory(directory);
   await spawn("git", ["init"], { cwd: directory });
@@ -101,7 +100,5 @@ export async function cloneRepository(repository: Repository) {
 
   assert.equal(await getCommitHash(directory), commitHash);
 
-  console.log(
-    `Repository '${repository.repository}' cloned in ${prettyMilliseconds((process.hrtime.bigint() - startTime) / 1_000_000n)}.`,
-  );
+  timing.end();
 }

src/run-prettier.ts

@@ -1,10 +1,10 @@
-import prettyMilliseconds from "pretty-ms";
 import path from "node:path";
 import spawn, { type SubprocessError } from "nano-spawn";
 import { type Repository } from "./repositories.ts";
 import { type InstalledPrettier } from "./install-prettier.ts";
 import { prepareRepository } from "./prepare-repository.ts";
 import { commitChanges } from "./utilities.ts";
+import { Timing } from "./timing.ts";
 
 async function runPrettierWithVersion({
   cwd,
@@ -17,11 +17,9 @@ async function runPrettierWithVersion({
   repository: Repository;
   reset: () => Promise<void>;
 }) {
-  const startTime = process.hrtime.bigint();
-  console.log(
-    `Running Prettier(${prettier.version.kind}) on repository '${repository.repository}' ...`,
+  const timing = new Timing(
+    `Run Prettier(${prettier.version.kind}) on repository '${repository.repository}'`,
   );
-
   await reset();
 
   const args = [prettier.bin, "--write", "--no-color", ...repository.glob];
@@ -50,9 +48,7 @@ async function runPrettierWithVersion({
 
   await spawn("git", ["branch", prettier.version.kind], { cwd });
 
-  console.log(
-    `Running Prettier(${prettier.version.kind}) on repository '${repository.repository}' finished in ${prettyMilliseconds((process.hrtime.bigint() - startTime) / 1_000_000n)}.`,
-  );
+  timing.end();
   return commitHash;
 }
 
@@ -78,8 +74,9 @@ export async function runPrettier(
     original: InstalledPrettier;
   },
 ) {
-  const startTime = process.hrtime.bigint();
-  console.log(`Runing Prettier on repository '${repository.repository}' ...`);
+  const timing = new Timing(
+    `Run Prettier on repository '${repository.repository}'`,
+  );
   const directory = path.join(cwd, `repositories/${repository.directoryName}`);
 
   const { reset } = await prepareRepository(directory, repository);
@@ -112,8 +109,6 @@ export async function runPrettier(
     { cwd: directory },
   );
 
-  console.log(
-    `Run Prettier on repository '${repository.repository}' finished in ${prettyMilliseconds((process.hrtime.bigint() - startTime) / 1_000_000n)}.`,
-  );
+  timing.end();
   return stdout;
 }

src/timing.ts

@@ -0,0 +1,26 @@
+import prettyMilliseconds from "pretty-ms";
+import styleText from "node-style-text";
+
+const START_PREFIX = styleText.bgGray("[START]");
+const END_PREFIX = styleText.bgGreen("[ END ]");
+
+class Timing {
+  #message;
+  #startMark: PerformanceMark | undefined;
+
+  constructor(message: string) {
+    this.#message = message;
+    this.#startMark = performance.mark("start");
+    console.log(`${START_PREFIX}: ${message}`);
+  }
+
+  end(message?: string) {
+    const { duration } = performance.measure(this.#message, this.#startMark);
+    console.log(
+      (message ?? `${END_PREFIX}: ${this.#message}`) +
+        ` (${styleText.blue.underline(prettyMilliseconds(duration))})`,
+    );
+  }
+}
+
+export { Timing };

yarn.lock

@@ -3208,6 +3208,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"node-style-text@npm:^2.1.2":
+  version: 2.1.2
+  resolution: "node-style-text@npm:2.1.2"
+  checksum: 10c0/25eed9636e9d9df05901a85fb2a82fda6a42a897f167762539de68c476924340e908b1dfeec7c30f01741a0820c5d568c6da6ef1a82e0b00411f27b936798dad
+  languageName: node
+  linkType: hard
+
 "nopt@npm:^8.0.0":
   version: 8.1.0
   resolution: "nopt@npm:8.1.0"
@@ -3497,6 +3504,7 @@ __metadata:
     eslint-config-prettier: "npm:10.1.8"
     globals: "npm:16.5.0"
     nano-spawn: "npm:2.0.0"
+    node-style-text: "npm:^2.1.2"
     npm-run-all: "npm:4.1.5"
     outdent: "npm:0.8.0"
     prettier: "npm:3.7.4"