@tywalk/pcf-helper-run 1.1.13 → 1.1.15

package/__tests__/pcf-helper-run.test.js

@@ -0,0 +1,57 @@
+const { spawn } = require('child_process');
+const version = require('../package.json').version;
+
+test('displays version', (done) => {
+  const task = spawn('node', ['./index.js', '-v']);
+
+  let output = '';
+  task.stdout.on('data', (data) => {
+    output += data.toString();
+  });
+
+  task.on('close', (code) => {
+    console.log(output);
+    expect(output).toContain(version);
+    expect(code).toBe(0);
+    done();
+  });
+});
+
+
+test('errors if no path is provided', (done) => {
+  const task = spawn('node', ['./index.js', '-p']);
+
+  let output = '';
+  task.stdout.on('data', (data) => {
+    output += data.toString();
+  });
+
+  task.stderr.on('data', (data) => {
+    console.error(`stderr: ${data}`);
+  });
+
+  task.on('close', (code) => {
+    console.log(output);
+    expect(code).toBe(1);
+    done();
+  });
+});
+
+test('errors if incorrect command is provided', (done) => {
+  const task = spawn('node', ['./index.js', '-p', 'test', 'invalid']);
+
+  let output = '';
+  task.stdout.on('data', (data) => {
+    output += data.toString();
+  });
+
+  task.stderr.on('data', (data) => {
+    console.error(`stderr: ${data}`);
+  });
+
+  task.on('close', (code) => {
+    console.log(output);
+    expect(code).toBe(1);
+    done();
+  });
+});

package/index.js

@@ -2,8 +2,9 @@
 const upgradeTask = require('@tywalk/pcf-helper/tasks/upgrade-pcf');
 const buildTask = require('@tywalk/pcf-helper/tasks/build-pcf');
 const importTask = require('@tywalk/pcf-helper/tasks/import-pcf');
+const { Logger } = require('@tywalk/color-logger');
 const version = require('./package.json').version;
-const { formatMsToSec } = require('./util/performanceUtil');
+const { formatMsToSec, formatTime } = require('./util/performanceUtil');
 const [, , ...args] = process.argv;
 
 const commandArgument = args.at(0)?.toLowerCase();
@@ -12,25 +13,32 @@ if (['-v', '--version'].includes(commandArgument)) {
   return;
 }
 
-console.log('PCF Helper Run version\n', version);
+const logger = new Logger();
+
+const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
+if (typeof verboseArgument !== 'undefined') {
+  logger.setDebug(true);
+}
+
+logger.log('PCF Helper Run version\n', version);
 
 if (typeof commandArgument === 'undefined' || !['upgrade', 'build', 'import', 'deploy'].includes(commandArgument)) {
-  console.error('Command [command] (upgrade, build, import, deploy) is required.');
-  return 1;
+  logger.error('Command [command] (upgrade, build, import, deploy) is required.');
+  process.exit(1);
 }
 const runAll = commandArgument === 'deploy';
 
 const pathArgument = args.find(a => ['-p', '--path'].includes(a));
 if (typeof pathArgument === 'undefined') {
-  console.error('Path argument is required. Use --path to specify the path to solution folder.');
-  return 1;
+  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
+  process.exit(1);
 }
 
 const pathIndex = args.indexOf(pathArgument) + 1;
 const path = args.at(pathIndex);
 if (typeof path === 'undefined') {
-  console.error('Path argument is required. Use --path to specify the path to solution folder.');
-  return 1;
+  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
+  process.exit(1);
 }
 
 const tick = performance.now();
@@ -60,16 +68,19 @@ function executeTasks() {
 
 var result = 0;
 try {
+  logger.log('[PCF Helper Run] ' + formatTime(new Date()) + ' ' + commandArgument + ' started.\n');
   result = executeTasks();
   if (result === 0) {
-    console.log('[PCF Helper Run] ' + commandArgument + ' complete!');
+    logger.log('[PCF Helper Run] ' + commandArgument + ' completed successfully!');
+  } else {
+    logger.log('[PCF Helper Run] ' + commandArgument + ' completed with errors.');
   }
 } catch (e) {
-  console.error('[PCF Helper Run] One or more tasks failed while deploying: ', (e && e.message) || 'unkown error');
+  logger.error('[PCF Helper Run] One or more tasks failed while deploying: ', (e && e.message) || 'unkown error');
   result = 1;
 } finally {
   const tock = performance.now();
-  console.log(formatMsToSec('[PCF Helper Run] ' + commandArgument + ' finished in %is.', tock - tick));
+  logger.log(formatMsToSec('[PCF Helper Run] ' + formatTime(new Date()) + ' ' + commandArgument + ' finished in %is.', tock - tick));
 }
 
 return result;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@tywalk/pcf-helper-run",
-  "version": "1.1.13",
+  "version": "1.1.15",
   "description": "A simple command-line utility for building and publishing PCF controls to Dataverse.",
   "repository": {
     "url": "git+https://github.com/tywalk/pcf-helper.git"
   },
   "scripts": {
-    "test": "node test.js"
+    "test": "jest"
   },
   "keywords": [
     "pcf"
@@ -16,6 +16,10 @@
     "pcf-helper-run": "./index.js"
   },
   "dependencies": {
-    "@tywalk/pcf-helper": "^1.4.10"
+    "@tywalk/color-logger": "^1.0.0",
+    "@tywalk/pcf-helper": "^1.4.12"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0"
   }
 }

package/util/performanceUtil.js

@@ -1,10 +1,37 @@
 const util = require('node:util');
 
+var formatter = new Intl.DateTimeFormat('en-US', {
+  hour: '2-digit',
+  minute: '2-digit',
+  second: '2-digit',
+  hour12: false
+});
+
+/**
+ * Formats a number of milliseconds into seconds.
+ *
+ * @param {string} format - The string format to use when formatting the number of seconds.
+ * @param {number} ms - The number of milliseconds to be formatted.
+ *
+ * @returns {string} The formatted number of seconds.
+ */
 function formatMsToSec(format, ms) {
   const seconds = ms / 1000;
   return util.format(format, seconds);
 }
 
+/**
+ * Formats a Date object into a human-readable string.
+ *
+ * @param {Date} date - The date object to be formatted.
+ *
+ * @returns {string} The formatted string.
+ */
+function formatTime(date) {
+  return formatter.format(date);
+}
+
 module.exports = {
-  formatMsToSec
+  formatMsToSec,
+  formatTime
 }