dependency-cruiser 12.1.0 → 12.2.0

package/README.md

@@ -154,7 +154,7 @@ You've come to the right place :-) :
 
 ## Build status
 
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/sverweij/dependency-cruiser/linting%20%26%20test%20coverage%20-%20linux?label=actions&logo=github)](https://github.com/sverweij/dependency-cruiser/actions)
+[![GitHub Workflow Status](https://github.com/sverweij/dependency-cruiser/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/sverweij/dependency-cruiser/actions/workflows/ci.yml)
 [![coverage](https://gitlab.com/sverweij/dependency-cruiser/badges/master/coverage.svg)](https://gitlab.com/sverweij/dependency-cruiser/builds)
 [![Maintainability](https://api.codeclimate.com/v1/badges/93035ef5fba33901d479/maintainability)](https://codeclimate.com/github/sverweij/dependency-cruiser/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/93035ef5fba33901d479/test_coverage)](https://codeclimate.com/github/sverweij/dependency-cruiser/test_coverage)

package/configs/plugins/3d-reporter-plugin.js

@@ -81,7 +81,7 @@ function formatDependency(pFrom, pTo) {
 
 /**
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult
+ * @param {import('../..').ICruiseResult} pCruiseResult
  */
 function render3DThing(pCruiseResult) {
   const lNodes = pCruiseResult.modules.map((pModule) => {
@@ -114,10 +114,10 @@ function render3DThing(pCruiseResult) {
 /**
  * Sample plugin: 3d representation
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult -
+ * @param {import('../..').ICruiseResult} pCruiseResult -
  *      the output of a dependency-cruise adhering to dependency-cruiser's
  *      cruise result schema
- * @return {import('../../types/dependency-cruiser').IReporterOutput} -
+ * @return {import('../..').IReporterOutput} -
  *      output: a string
  *      exitCode: 0
  */

package/configs/plugins/stats-reporter-plugin.js

@@ -33,7 +33,7 @@ function doMagic(pCruiseResult) {
  * returns an object with some stats from the ICruiseResult pCruiseResult it
  * got passed
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult - a result from a cruise.
+ * @param {import('../..').ICruiseResult} pCruiseResult - a result from a cruise.
  * @return {string} an object with some stats
  */
 function samplePluginReporter(pCruiseResult) {
@@ -65,10 +65,10 @@ function samplePluginReporter(pCruiseResult) {
 /**
  * Sample plugin
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult -
+ * @param {import('../..').ICruiseResult} pCruiseResult -
  *      the output of a dependency-cruise adhering to dependency-cruiser's
  *      cruise result schema
- * @return {import('../../types/dependency-cruiser').IReporterOutput} -
+ * @return {import('../..').IReporterOutput} -
  *      output: some stats on modules and dependencies in json format
  *      exitCode: 0
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "12.1.0",
+  "version": "12.2.0",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -87,6 +87,8 @@
     "depcruise:graph:doc:samples": "sh tools/generate-samples.sh",
     "depcruise:graph:dot": "node ./bin/dependency-cruise.js bin src --config --output-type dot | dot -T svg > tmp_deps.svg",
     "depcruise:graph:fdp": "node ./bin/dependency-cruise.js bin src --config --output-type dot | fdp -GK=0.1 -Gsplines=true -T svg > tmp_deps.svg",
+    "depcruise:graph:mermaid": "node ./bin/dependency-cruise.js bin src --include-only ^src/ --config --collapse 2 --output-type mermaid",
+    "depcruise:graph:mermaid:diff": "node ./bin/dependency-cruise.js bin src test types tools --config configs/.dependency-cruiser-unlimited.json --output-type mermaid --reaches \"$(watskeburt $SHA)\"",
     "depcruise:graph:osage": "node ./bin/dependency-cruise.js bin src --config --output-type dot | osage -Gpack=32 -GpackMode=array2 -T svg > tmp_deps.svg",
     "depcruise:graph:view": "node ./bin/dependency-cruise.js bin src --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-show-metrics-config.json --output-type dot --progress cli-feedback --highlight \"$(watskeburt develop)\" | dot -T svg | node ./bin/wrap-stream-in-html.js | browser",
     "depcruise:graph:view:diff": "node ./bin/dependency-cruise.js bin src test --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-unlimited.json --output-type dot --progress cli-feedback --reaches \"$(watskeburt develop)\" | dot -T svg | node ./bin/wrap-stream-in-html.js | browser",
@@ -116,11 +118,11 @@
     "scm:push:gitlab-mirror:commits": "git push gitlab-mirror",
     "scm:push:gitlab-mirror:tags": "git push --tags gitlab-mirror",
     "scm:stage": "git add .",
-    "test": "mocha",
-    "test:i": "mocha --grep \"^\\[[I]\\]\"",
-    "test:u": "mocha --grep \"^\\[[U]\\]\"",
-    "test:e": "mocha --grep \"^\\[[E]\\]\"",
-    "test:cover": "c8 --check-coverage --statements 99.9 --branches 99.7 --functions 100 --lines 99.9 --exclude \"{bin,configs/*.js,configs/rules,configs/plugins/3d-*.js,configs/plugins/stats-*.js,doc,docs,coverage,test,tools,webpack.conf.js,tmp*,src/**/*.template.js,src/cli/tools/svg-in-html-snippets/script.snippet.js,src/cli/init-config/get-user-input.js,src/cli/listeners/*/index.js}\" --reporter text-summary --reporter html --reporter json-summary mocha",
+    "test": "LANG=en_US.UTF-8 mocha",
+    "test:i": "LANG=en_US.UTF-8 mocha --grep \"^\\[[I]\\]\"",
+    "test:u": "LANG=en_US.UTF-8 mocha --grep \"^\\[[U]\\]\"",
+    "test:e": "LANG=en_US.UTF-8 mocha --grep \"^\\[[E]\\]\"",
+    "test:cover": "LANG=en_US.UTF-8 c8 --check-coverage --statements 99.9 --branches 99.7 --functions 100 --lines 99.9 --exclude \"{bin,configs/*.js,configs/rules,configs/plugins/3d-*.js,configs/plugins/stats-*.js,doc,docs,coverage,test,tools,webpack.conf.js,tmp*,src/**/*.template.js,src/cli/tools/svg-in-html-snippets/script.snippet.js,src/cli/init-config/get-user-input.js,src/cli/listeners/*/index.js}\" --reporter text-summary --reporter html --reporter json-summary mocha",
     "test:glob": "set -f && test \"`bin/dependency-cruise.js test/extract/__mocks__/gather-globbing/packages/**/src/**/*.js | grep \"no dependency violations found\"`\" = \"✔ no dependency violations found (6 modules, 0 dependencies cruised)\"",
     "test:yarn-pnp": "npm-run-all test:yarn-pnp:cleanup test:yarn-pnp:pack test:yarn-pnp:copy test:yarn-pnp:install test:yarn-pnp:version test:yarn-pnp:run test:yarn-pnp:test test:yarn-pnp:cleanup",
     "test:yarn-pnp:pack": "npm pack",
@@ -154,9 +156,9 @@
     "glob": "7.2.0",
     "handlebars": "4.7.7",
     "indent-string": "^4.0.0",
-    "interpret": "^2.2.0",
+    "interpret": "^3.1.0",
     "is-installed-globally": "0.4.0",
-    "json5": "2.2.1",
+    "json5": "2.2.2",
     "lodash": "4.17.21",
     "prompts": "2.4.2",
     "rechoir": "^0.8.0",
@@ -169,21 +171,21 @@
     "wrap-ansi": "^7.0.0"
   },
   "devDependencies": {
-    "@babel/core": "7.20.2",
-    "@babel/plugin-transform-modules-commonjs": "7.19.6",
+    "@babel/core": "7.20.7",
+    "@babel/plugin-transform-modules-commonjs": "7.20.11",
     "@babel/preset-typescript": "7.18.6",
-    "@swc/core": "1.3.20",
-    "@types/lodash": "4.14.190",
-    "@types/node": "18.11.9",
-    "@types/prompts": "2.4.1",
-    "@typescript-eslint/eslint-plugin": "5.44.0",
-    "@typescript-eslint/parser": "5.44.0",
+    "@swc/core": "1.3.24",
+    "@types/lodash": "4.14.191",
+    "@types/node": "18.11.17",
+    "@types/prompts": "2.4.2",
+    "@typescript-eslint/eslint-plugin": "5.47.0",
+    "@typescript-eslint/parser": "5.47.0",
     "@vue/compiler-sfc": "3.2.45",
     "c8": "7.12.0",
     "chai": "4.3.7",
     "chai-json-schema": "1.5.1",
     "coffeescript": "2.7.0",
-    "eslint": "8.28.0",
+    "eslint": "8.30.0",
     "eslint-config-moving-meadow": "4.0.2",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-budapestian": "5.0.1",
@@ -195,16 +197,16 @@
     "eslint-plugin-unicorn": "^45.0.0",
     "husky": "8.0.2",
     "intercept-stdout": "0.1.2",
-    "lint-staged": "12.3.4",
-    "mocha": "10.1.0",
+    "lint-staged": "13.1.0",
+    "mocha": "10.2.0",
     "normalize-newline": "^3.0.0",
     "npm-run-all": "4.1.5",
-    "prettier": "2.8.0",
+    "prettier": "2.8.1",
     "proxyquire": "2.1.3",
     "shx": "0.3.4",
-    "svelte": "3.53.1",
+    "svelte": "3.55.0",
     "symlink-dir": "5.1.0",
-    "typescript": "4.9.3",
+    "typescript": "4.9.4",
     "upem": "7.3.1",
     "vue-template-compiler": "2.7.14",
     "yarn": "1.22.19"
@@ -234,12 +236,7 @@
       {
         "package": "interpret",
         "policy": "wanted",
-        "because": "we want to keep interpret ~similar to what webpack-cli uses (which is ^2.2.0)"
-      },
-      {
-        "package": "lint-staged",
-        "policy": "pin",
-        "because": "12.3.5 fails with SyntaxError: Unexpected token o in JSON at position 1"
+        "because": "we want to keep interpret ~similar to what webpack-cli uses (which is ^3.1.0 since 2022-11-15)"
       },
       {
         "package": "normalize-newline",
@@ -249,7 +246,7 @@
       {
         "package": "rechoir",
         "policy": "wanted",
-        "because": "we want to keep rechoir ~similar to what webpack-cli uses (which is ^0.7.0, but ^0.8.0 is similar enough and more recent anyway)"
+        "because": "we want to keep rechoir ~similar to what webpack-cli uses (which is ^0.8.0 since 2022-11-15))"
       },
       {
         "package": "wrap-ansi",

package/src/cache/cache.js

@@ -21,7 +21,7 @@ function writeCache(pCacheFolder, pCruiseResult) {
 /**
  *
  * @param {string} pCacheFolder
- * @returns {import("../../types/cruise-result").ICruiseResult}
+ * @returns {import("../..").ICruiseResult}
  */
 function readCache(pCacheFolder) {
   try {
@@ -36,11 +36,11 @@ function readCache(pCacheFolder) {
 /**
  *
  * @param {import("../../types/strict-options").IStrictCruiseOptions} pOptions
- * @param {import("../../types/cruise-result").IRevisionData} pRevisionData
- * @returns
+ * @param {import("../..").IRevisionData} pRevisionData
+ * @returns {boolean}
  */
 function canServeFromCache(pOptions, pRevisionData) {
-  /** @type {import("../../types/cruise-result").ICruiseResult} */
+  /** @type {import("../..").ICruiseResult} */
   const lCachedResults = readCache(pOptions.cache);
 
   return (

package/src/cache/revision-data.js

@@ -36,10 +36,18 @@ function isInterestingChangeType(pInterestingChangeTypes) {
   return (pChange) => pInterestingChangeTypes.has(pChange.changeType);
 }
 
+/**
+ * @param {string} pString
+ * @returns {string}
+ */
 function hash(pString) {
   return createHash("sha1").update(pString).digest("base64");
 }
 
+/**
+ * @param {import("fs").PathOrFileDescriptor} pFileName
+ * @returns {string}
+ */
 function getFileHash(pFileName) {
   try {
     return hash(readFileSync(pFileName, "utf8"));
@@ -50,7 +58,7 @@ function getFileHash(pFileName) {
 
 /**
  * @param {import("watskeburt").IChange} pChange
- * @param {import("../../types/cruise-result").IRevisionChange}
+ * @param {import("../..").IRevisionChange}
  */
 function addChecksum(pChange) {
   return {
@@ -66,8 +74,8 @@ function addChecksum(pChange) {
  * @param {Object} pOptions
  * @param {() => string} pOptions.shaRetrievalFn
  * @param {(pString:string) => Array<import("watskeburt").IChange>} pOptions.diffListFn
- * @param {(import("watskeburt").IChange) => import("../../types/cruise-result").IRevisionChange} pOptions.checkSumFn
- * @returns {import("../../types/cruise-result").IRevisionData}
+ * @param {(import("watskeburt").IChange) => import("../..").IRevisionChange} pOptions.checkSumFn
+ * @returns {import("../..").IRevisionData}
  */
 function getRevisionData(
   pExtensions,
@@ -100,9 +108,8 @@ function getRevisionData(
 }
 
 /**
- *
- * @param {import("../../types/cruise-result").IRevisionData} pExistingRevisionData
- * @param {import("../../types/cruise-result").IRevisionData} pNewRevisionData
+ * @param {import("../..").IRevisionData} pExistingRevisionData
+ * @param {import("../..").IRevisionData} pNewRevisionData
  * @returns {boolean}
  */
 function revisionDataEqual(pExistingRevisionData, pNewRevisionData) {

package/src/cache/utl.js

@@ -4,6 +4,7 @@ const { deepEqual } = require("assert");
  *
  * @param {any} pLeftObject
  * @param {any} pRightObject
+ * @returns {boolean}
  */
 function objectsAreEqual(pLeftObject, pRightObject) {
   try {

package/src/cli/format.js

@@ -7,10 +7,10 @@ const io = require("./utl/io");
 /**
  *
  * @param {string} pResultFile the name of the file with cruise results
- * @param {import("../../types/dependency-cruiser").IFormatOptions} pOptions
+ * @param {import("../..").IFormatOptions} pOptions
  * @returns {Number} an exitCode
  */
-module.exports = async (pResultFile, pOptions) => {
+module.exports = async function format(pResultFile, pOptions) {
   const lOptions = normalizeOptions(pOptions);
 
   if (pResultFile !== "-") {

package/src/cli/index.js

@@ -1,6 +1,6 @@
 const path = require("path");
 const glob = require("glob");
-const clone = require("lodash/clone");
+const cloneDeep = require("lodash/cloneDeep");
 const set = require("lodash/set");
 const isInstalledGlobally = require("is-installed-globally");
 const { red, yellow, bold } = require("chalk");
@@ -42,7 +42,7 @@ function addKnownViolations(pCruiseOptions) {
 
     // Check against json schema is already done in src/main/options/validate
     // so here we can just concentrate on the io
-    let lCruiseOptions = clone(pCruiseOptions);
+    let lCruiseOptions = cloneDeep(pCruiseOptions);
     set(lCruiseOptions, "ruleSet.options.knownViolations", lKnownViolations);
     return lCruiseOptions;
   }
@@ -119,7 +119,6 @@ function runCruise(pFileDirectoryArray, pCruiseOptions) {
   bus.emit("progress", "cli: writing results");
   bus.emit("write-start");
   io.write(lCruiseOptions.outputTo, lReportingResult.output);
-  bus.emit("end");
 
   return lReportingResult.exitCode;
 }
@@ -127,11 +126,11 @@ function runCruise(pFileDirectoryArray, pCruiseOptions) {
 /**
  *
  * @param {string[]} pFileDirectoryArray
- * @param {import("../../types/options").ICruiseOptions} pCruiseOptions
+ * @param {import("../../types/options").ICruiseOptions} lCruiseOptions
  * @returns {number}
  */
 module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
-  pCruiseOptions = pCruiseOptions || {};
+  let lCruiseOptions = pCruiseOptions || {};
   let lExitCode = 0;
 
   try {
@@ -150,9 +149,9 @@ module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
       );
     }
     /* c8 ignore stop */
-    if (pCruiseOptions.info === true) {
+    if (lCruiseOptions.info === true) {
       process.stdout.write(formatMetaInfo());
-    } else if (pCruiseOptions.init) {
+    } else if (lCruiseOptions.init) {
       // requiring init-config took ~100ms (most of it taken up by requiring
       // inquirer, measured on a 2.6GHz quad core i7 with flash storage on
       // macOS 10.15.7). Only requiring it when '--init' is necessary speeds up
@@ -161,15 +160,15 @@ module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
       // holds.
       // eslint-disable-next-line node/global-require
       const initConfig = require("./init-config");
-      initConfig(pCruiseOptions.init);
+      initConfig(lCruiseOptions.init);
     } else {
-      lExitCode = runCruise(pFileDirectoryArray, pCruiseOptions);
+      lExitCode = runCruise(pFileDirectoryArray, lCruiseOptions);
     }
   } catch (pError) {
     process.stderr.write(`\n  ${red("ERROR")}: ${pError.message}\n`);
     bus.emit("end");
     lExitCode = 1;
   }
-
+  bus.emit("end");
   return lExitCode;
 };

package/src/cli/init-config/build-config.js

@@ -9,9 +9,9 @@ require("./config.js.template");
  * Creates a .dependency-cruiser config with a set of basic validations
  * to the current directory.
  *
- * @returns {void}  Nothing
- * @param  {any}    pNormalizedInitOptions Options that influence the shape of
+ * @param {import("../../../types/init-config").IInitConfig} pNormalizedInitOptions Options that influence the shape of
  *                  the configuration
+ * @returns {string} the configuration as a string
  */
 
 module.exports = function buildConfig(pNormalizedInitOptions) {

package/src/cli/init-config/environment-helpers.js

@@ -24,9 +24,12 @@ function readManifest(pManifestFileName = "./package.json") {
   return JSON.parse(readFileSync(pManifestFileName, "utf8"));
 }
 
-/*
-  We could have used utl.fileExists - but that one is cached.
-  Not typically what we want for this util.
+/**
+ * We could have used utl.fileExists - but that one is cached.
+ * Not typically what we want for this util.
+ *
+ * @param {import("fs").PathLike} pFile
+ * @returns {boolean}
  */
 function fileExists(pFile) {
   try {

package/src/cli/init-config/get-user-input.js

@@ -15,7 +15,7 @@ const {
   hasWebpackConfigCandidates,
   getWebpackConfigCandidates,
 } = require("./environment-helpers");
-const { validateLocation } = require("./inquirer-validators");
+const { validateLocation } = require("./validators");
 
 function toPromptChoice(pString) {
   return {
@@ -24,7 +24,7 @@ function toPromptChoice(pString) {
   };
 }
 
-/** @type {import('@types/prompts').PromptObject[]} */
+/** @type {import('prompts').PromptObject[]} */
 const QUESTIONS = [
   {
     name: "isMonoRepo",

package/src/cli/init-config/index.js

@@ -1,3 +1,4 @@
+// @ts-check
 const $defaults = require("../defaults");
 const normalizeInitOptions = require("./normalize-init-options");
 const buildConfig = require("./build-config");
@@ -29,8 +30,8 @@ const PACKAGE_MANIFEST = `./${$defaults.PACKAGE_MANIFEST}`;
  * @param {import("../../../types/init-config").OneShotConfigIDType} pOneShotConfigId
  * @return {import("../../../types/init-config").IPartialInitConfig} an initialization configuration
  */
-function getOneshotConfig(pOneShotConfigId) {
-  /** @type {"../../../types/init-config").IPartialInitConfig} */
+function getOneShotConfig(pOneShotConfigId) {
+  /** @type {import("../../../types/init-config").IPartialInitConfig} */
   const lBaseConfig = {
     isMonoRepo: isLikelyMonoRepo(),
     combinedDependencies: false,
@@ -44,7 +45,8 @@ function getOneshotConfig(pOneShotConfigId) {
     useBabelConfig: hasBabelConfigCandidates(),
     babelConfig: getBabelConfigCandidates().shift(),
   };
-  const lOneshotConfigs = {
+  /** @type {Record<import("../../../types/init-config").OneShotConfigIDType, import("../../../types/init-config").IPartialInitConfig>} */
+  const lOneShotConfigs = {
     preset: {
       configType: "preset",
       preset: "dependency-cruiser/configs/recommended-strict",
@@ -58,21 +60,24 @@ function getOneshotConfig(pOneShotConfigId) {
   };
 
   // eslint-disable-next-line security/detect-object-injection
-  return lOneshotConfigs[pOneShotConfigId] || lBaseConfig;
+  return lOneShotConfigs[pOneShotConfigId] || lBaseConfig;
 }
 
 /**
  *
  * @param {import("../../../types/init-config").IInitConfig} pNormalizedInitConfig
  */
-function manifestIsUpdateable(pNormalizedInitConfig) {
+function manifestIsUpdatable(pNormalizedInitConfig) {
   return (
     pNormalizedInitConfig.updateManifest &&
     pNormalizedInitConfig.sourceLocation.length > 0
   );
 }
 
-module.exports = (pInit) => {
+/**
+ * @param {boolean|import("../../../types/init-config").OneShotConfigIDType} pInit
+ */
+module.exports = function initConfig(pInit) {
   /* c8 ignore start */
   if (pInit === true) {
     getUserInput()
@@ -83,13 +88,15 @@ module.exports = (pInit) => {
         process.stderr.write(`\n  ERROR: ${pError.message}\n`);
       });
     /* c8 ignore stop */
+  } else if (pInit === false) {
+    // do nothing; deliberately left empty
   } else {
-    const lNormalizedInitConfig = normalizeInitOptions(getOneshotConfig(pInit));
+    const lNormalizedInitConfig = normalizeInitOptions(getOneShotConfig(pInit));
     if (!fileExists(getDefaultConfigFileName())) {
       writeConfig(buildConfig(lNormalizedInitConfig));
     }
 
-    if (manifestIsUpdateable(lNormalizedInitConfig)) {
+    if (manifestIsUpdatable(lNormalizedInitConfig)) {
       writeRunScriptsToManifest(lNormalizedInitConfig);
     }
   }

package/src/cli/init-config/{inquirer-validators.js → validators.js}

@@ -1,12 +1,5 @@
 const fs = require("fs");
-const { toSourceLocationArray, fileExists } = require("./environment-helpers");
-
-function validateFileExistence(pInput) {
-  return (
-    fileExists(pInput) ||
-    `hmm, '${pInput}' doesn't seem to exist - could you try again?`
-  );
-}
+const { toSourceLocationArray } = require("./environment-helpers");
 
 function validateLocation(pLocations) {
   for (const lLocation of toSourceLocationArray(pLocations)) {
@@ -23,6 +16,5 @@ function validateLocation(pLocations) {
 }
 
 module.exports = {
-  validateFileExistence,
   validateLocation,
 };

package/src/cli/init-config/write-config.js

@@ -11,7 +11,7 @@ const {
  *
  * @returns {void}  Nothing
  * @param  {string} pConfig - dependency-cruiser configuration
- * @param  {string} pFileName - name of the file to write to
+ * @param  {import("fs").PathOrFileDescriptor} pFileName - name of the file to write to
  * @throws {Error}  An error object with the root cause of the problem
  *                  as a description:
  *                  - file already exists

package/src/cli/listeners/performance-log/format-helpers.js

@@ -1,30 +1,90 @@
+const chalk = require("chalk");
+
 const MS_PER_SECOND = 1000;
-const DECIMAL_BASE = 10;
-const MAX_EXPECTED_LENGTH = 9;
+const MS_PER_MICRO_SECOND = 0.001;
+const MAX_LENGTH_EXPECTED = 12;
+const NUMBER_OF_COLUMNS = 8;
 const K = 1024;
+/*
+ * using `undefined` as the first parameter to Intl.NumberFormat so
+ * it will fall back to the 'current' locale. Using a non-existent language
+ * (e.g. `zz`) also works, but `undefined`  seems to be the lesser of the two
+ * evil as it is closer to the intent (skip the optional parameter).
+ */
+// eslint-disable-next-line no-undefined
+const LOCALE = undefined;
+
+const gTimeFormat = new Intl.NumberFormat(LOCALE, {
+  style: "unit",
+  unit: "millisecond",
+  unitDisplay: "narrow",
+  maximumFractionDigits: 0,
+}).format;
+const gSizeFormat = new Intl.NumberFormat(LOCALE, {
+  signDisplay: "exceptZero",
+  style: "unit",
+  unit: "kilobyte",
+  unitDisplay: "narrow",
+  maximumFractionDigits: 0,
+}).format;
+
+const pad = (pString) => pString.padStart(MAX_LENGTH_EXPECTED).concat(" ");
 
-function formatTime(pNumber) {
-  return Math.round(MS_PER_SECOND * pNumber)
-    .toString(DECIMAL_BASE)
-    .concat("ms")
-    .padStart(MAX_EXPECTED_LENGTH);
+function formatHeader() {
+  return chalk
+    .bold(
+      `${
+        pad("elapsed real") +
+        pad("user") +
+        pad("system") +
+        pad("∆ rss") +
+        pad("∆ heapTotal") +
+        pad("∆ heapUsed") +
+        pad("∆ external")
+      }after step...\n`
+    )
+    .concat(
+      `${`${"-".repeat(MAX_LENGTH_EXPECTED)} `.repeat(NUMBER_OF_COLUMNS)}\n`
+    );
+}
+
+function formatTime(pNumber, pConversionMultiplier = MS_PER_SECOND) {
+  return gTimeFormat(pConversionMultiplier * pNumber)
+    .padStart(MAX_LENGTH_EXPECTED)
+    .concat(" ");
 }
 
 function formatMemory(pBytes) {
-  return Math.round(pBytes / K / K)
-    .toString(DECIMAL_BASE)
-    .concat("Mb")
-    .padStart(MAX_EXPECTED_LENGTH);
+  const lReturnValue = gSizeFormat(pBytes / K).padStart(MAX_LENGTH_EXPECTED);
+
+  return (pBytes < 0 ? chalk.blue(lReturnValue) : lReturnValue).concat(" ");
 }
 
-function formatPerfLine(pTime, pPreviousTime, pMessage) {
-  return `${formatTime(pTime - pPreviousTime)} ${formatMemory(
-    process.memoryUsage().heapTotal
-  )} ${formatMemory(process.memoryUsage().heapUsed)} ${pMessage}\n`;
+function formatPerfLine({
+  elapsedTime,
+  elapsedUser,
+  elapsedSystem,
+  deltaRss,
+  deltaHeapUsed,
+  deltaHeapTotal,
+  deltaExternal,
+  message,
+}) {
+  return `${
+    formatTime(elapsedTime) +
+    formatTime(elapsedUser, MS_PER_MICRO_SECOND) +
+    formatTime(elapsedSystem, MS_PER_MICRO_SECOND) +
+    formatMemory(deltaRss) +
+    formatMemory(deltaHeapTotal) +
+    formatMemory(deltaHeapUsed) +
+    formatMemory(deltaExternal) +
+    message
+  }\n`;
 }
 
 module.exports = {
   formatTime,
   formatMemory,
   formatPerfLine,
+  formatHeader,
 };