@tywalk/pcf-helper-run 1.1.29 → 1.2.1

package/dist/index.js

@@ -33,121 +33,253 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var _a, _b, _c;
 Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
 const tasks = __importStar(require("@tywalk/pcf-helper"));
 const color_logger_1 = require("@tywalk/color-logger");
 const package_json_1 = require("./package.json");
 const performanceUtil_1 = require("./util/performanceUtil");
-const argumentUtil_1 = require("./util/argumentUtil");
-const [, , ...args] = process.argv;
-const commandArgument = (_b = (_a = args.at(0)) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== null && _b !== void 0 ? _b : '';
-if (['-v', '--version'].includes(commandArgument)) {
-    console.log('v%s', package_json_1.version);
-    process.exit(0);
-}
-const logger = new color_logger_1.Logger('log');
-const verboseArgument = args.find(a => ['-v', '--verbose'].includes(a));
-const isVerbose = verboseArgument !== undefined;
-if (isVerbose) {
-    logger.setDebug(true);
-}
-logger.log('PCF Helper Run version\n', package_json_1.version);
-if (typeof commandArgument === 'undefined' || !['upgrade', 'build', 'import', 'deploy', 'init'].includes(commandArgument)) {
-    logger.error('Command [command] (upgrade, build, import, deploy, init) is required.');
-    process.exit(1);
-}
-const runAll = commandArgument === 'deploy';
-const runInit = commandArgument === 'init';
-const path = (0, argumentUtil_1.getArgValue)(args, ['-p', '--path']);
-if (typeof path === 'undefined') {
-    if (runInit) {
-        logger.error('Path argument is required. Use --path to specify the PCF folder.');
+// Preprocess arguments to handle deprecated flags
+const preprocessArgs = (args) => {
+    const processed = [...args];
+    let hadDeprecatedEnv = false;
+    // Handle deprecated -env flag (single dash) by converting to --env (double dash)
+    for (let i = 0; i < processed.length; i++) {
+        if (processed[i] === '-env') {
+            hadDeprecatedEnv = true;
+            processed[i] = '--env';
+        }
+    }
+    return { args: processed, hadDeprecatedEnv };
+};
+// Preprocess arguments and track if deprecated flags were used  
+const { args: processedArgs, hadDeprecatedEnv } = preprocessArgs(process.argv.slice(2));
+process.argv = [...process.argv.slice(0, 2), ...processedArgs];
+// Configure the CLI program
+commander_1.program
+    .name('pcf-helper-run')
+    .description('A simple command-line utility for building and publishing PCF controls to Dataverse.')
+    .version(package_json_1.version);
+// Global options for commands that need them
+const addCommonOptions = (command) => {
+    return command
+        .option('-v, --verbose', 'enable verbose logging')
+        .option('-t, --timeout <milliseconds>', 'timeout in milliseconds', (value) => {
+        const num = Number(value);
+        if (isNaN(num) || num <= 0) {
+            throw new Error('Timeout must be a positive number');
+        }
+        return value;
+    });
+};
+const addPathOptions = (command) => {
+    return addCommonOptions(command)
+        .option('-p, --path <path>', 'path to solution folder')
+        .option('-e, --environment <environment>', 'environment name')
+        .option('--env <environment>', '[DEPRECATED: use -e/--environment] environment name (deprecated)');
+};
+// Helper function to resolve environment value with deprecation warning
+const resolveEnvironment = (options, logger) => {
+    // Check if deprecated --env flag was used
+    if (options.env && options.environment) {
+        logger.warn('⚠️  Both --env (deprecated) and --environment flags provided. Using --environment value.');
+        return options.environment;
+    }
+    else if (options.env) {
+        // Show deprecation warning using the proper logger
+        if (hadDeprecatedEnv) {
+            logger.warn('⚠️  The -env flag is DEPRECATED. Please use -e or --environment instead.');
+        }
+        else {
+            logger.warn('⚠️  The --env flag is DEPRECATED. Please use -e or --environment instead.');
+        }
+        return options.env;
     }
     else {
-        logger.error('Path argument is required. Use --path to specify the path to solution folder.');
+        return options.environment || '';
     }
-    process.exit(1);
-}
-const timeout = (0, argumentUtil_1.getArgValue)(args, ['-t', '--timeout']);
-if (typeof timeout !== 'undefined') {
-    const timeoutNumber = Number(timeout);
-    if (isNaN(timeoutNumber) || timeoutNumber <= 0) {
-        logger.error('Timeout argument must be a positive number representing milliseconds.');
-        process.exit(1);
+};
+// Helper function to setup logger and performance tracking
+const setupExecutionContext = (options) => {
+    const logger = new color_logger_1.Logger('log');
+    if (options.verbose) {
+        logger.setDebug(true);
     }
-}
-const tick = performance.now();
-const env = (_c = (0, argumentUtil_1.getArgValue)(args, ['-env', '--environment'])) !== null && _c !== void 0 ? _c : '';
-if (env === '' && !runInit) {
-    logger.warn('No environment specified. Defaulting to "local".');
-}
-function executeTasks() {
-    if (commandArgument === 'upgrade' || runAll) {
-        const upgradeResult = tasks.runUpgrade(path, isVerbose);
-        if (upgradeResult === 1)
-            return 1;
-    }
-    if (commandArgument === 'build' || runAll) {
-        const buildResult = tasks.runBuild(path, isVerbose, timeout ? Number(timeout) : undefined);
-        if (buildResult === 1)
-            return 1;
-    }
-    if (commandArgument === 'import' || runAll) {
-        const importResult = tasks.runImport(path, env, isVerbose, timeout ? Number(timeout) : undefined);
-        if (importResult === 1)
-            return 1;
-    }
-    if (commandArgument === 'init') {
-        const name = (0, argumentUtil_1.getArgValue)(args, ['-n', '--name']);
-        const publisherName = (0, argumentUtil_1.getArgValue)(args, ['-pn', '--publisher-name']);
-        const publisherPrefix = (0, argumentUtil_1.getArgValue)(args, ['-pp', '--publisher-prefix']);
-        const npm = (0, argumentUtil_1.getArgValue)(args, ['-npm', '--run-npm-install'], 'true');
-        if (typeof name === 'undefined') {
-            logger.error('Name argument is required. Use --name to specify the name of the control.');
-            process.exit(1);
-        }
-        if (typeof publisherName === 'undefined') {
-            logger.error('Publisher Name argument is required. Use --publisher-name to specify the name of the control.');
-            process.exit(1);
+    logger.log('PCF Helper Run version\n', package_json_1.version);
+    return { logger, tick: performance.now() };
+};
+// Helper function to execute tasks and handle results
+const executeTask = (taskName, logger, tick, result) => {
+    if (taskName !== 'session') {
+        if (result === 0) {
+            logger.log(`[PCF Helper Run] ${taskName} completed successfully!`);
         }
-        if (typeof publisherPrefix === 'undefined') {
-            logger.error('Publisher Prefix argument is required. Use --publisher-prefix to specify the name of the control.');
-            process.exit(1);
+        else {
+            logger.log(`[PCF Helper Run] ${taskName} completed with errors.`);
         }
-        const initResult = tasks.runInit(path, name, publisherName, publisherPrefix, npm === 'true', isVerbose);
-        if (initResult === 1)
-            return 1;
-    }
-    if (commandArgument === 'session') {
-        const config = tasks.loadConfig();
-        tasks.runSession(config.remoteEnvironmentUrl, config.remoteScriptToIntercept, config.remoteStylesheetToIntercept, config.localBundlePath, config.localCssPath);
-    }
-    return 0;
-}
-var result = 0;
-try {
-    logger.log('[PCF Helper Run] ' + (0, performanceUtil_1.formatTime)(new Date()) + ' ' + commandArgument + ' started.\n');
-    result = executeTasks();
-    if (commandArgument !== 'session') {
-        if (result === 0) {
-            logger.log('[PCF Helper Run] ' + commandArgument + ' completed successfully!');
+        const tock = performance.now();
+        logger.log((0, performanceUtil_1.formatMsToSec)(`[PCF Helper Run] ${(0, performanceUtil_1.formatTime)(new Date())} ${taskName} finished in %is.`, tock - tick));
+    }
+    if (taskName !== 'session' || result === 1) {
+        process.exit(result);
+    }
+};
+// Define the upgrade command
+addPathOptions(commander_1.program.command('upgrade'))
+    .description('upgrade PCF controls')
+    .action((options) => {
+    const { logger, tick } = setupExecutionContext(options);
+    if (!options.path) {
+        logger.error('Path argument is required. Use --path to specify the path to solution folder.');
+        process.exit(1);
+    }
+    let result = 0;
+    try {
+        logger.log('[PCF Helper Run] ' + (0, performanceUtil_1.formatTime)(new Date()) + ' upgrade started.\n');
+        result = tasks.runUpgrade(options.path, options.verbose || false);
+    }
+    catch (e) {
+        logger.error('[PCF Helper Run] One or more tasks failed while upgrading: ', (e && e.message) || 'unknown error');
+        result = 1;
+    }
+    executeTask('upgrade', logger, tick, result);
+});
+// Define the build command  
+addPathOptions(commander_1.program.command('build'))
+    .description('build PCF controls')
+    .action((options) => {
+    const { logger, tick } = setupExecutionContext(options);
+    if (!options.path) {
+        logger.error('Path argument is required. Use --path to specify the path to solution folder.');
+        process.exit(1);
+    }
+    let result = 0;
+    try {
+        logger.log('[PCF Helper Run] ' + (0, performanceUtil_1.formatTime)(new Date()) + ' build started.\n');
+        result = tasks.runBuild(options.path, options.verbose || false, options.timeout ? Number(options.timeout) : undefined);
+    }
+    catch (e) {
+        logger.error('[PCF Helper Run] One or more tasks failed while building: ', (e && e.message) || 'unknown error');
+        result = 1;
+    }
+    executeTask('build', logger, tick, result);
+});
+// Define the import command
+addPathOptions(commander_1.program.command('import'))
+    .description('import PCF controls')
+    .action((options) => {
+    const { logger, tick } = setupExecutionContext(options);
+    if (!options.path) {
+        logger.error('Path argument is required. Use --path to specify the path to solution folder.');
+        process.exit(1);
+    }
+    const env = resolveEnvironment(options, logger);
+    if (env === '') {
+        logger.warn('No environment specified. Defaulting to "local".');
+    }
+    let result = 0;
+    try {
+        logger.log('[PCF Helper Run] ' + (0, performanceUtil_1.formatTime)(new Date()) + ' import started.\n');
+        result = tasks.runImport(options.path, env, options.verbose || false, options.timeout ? Number(options.timeout) : undefined);
+    }
+    catch (e) {
+        logger.error('[PCF Helper Run] One or more tasks failed while importing: ', (e && e.message) || 'unknown error');
+        result = 1;
+    }
+    executeTask('import', logger, tick, result);
+});
+// Define the deploy command (runs upgrade, build, and import)
+addPathOptions(commander_1.program.command('deploy'))
+    .description('deploy PCF controls (runs upgrade, build, and import)')
+    .action((options) => {
+    const { logger, tick } = setupExecutionContext(options);
+    if (!options.path) {
+        logger.error('Path argument is required. Use --path to specify the path to solution folder.');
+        process.exit(1);
+    }
+    const env = resolveEnvironment(options, logger);
+    if (env === '') {
+        logger.warn('No environment specified. Defaulting to "local".');
+    }
+    let result = 0;
+    try {
+        logger.log('[PCF Helper Run] ' + (0, performanceUtil_1.formatTime)(new Date()) + ' deploy started.\n');
+        // Run upgrade
+        const upgradeResult = tasks.runUpgrade(options.path, options.verbose || false);
+        if (upgradeResult === 1) {
+            result = 1;
         }
         else {
-            logger.log('[PCF Helper Run] ' + commandArgument + ' completed with errors.');
+            // Run build
+            const buildResult = tasks.runBuild(options.path, options.verbose || false, options.timeout ? Number(options.timeout) : undefined);
+            if (buildResult === 1) {
+                result = 1;
+            }
+            else {
+                // Run import
+                const importResult = tasks.runImport(options.path, env, options.verbose || false, options.timeout ? Number(options.timeout) : undefined);
+                if (importResult === 1) {
+                    result = 1;
+                }
+            }
         }
     }
-}
-catch (e) {
-    logger.error('[PCF Helper Run] One or more tasks failed while deploying: ', (e && e.message) || 'unkown error');
-    result = 1;
-}
-finally {
-    if (commandArgument !== 'session' || result === 1) {
-        const tock = performance.now();
-        logger.log((0, performanceUtil_1.formatMsToSec)('[PCF Helper Run] ' + (0, performanceUtil_1.formatTime)(new Date()) + ' ' + commandArgument + ' finished in %is.', tock - tick));
+    catch (e) {
+        logger.error('[PCF Helper Run] One or more tasks failed while deploying: ', (e && e.message) || 'unknown error');
+        result = 1;
+    }
+    executeTask('deploy', logger, tick, result);
+});
+// Define the init command
+addCommonOptions(commander_1.program.command('init'))
+    .description('initialize a new PCF project')
+    .requiredOption('-p, --path <path>', 'path to PCF folder')
+    .requiredOption('-n, --name <name>', 'name of the control')
+    .requiredOption('--publisher-name <publisherName>', 'publisher name')
+    .requiredOption('--publisher-prefix <publisherPrefix>', 'publisher prefix')
+    .option('--run-npm-install', 'run npm install after initialization', true)
+    .action((options) => {
+    const { logger, tick } = setupExecutionContext(options);
+    let result = 0;
+    try {
+        logger.log('[PCF Helper Run] ' + (0, performanceUtil_1.formatTime)(new Date()) + ' init started.\n');
+        result = tasks.runInit(options.path, options.name, options.publisherName, options.publisherPrefix, options.runNpmInstall !== false, options.verbose || false);
     }
-}
-if (commandArgument !== 'session' || result === 1) {
-    process.exit(result);
-}
+    catch (e) {
+        logger.error('[PCF Helper Run] One or more tasks failed while initializing: ', (e && e.message) || 'unknown error');
+        result = 1;
+    }
+    executeTask('init', logger, tick, result);
+});
+// Define the session command
+addCommonOptions(commander_1.program.command('session'))
+    .description('run development session')
+    .option('-u, --url <url>', 'remote environment URL')
+    .option('-s, --script <script>', 'remote script to intercept')
+    .option('-t, --stylesheet <stylesheet>', 'remote stylesheet to intercept')
+    .option('-b, --bundle <path>', 'local bundle path')
+    .option('-c, --css <path>', 'local CSS path')
+    .option('-f, --config <path>', 'config file path', 'dev-config.json')
+    .action((options) => {
+    const { logger, tick } = setupExecutionContext(options);
+    let result = 0;
+    try {
+        logger.log('[PCF Helper Run] ' + (0, performanceUtil_1.formatTime)(new Date()) + ' session started.\n');
+        if (!options.url) {
+            const config = tasks.loadConfig(options.config || 'dev-config.json');
+            options.url = config.remoteEnvironmentUrl;
+            options.script = config.remoteScriptToIntercept;
+            options.stylesheet = config.remoteStylesheetToIntercept;
+            options.bundle = config.localBundlePath;
+            options.css = config.localCssPath;
+        }
+        tasks.runSession(options.url, options.script, options.stylesheet, options.bundle, options.css);
+    }
+    catch (e) {
+        logger.error('[PCF Helper Run] One or more tasks failed during session: ', (e && e.message) || 'unknown error');
+        result = 1;
+    }
+    executeTask('session', logger, tick, result);
+});
+// Parse the command line arguments
+commander_1.program.parse();

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tywalk/pcf-helper-run",
-    "version": "1.1.27",
+    "version": "1.2.1",
     "description": "A simple command-line utility for building and publishing PCF controls to Dataverse.",
     "types": "./types/",
     "files": [
@@ -25,7 +25,7 @@
     },
     "dependencies": {
         "@tywalk/color-logger": "^1.0.3",
-        "@tywalk/pcf-helper": "^1.4.26"
+        "@tywalk/pcf-helper": "^1.5.0"
     },
     "devDependencies": {
         "@types/jest": "^29.5.14",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tywalk/pcf-helper-run",
-  "version": "1.1.29",
+  "version": "1.2.1",
   "description": "A simple command-line utility for building and publishing PCF controls to Dataverse.",
   "types": "./types/",
   "files": [
@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "@tywalk/color-logger": "^1.0.3",
-    "@tywalk/pcf-helper": "^1.4.26"
+    "@tywalk/pcf-helper": "^1.5.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",