fix(#368): Apply elapsed to all logging cases

Wraps all command operations with the elapsed utility to provide consistent timing information across the entire CLI toolchain. This resolves TODO #368 completely by applying elapsed to all logging cases that require output of elapsed time.

Changes:
- parse, register, lint, print, sodg, latex commands
- java/transpile, java/resolve, java/link commands
- jeo/assemble, jeo/disassemble commands
- js/transpile, js/link commands
- docs command

Author: Vladislav Yevtushenko

src/commands/docs.js

@@ -7,6 +7,7 @@ const fs = require('fs');
 const path = require('path');
 const SaxonJS = require('saxon-js');
 const { marked } = require('marked');
+const {elapsed} = require('../elapsed');
 
 /**
  * Recursively reads all .xmir files from a directory.
@@ -125,44 +126,46 @@ function wrapHtml(name, html, css) {
  * Command to generate documentation.
  * @param {Hash} opts - All options
  */
-module.exports = async function(opts) {
-  try {
-    const input = path.resolve(opts.target, '1-parse');
-    const output = path.resolve(opts.target, 'docs');
-    fs.mkdirSync(output, {recursive: true});
-    const css = path.join(output, 'styles.css');
-    fs.writeFileSync(css, '');
-    const packages_info = {};
-    const all_xmir_htmls = [];
-    const xmirs = readXmirsRecursively(input);
-    for (const xmir of xmirs) {
-      const relative = path.relative(input, xmir);
-      const name = path.parse(xmir).name;
-      const xmir_html = createXmirHtmlBlock(xmir);
-      const html_app = path.join(output, path.dirname(relative),`${name}.html`);
-      fs.mkdirSync(path.dirname(html_app), {recursive: true});
-      fs.writeFileSync(html_app, wrapHtml(name, xmir_html, css));
-      const packages = path.dirname(relative).split(path.sep).join('.');
-      const html_package = path.join(output, `package_${packages}.html`);
-      if (!(packages in packages_info)) {
-        packages_info[packages] = {
-          xmir_htmls : [],
-          path: html_package
-        };
+module.exports = function(opts) {
+  return elapsed(async (tracked) => {
+    try {
+      const input = path.resolve(opts.target, '1-parse');
+      const output = path.resolve(opts.target, 'docs');
+      fs.mkdirSync(output, {recursive: true});
+      const css = path.join(output, 'styles.css');
+      fs.writeFileSync(css, '');
+      const packages_info = {};
+      const all_xmir_htmls = [];
+      const xmirs = readXmirsRecursively(input);
+      for (const xmir of xmirs) {
+        const relative = path.relative(input, xmir);
+        const name = path.parse(xmir).name;
+        const xmir_html = createXmirHtmlBlock(xmir);
+        const html_app = path.join(output, path.dirname(relative),`${name}.html`);
+        fs.mkdirSync(path.dirname(html_app), {recursive: true});
+        fs.writeFileSync(html_app, wrapHtml(name, xmir_html, css));
+        const packages = path.dirname(relative).split(path.sep).join('.');
+        const html_package = path.join(output, `package_${packages}.html`);
+        if (!(packages in packages_info)) {
+          packages_info[packages] = {
+            xmir_htmls : [],
+            path: html_package
+          };
+        }
+        packages_info[packages].xmir_htmls.push(xmir_html);
+        all_xmir_htmls.push(xmir_html);
       }
-      packages_info[packages].xmir_htmls.push(xmir_html);
-      all_xmir_htmls.push(xmir_html);
-    }
-    for (const package_name of Object.keys(packages_info)) {
-      fs.mkdirSync(path.dirname(packages_info[package_name].path), {recursive: true});
-      fs.writeFileSync(packages_info[package_name].path,
-        generatePackageHtml(`${package_name} package`, packages_info[package_name].xmir_htmls, css));
+      for (const package_name of Object.keys(packages_info)) {
+        fs.mkdirSync(path.dirname(packages_info[package_name].path), {recursive: true});
+        fs.writeFileSync(packages_info[package_name].path,
+          generatePackageHtml(`${package_name} package`, packages_info[package_name].xmir_htmls, css));
+      }
+      const packages = path.join(output, 'packages.html');
+      fs.writeFileSync(packages, generatePackageHtml('overall package', all_xmir_htmls, css));
+      tracked.print(`Documentation generation completed in the ${output} directory`);
+    } catch (error) {
+      console.error('Error generating documentation:', error);
+      throw error;
     }
-    const packages = path.join(output, 'packages.html');
-    fs.writeFileSync(packages, generatePackageHtml('overall package', all_xmir_htmls, css));
-    console.info('Documentation generation completed in the %s directory', output);
-  } catch (error) {
-    console.error('Error generating documentation:', error);
-    throw error;
-  }
+  });
 };

src/commands/java/link.js

@@ -5,16 +5,19 @@
 
 const rel = require('relative');
 const {mvnw, flags} = require('../../mvnw');
+const {elapsed} = require('../../elapsed');
 const path = require('path');
 
 /**
  * Command to link binaries into a single executable binary.
  * @param {Object} opts - All options
  * @return {Promise} of link task
  */
-module.exports = async function(opts) {
+module.exports = function(opts) {
   const jar = path.resolve(opts.target, 'eoc.jar');
-  const r = await mvnw(['jar:jar', 'shade:shade'].concat(flags(opts)), opts.target, opts.batch);
-  console.info('Executable JAR created at %s', rel(jar));
-  return r;
+  return elapsed(async (tracked) => {
+    const r = await mvnw(['jar:jar', 'shade:shade'].concat(flags(opts)), opts.target, opts.batch);
+    tracked.print(`Executable JAR created at ${rel(jar)}`);
+    return r;
+  });
 };

src/commands/java/resolve.js

@@ -5,19 +5,22 @@
 
 const rel = require('relative');
 const {mvnw, flags} = require('../../mvnw');
+const {elapsed} = require('../../elapsed');
 const path = require('path');
 
 /**
  * Command to resolve all the dependencies for compilation.
  * @param {Object} opts - All options
  * @return {Promise} of resolve task
  */
-module.exports = async function(opts) {
-  await mvnw(['eo:resolve'].concat(flags(opts)), opts.target, opts.batch);
-  const sources = path.resolve(opts.target, 'eo/6-resolve');
-  console.info('Dependencies resolved in %s', rel(sources));
-  const r = await mvnw(['eo:place'].concat(flags(opts)), opts.target, opts.batch);
-  const classes = path.resolve(opts.target, 'classes');
-  console.info('Dependencies placed in %s', rel(classes));
-  return r;
+module.exports = function(opts) {
+  return elapsed(async (tracked) => {
+    await mvnw(['eo:resolve'].concat(flags(opts)), opts.target, opts.batch);
+    const sources = path.resolve(opts.target, 'eo/6-resolve');
+    console.info('Dependencies resolved in %s', rel(sources));
+    const r = await mvnw(['eo:place'].concat(flags(opts)), opts.target, opts.batch);
+    const classes = path.resolve(opts.target, 'classes');
+    tracked.print(`Dependencies placed in ${rel(classes)}`);
+    return r;
+  });
 };

src/commands/java/transpile.js

@@ -5,16 +5,19 @@
 
 const rel = require('relative');
 const {mvnw, flags} = require('../../mvnw');
+const {elapsed} = require('../../elapsed');
 const path = require('path');
 
 /**
  * Command to transpile XMIR files into target language.
  * @param {Object} opts - All options
  * @return {Promise} of transpile task
  */
-module.exports = async function(opts) {
+module.exports = function(opts) {
   const sources = path.resolve(opts.target, 'generated-sources');
-  const r = await mvnw(['eo:transpile'].concat(flags(opts)), opts.target, opts.batch);
-  console.info('Java sources generated in %s', rel(sources));
-  return r;
+  return elapsed(async (tracked) => {
+    const r = await mvnw(['eo:transpile'].concat(flags(opts)), opts.target, opts.batch);
+    tracked.print(`Java sources generated in ${rel(sources)}`);
+    return r;
+  });
 };

src/commands/jeo/assemble.js

@@ -5,29 +5,31 @@
 
 const rel = require('relative');
 const {mvnw, flags} = require('../../mvnw');
+const {elapsed} = require('../../elapsed');
 const path = require('path');
 
 /**
  * Assemble .xmir files from .class files.
  * @param {Object} opts - All options
  * @return {Promise} of assemble task
  */
-module.exports = async function(opts) {
-  const r = await mvnw(
-    ['jeo:assemble']
-      .concat(flags(opts))
-      .concat(
-        [
-          `-Djeo.version=${opts.jeoVersion}`,
-          `-Djeo.assemble.sourcesDir=${path.resolve(opts.target, opts.xmirs)}`,
-          `-Djeo.assemble.outputDir=${path.resolve(opts.target, opts.classes)}`,
-        ]
-      ),
-    opts.target, opts.batch
-  );
-  console.info(
-    'EO .xmir files from %s assembled to .class files in %s',
-    rel(opts.xmirs), rel(opts.classes)
-  );
-  return r;
+module.exports = function(opts) {
+  return elapsed(async (tracked) => {
+    const r = await mvnw(
+      ['jeo:assemble']
+        .concat(flags(opts))
+        .concat(
+          [
+            `-Djeo.version=${opts.jeoVersion}`,
+            `-Djeo.assemble.sourcesDir=${path.resolve(opts.target, opts.xmirs)}`,
+            `-Djeo.assemble.outputDir=${path.resolve(opts.target, opts.classes)}`,
+          ]
+        ),
+      opts.target, opts.batch
+    );
+    tracked.print(
+      `EO .xmir files from ${rel(opts.xmirs)} assembled to .class files in ${rel(opts.classes)}`
+    );
+    return r;
+  });
 };

src/commands/jeo/disassemble.js

@@ -5,29 +5,31 @@
 
 const rel = require('relative');
 const {mvnw, flags} = require('../../mvnw');
+const {elapsed} = require('../../elapsed');
 const path = require('path');
 
 /**
  * Disassemble .class files to .xmir files.
  * @param {Object} opts - All options
  * @return {Promise} of disassemble task
  */
-module.exports = async function(opts) {
-  const r = await mvnw(
-    ['jeo:disassemble']
-      .concat(flags(opts))
-      .concat(
-        [
-          `-Djeo.version=${opts.jeoVersion}`,
-          `-Djeo.disassemble.sourcesDir=${path.resolve(opts.target, opts.classes)}`,
-          `-Djeo.disassemble.outputDir=${path.resolve(opts.target, opts.xmirs)}`,
-        ]
-      ),
-    opts.target, opts.batch
-  );
-  console.info(
-    'Bytecode .class files from %s disassembled to .xmir files in %s',
-    rel(opts.classes), rel(opts.xmirs)
-  );
-  return r;
+module.exports = function(opts) {
+  return elapsed(async (tracked) => {
+    const r = await mvnw(
+      ['jeo:disassemble']
+        .concat(flags(opts))
+        .concat(
+          [
+            `-Djeo.version=${opts.jeoVersion}`,
+            `-Djeo.disassemble.sourcesDir=${path.resolve(opts.target, opts.classes)}`,
+            `-Djeo.disassemble.outputDir=${path.resolve(opts.target, opts.xmirs)}`,
+          ]
+        ),
+      opts.target, opts.batch
+    );
+    tracked.print(
+      `Bytecode .class files from ${rel(opts.classes)} disassembled to .xmir files in ${rel(opts.xmirs)}`
+    );
+    return r;
+  });
 };

src/commands/js/link.js

@@ -6,16 +6,19 @@
 const rel = require('relative');
 const path = require('path');
 const eo2jsw = require('../../eo2jsw');
+const {elapsed} = require('../../elapsed');
 const {program} = require('commander');
 
 /**
  * Command to create and build NPM project.
  * @param {Object} opts - All options
  * @return {Promise} of link task
  */
-module.exports = async function(opts) {
-  const tests = program.args[0] === 'test' || Boolean(opts.tests);
-  const r = await eo2jsw('link', { ...opts, alone: true, project: 'project', tests });
-  console.info(`NPM project generated in ${rel(path.resolve(opts.target, 'project'))}`);
-  return r;
+module.exports = function(opts) {
+  return elapsed(async (tracked) => {
+    const tests = program.args[0] === 'test' || Boolean(opts.tests);
+    const r = await eo2jsw('link', { ...opts, alone: true, project: 'project', tests });
+    tracked.print(`NPM project generated in ${rel(path.resolve(opts.target, 'project'))}`);
+    return r;
+  });
 };

src/commands/js/transpile.js

@@ -5,15 +5,18 @@
 
 const rel = require('relative');
 const eo2jsw = require('../../eo2jsw');
+const {elapsed} = require('../../elapsed');
 const path = require('path');
 
 /**
  * Command to transpile XMIR files into target language.
  * @param {Object} opts - All options
  * @return {Promise} of transpile task
  */
-module.exports = async function(opts) {
-  const r = await eo2jsw('transpile', { ...opts, alone: true, project: 'project' });
-  console.info(`JS sources generated in ${rel(path.resolve(opts.target, 'project'))}`);
-  return r;
+module.exports = function(opts) {
+  return elapsed(async (tracked) => {
+    const r = await eo2jsw('transpile', { ...opts, alone: true, project: 'project' });
+    tracked.print(`JS sources generated in ${rel(path.resolve(opts.target, 'project'))}`);
+    return r;
+  });
 };

src/commands/latex.js

@@ -5,6 +5,7 @@
 
 const rel = require('relative');
 const {mvnw, flags} = require('../mvnw');
+const {elapsed} = require('../elapsed');
 const path = require('path');
 const fs = require('fs');
 
@@ -13,9 +14,11 @@ const fs = require('fs');
  * @param {Object} opts - All options
  * @return {Promise} of latex generation task
  */
-module.exports = async function(opts) {
+module.exports = function(opts) {
   const latex = path.resolve(opts.target, 'latex');
-  const r = await mvnw(['eo:latex'].concat(flags(opts)), opts.target, opts.batch);
-  console.info('LaTeX files generated in %s', rel(latex));
-  return r;
+  return elapsed(async (tracked) => {
+    const r = await mvnw(['eo:latex'].concat(flags(opts)), opts.target, opts.batch);
+    tracked.print(`LaTeX files generated in ${rel(latex)}`);
+    return r;
+  });
 };