@tywalk/pcf-helper 1.4.11 → 1.4.13

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

@@ -0,0 +1,41 @@
+const { spawn } = require('child_process');
+const version = require('../package.json').version;
+
+test('build displays version', (done) => {
+  const task = spawn('node', ['./bin/build.js', '-v']);
+
+  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(output).toContain(version);
+    expect(code).toBe(0);
+    done();
+  });
+});
+
+test('build errors if no path is provided', (done) => {
+  const task = spawn('node', ['./bin/build.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();
+  });
+});

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

@@ -0,0 +1,37 @@
+const { spawn } = require('child_process');
+const version = require('../package.json').version;
+
+test('deploy displays version', (done) => {
+  const task = spawn('node', ['./bin/deploy.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('deploy errors if no path is provided', (done) => {
+  const task = spawn('node', ['./bin/deploy.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();
+  });
+});

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

@@ -0,0 +1,37 @@
+const { spawn } = require('child_process');
+const version = require('../package.json').version;
+
+test('import displays version', (done) => {
+  const task = spawn('node', ['./bin/import.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('import errors if no path is provided', (done) => {
+  const task = spawn('node', ['./bin/import.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();
+  });
+});

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

@@ -0,0 +1,37 @@
+const { spawn } = require('child_process');
+const version = require('../package.json').version;
+
+test('upgrade displays version', (done) => {
+  const task = spawn('node', ['./bin/upgrade.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('upgrade errors if no path is provided', (done) => {
+  const task = spawn('node', ['./bin/upgrade.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();
+  });
+});

package/bin/build.js

@@ -1,21 +1,33 @@
 #!/usr/bin/env node
 const task  = require('../tasks/build-pcf');
 const version = require('../package.json').version;
+const logger = require('@tywalk/color-logger').default;
 const [, , ...args] = process.argv;
 
-console.log('PCF Helper version', version);
+const commandArgument = args.at(0)?.toLowerCase();
+if (['-v', '--version'].includes(commandArgument)) {
+  console.log('v%s', version);
+  process.exit(0);
+}
+
+const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
+if (typeof verboseArgument !== 'undefined') {
+  logger.setDebug(true);
+}
+
+logger.log('PCF Helper version', version);
 
 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 0;
+  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 0;
+  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
+  process.exit(1);
 }
 
 task.run(path);

package/bin/deploy.js

@@ -4,21 +4,33 @@ const buildTask = require('../tasks/build-pcf');
 const importTask = require('../tasks/import-pcf');
 const { formatMsToSec } = require('../util/performanceUtil');
 const version = require('../package.json').version;
+const logger = require('@tywalk/color-logger').default;
 const [, , ...args] = process.argv;
 
-console.log('PCF Helper version', version);
+const commandArgument = args.at(0)?.toLowerCase();
+if (['-v', '--version'].includes(commandArgument)) {
+  console.log('v%s', version);
+  return;
+}
+
+const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
+if (typeof verboseArgument !== 'undefined') {
+  logger.setDebug(true);
+}
+
+logger.log('PCF Helper version', version);
 
 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();
@@ -44,14 +56,14 @@ var result = 0;
 try {
   result = executeTasks();
   if (result === 0) {
-    console.log('Deploy complete!');
+    logger.log('Deploy complete!');
   }
 } catch (e) {
-  console.error('One or more tasks failed while deploying: ', (e && e.message) || 'unkown error');
+  logger.error('One or more tasks failed while deploying: ', (e && e.message) || 'unkown error');
   result = 1;
 } finally {
   const tock = performance.now();
-  console.log(formatMsToSec('Deploy finished in %is.', tock - tick));
+  logger.log(formatMsToSec('Deploy finished in %is.', tock - tick));
 }
 
 return result;

package/bin/import.js

@@ -1,21 +1,33 @@
 #!/usr/bin/env node
 const task = require('../tasks/import-pcf');
 const version = require('../package.json').version;
+const logger = require('@tywalk/color-logger').default;
 const [, , ...args] = process.argv;
 
-console.log('PCF Helper version', version);
+const commandArgument = args.at(0)?.toLowerCase();
+if (['-v', '--version'].includes(commandArgument)) {
+  console.log('v%s', version);
+  return;
+}
+
+const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
+if (typeof verboseArgument !== 'undefined') {
+  logger.setDebug(true);
+}
+
+logger.log('PCF Helper version', version);
 
 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 0;
+  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 0;
+  logger.error('Path argument is required. Use --path to specify the path to solution folder.');
+  process.exit(1);
 }
 
 const envArgument = args.find(a => ['-env', '--environment'].includes(a));

package/bin/upgrade.js

@@ -1,21 +1,33 @@
 #!/usr/bin/env node
 const task = require('../tasks/upgrade-pcf');
 const version = require('../package.json').version;
+const logger = require('@tywalk/color-logger').default;
 const [, , ...args] = process.argv;
 
-console.log('PCF Helper version', version);
+const commandArgument = args.at(0)?.toLowerCase();
+if (['-v', '--version'].includes(commandArgument)) {
+  console.log('v%s', version);
+  return;
+}
+
+const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
+if (typeof verboseArgument !== 'undefined') {
+  logger.setDebug(true);
+}
+
+logger.log('PCF Helper version', version);
 
 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);
 }
 
 task.run(path);

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@tywalk/pcf-helper",
-  "version": "1.4.11",
+  "version": "1.4.13",
   "description": "Command line helper for building and publishing PCF controls to Dataverse.",
   "repository": {
-    "url": "https://github.com/tywalk/pcf-helper"
+    "url": "git+https://github.com/tywalk/pcf-helper.git"
   },
   "scripts": {
-    "test": "node test.js"
+    "test": "jest"
   },
   "keywords": [
     "pcf"
@@ -17,5 +17,11 @@
     "pcf-helper-build": "bin/build.js",
     "pcf-helper-import": "bin/import.js",
     "pcf-helper-deploy": "bin/deploy.js"
+  },
+  "dependencies": {
+    "@tywalk/color-logger": "^1.0.1"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0"
   }
 }

package/tasks/build-pcf.js

@@ -1,8 +1,16 @@
 const { spawnSync } = require('child_process');
 const { formatMsToSec, formatTime } = require('../util/performanceUtil');
+const logger = require('@tywalk/color-logger').default;
 
+/**
+ * Builds the Power Apps component framework project.
+ *
+ * @param {string} path The path to the project folder containing the pcfproj.json file.
+ *
+ * @returns {number} The exit code of the spawned process.
+ */
 function run(path) {
-  console.log('[PCF Helper] ' + formatTime(new Date()) + ' Starting build...\n');
+  logger.log('[PCF Helper] ' + formatTime(new Date()) + ' Starting build...\n');
   const tick = performance.now();
   const task = spawnSync('dotnet build', ['--restore', '-c', 'Release', path], {
     cwd: process.cwd(),
@@ -13,20 +21,20 @@ function run(path) {
   const tock = performance.now();
 
   if (task.status === 0) {
-    console.log('[PCF Helper] Build complete!');
-    console.log(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Build finished in %is.\n', tock - tick));
+    logger.success('[PCF Helper] Build complete!');
+    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Build finished in %is.\n', tock - tick));
   } else {
     if (task.error) {
       if (task.signal === 'SIGTERM') {
-        console.error('[PCF Helper] Unable to complete build. A timeout of 5 minutes was reached.', task.error.message);
+        logger.error('[PCF Helper] Unable to complete build. A timeout of 5 minutes was reached.', task.error.message);
       } else {
-        console.error('[PCF Helper] Unable to complete build: ', task.signal, task.error.message);
+        logger.error('[PCF Helper] Unable to complete build: ', task.signal, task.error.message);
       }
-      console.debug('[PCF Helper] Error details: ', task.signal, task.error.stack);
+      logger.debug('[PCF Helper] Error details: ', task.signal, task.error.stack);
     } else {
-      console.error('[PCF Helper] Unable to complete build: One or more errors ocurred.');
+      logger.error('[PCF Helper] Unable to complete build: One or more errors ocurred.');
     }
-    console.log(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Build finished with errors in %is.\n', tock - tick));
+    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Build finished with errors in %is.\n', tock - tick));
   }
   return task.status;
 }

package/tasks/import-pcf.js

@@ -1,13 +1,24 @@
 const { spawnSync } = require('child_process');
 const { join, extname } = require('path');
 const fs = require('fs');
+const logger = require('@tywalk/color-logger').default;
 const { formatMsToSec, formatTime } = require('../util/performanceUtil');
 
+/**
+ * Imports a PCF solution into a specified Dataverse environment.
+ *
+ * @param {string} path - The path to the solution folder containing the build output.
+ * @param {string} env - The environment identifier (GUID or URL) where the solution will be imported.
+ * @param {boolean} verbose - If true, additional debug information is logged.
+ *
+ * @returns {number} The exit status of the import process.
+ */
+
 function run(path, env, verbose) {
-  console.log('[PCF Helper] ' + formatTime(new Date()) + ' Starting import...\n');
+  logger.log('[PCF Helper] ' + formatTime(new Date()) + ' Starting import...\n');
   const tick = performance.now();
   if (!env) {
-    console.warn('Path argument not provided. Assuming active auth profile organization.');
+    logger.warn('Path argument not provided. Assuming active auth profile organization.');
   }
 
   const zipDirPath = join(path, '/bin/release');
@@ -25,22 +36,22 @@ function run(path, env, verbose) {
   const tock = performance.now();
 
   if (task.status === 0) {
-    console.log('[PCF Helper] Import complete!');
-    console.log(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Import finished in %is.\n', tock - tick));
+    logger.success('[PCF Helper] Import complete!');
+    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Import finished in %is.\n', tock - tick));
   } else {
     if (task.error) {
       if (task.signal === 'SIGTERM') {
-        console.error('[PCF Helper] Unable to complete import. A timeout of 5 minutes was reached.', task.error.message);
+        logger.error('[PCF Helper] Unable to complete import. A timeout of 5 minutes was reached.', task.error.message);
       } else {
-        console.error('[PCF Helper] Unable to complete import:', task.signal, task.error.message);
+        logger.error('[PCF Helper] Unable to complete import:', task.signal, task.error.message);
       }
       if (verbose) {
-        console.debug('[PCF Helper] Error details:', task.signal, task.error.stack);
+        logger.debug('[PCF Helper] Error details:', task.signal, task.error.stack);
       }
     } else {
-      console.error('[PCF Helper] Unable to complete import: One or more errors ocurred.');
+      logger.error('[PCF Helper] Unable to complete import: One or more errors ocurred.');
     }
-    console.log(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Import finished with errors in %is.\n', tock - tick));
+    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Import finished with errors in %is.\n', tock - tick));
   }
   return task.status;
 }

package/tasks/upgrade-pcf.js

@@ -1,8 +1,16 @@
 const { spawnSync } = require('child_process');
 const { formatMsToSec, formatTime } = require('../util/performanceUtil');
+const logger = require('@tywalk/color-logger').default;
 
+/**
+ * Upgrades the Power Apps component framework project.
+ *
+ * @param {string} path The path to the project folder containing the pcfproj.json file.
+ *
+ * @returns {number} The exit code of the spawned process.
+ */
 function run(path) {
-  console.log('[PCF Helper] ' + formatTime(new Date()) + ' Starting upgrade...\n');
+  logger.log('[PCF Helper] ' + formatTime(new Date()) + ' Starting upgrade...\n');
   const tick = performance.now();
   const task = spawnSync(`pac solution version -s Solution -sp ${path} && pac pcf version -s Manifest && npm version patch --no-git-tag-version`, {
     cwd: process.cwd(),
@@ -13,20 +21,20 @@ function run(path) {
   const tock = performance.now();
 
   if (task.status === 0) {
-    console.log('[PCF Helper] Upgrade complete!');
-    console.log(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Upgrade finished in %is.\n', tock - tick));
+    logger.success('[PCF Helper] Upgrade complete!');
+    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Upgrade finished in %is.\n', tock - tick));
   } else {
     if (task.error) {
       if (task.signal === 'SIGTERM') {
-        console.error('[PCF Helper] Unable to complete upgrade. A timeout of 1 minutes was reached.', task.error.message);
+        logger.error('[PCF Helper] Unable to complete upgrade. A timeout of 1 minutes was reached.', task.error.message);
       } else {
-        console.error('[PCF Helper] Unable to complete upgrade:', task.signal, task.error.message);
+        logger.error('[PCF Helper] Unable to complete upgrade:', task.signal, task.error.message);
       }
-      console.debug('[PCF Helper] Error details:', task.signal, task.error.stack);
+      logger.debug('[PCF Helper] Error details:', task.signal, task.error.stack);
     } else {
-      console.error('[PCF Helper] Unable to complete upgrade: One or more errors ocurred.');
+      logger.error('[PCF Helper] Unable to complete upgrade: One or more errors ocurred.');
     }
-    console.log(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Upgrade finished with errors in %is.\n', tock - tick));
+    logger.debug(formatMsToSec('[PCF Helper] ' + formatTime(new Date()) + ' Upgrade finished with errors in %is.\n', tock - tick));
   }
   return task.status;
 }

package/util/performanceUtil.js

@@ -7,11 +7,26 @@ var formatter = new Intl.DateTimeFormat('en-US', {
   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);
 }