@suitegeezus/suitecloud-cli 3.1.6-3 → 3.1.6-6

package/DELTA.md

@@ -17,7 +17,7 @@
 - `customflag` option available on any command including in interactive
 - `customoptions` option available on any command including in interactive
 - `debug` option available on any command including in interactive
-- `skiphooks` option available on any command including in interactive
+- `runhooks` option available on any command including in interactive
 
 <p align="left"><a href="#"><img width="250" src="resources/Netsuite-logo-ocean-150-bg.png"></a></p>
 

package/README.md

@@ -21,7 +21,7 @@ Read the full list of prerequisites in [SuiteCloud CLI for Node.js Installation
 ## Supported Versions
 This is a fork of `@oracle/suitecloud-cli`. It supports older command lines but with a new binary `sdf`. 
 
-It is enhanced for easier customizing via hooks. See [./DELTA.md] for more
+It is enhanced for easier customizing via hooks. See [DELTA.md](./DELTA.md) for more
 
 
 ## Installation

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@suitegeezus/suitecloud-cli",
-	"version": "3.1.6-3",
+	"version": "3.1.6-6",
 	"license": "UPL-1.0",
 	"description": "SuiteCloud CLI for Node.js",
 	"keywords": [

package/src/CLI.js

@@ -91,21 +91,22 @@ const UBIQUITOUS_OPTIONS = {
 		"defaultOption": false,
 		"disableInIntegrationMode": false
 	},
-	"skiphooks": {
-		"name": "skiphooks",
-		"option": "skiphooks",
+	"runhooks": {
+		"name": "runhooks",
+		"option": "runhooks",
 		"description": "Skip hook execution. Usage:\n" + [
-			'"--skiphooks all" (skip all)',
-			'"--skiphooks pre" (skip beforeExecuting)',
-			'"--skiphooks post" (skip onCompleted/onError)',
-			'"--skiphooks none" (skip nothing -- default)'
+			'"--runhooks all" (run all -- default)',
+			'"--runhooks pre" (run beforeExecuting only)',
+			'"--runhooks post" (run onCompleted/onError)',
+			'"--runhooks quiet" (same as all but if you are creating interactions you can use this as a clue to avoid interactions)',
+			'"--runhooks none" (run nothing)'
 		].join('\n'),
 		"allowInteractive":true,
 		"forceinclude": true,
 		"mandatory": false,
 		"type": "SINGLE",
 		"usage": "\"pre|post|all|none\"",
-		"defaultOption": "none",
+		"defaultOption": "all",
 		"disableInIntegrationMode": false
 	}
 };
@@ -157,7 +158,7 @@ module.exports = class CLI {
 				.option(
 					`${INTERACTIVE_ALIAS}, ${INTERACTIVE_OPTION}`,
 					NodeTranslationService.getMessage(INTERACTIVE_OPTION_DESCRIPTION),
-					this._validateInteractive(commandMetadataList[thirdArgument].options)
+					this._validateInteractive(commandMetadataList[thirdArgument]?.options)
 				)
 				.helpOption(`${HELP_ALIAS}, ${HELP_OPTION}`, NodeTranslationService.getMessage(COMMAND_OPTIONS.HELP))
 				.addHelpCommand(`${HELP_COMMAND} ${COMMAND_ALIAS}`, NodeTranslationService.getMessage(COMMAND_OPTIONS.HELP))
@@ -187,19 +188,21 @@ module.exports = class CLI {
 
 	_validateInteractive(additionalOptions) {
 		let additionalAllowed = 0;
-		const ubiquitousValuesThatAreInteractive = Object.values(UBIQUITOUS_OPTIONS)
-			.concat(Object.values(additionalOptions))
-			.filter((o)=>o.allowInteractive)
-			.map((o)=>({
-				name: o.name,
-				additionalAllowed: o.type === "SINGLE" ? 2 : 1
-			}))
-		process.argv.forEach((arg)=>{
-			const mactchingOption = ubiquitousValuesThatAreInteractive.find(
-				(o)=>(`--${o.name}` === arg)
-			);
-			additionalAllowed += mactchingOption?.additionalAllowed || 0;
-		});
+		if( additionalOptions) {
+			const ubiquitousValuesThatAreInteractive = Object.values(UBIQUITOUS_OPTIONS)
+				.concat(Object.values(additionalOptions))
+				.filter((o) => o.allowInteractive)
+				.map((o) => ({
+					name: o.name,
+					additionalAllowed: o.type === "SINGLE" ? 2 : 1
+				}))
+			process.argv.forEach((arg) => {
+				const mactchingOption = ubiquitousValuesThatAreInteractive.find(
+					(o) => (`--${o.name}` === arg)
+				);
+				additionalAllowed += mactchingOption?.additionalAllowed || 0;
+			});
+		}
 		return ()=> {
 			if (process.argv.length > (4 + additionalAllowed)) {
 				// There are more options apart from -i or --interactive

package/src/commands/Command.js

@@ -25,7 +25,7 @@ const NEVER_PARAMS = {
 	'CUSTOMFLAG': 'customflag',
 	'CUSTOMOPTIONS': 'customoptions',
 	'DEBUG': 'debug',
-	'SKIPHOOKS': 'skiphooks'
+	'RUNHOOKS': 'runhooks'
 };
 
 /** @type {import('./Command')} */

package/src/core/CommandActionExecutor.js

@@ -53,7 +53,8 @@ module.exports = class CommandActionExecutor {
 		let commandUserExtension;
 		const commandName = context.commandName;
 		const debugFilePath = this._getDebugFilePath(context.arguments.debug, commandName);
-		const skipHooks = context.arguments.skiphooks;
+		/** @type {'pre'|'post'|'quiet'|'none'|'all'} */
+		const runHooks = context.arguments.runhooks;
 		try {
 			const commandMetadata = this._commandsMetadataService.getCommandMetadataByName(commandName);
 			if (context.arguments.config) {
@@ -148,7 +149,7 @@ module.exports = class CommandActionExecutor {
 			process.env[ENV_VARS.SUITECLOUD_EXE] = this._binaryName;
 			// this might modified but we need the user's hooks to take advantage of their current values
 			process.env[ENV_VARS.SUITECLOUD_AUTHID] = authId;
-			const skipPre = skipHooks === 'pre' || skipHooks === 'all';
+			const skipPre = runHooks === 'post' || runHooks === 'none';
 			this._dumpDebugFile(debugFilePath, undefined, 'FIRST', runInInteractiveMode, skipPre);
 			this._dumpDebugFile(debugFilePath, 'beforeExecuting', beforeExecutingOptions, runInInteractiveMode, skipPre);
 			const beforeExecutingOutput = skipPre
@@ -180,7 +181,7 @@ module.exports = class CommandActionExecutor {
 			// command execution
 			// src/commands/Command.js, run(inputParams) => execution flow for all commands
 			const actionResult = await command.run(overriddenArguments);
-			const skipPost = skipHooks === 'post' || skipHooks === 'all';
+			const skipPost = runHooks === 'pre' || runHooks === 'none';
 
 			if (context.runInInteractiveMode) {
 				// generate non-interactive equivalent
@@ -202,7 +203,7 @@ module.exports = class CommandActionExecutor {
 
 		} catch (error) {
 			let errorMessage = this._logGenericError(error);
-			const skipPostHooksCatch = skipHooks === 'post' || skipHooks === 'all';
+			const skipPostHooksCatch = runHooks === 'pre' || runHooks === 'none';
 			if (commandUserExtension && commandUserExtension.onError) {
 				// run onError(error) from suitecloud.config.js
 				this._dumpDebugFile(debugFilePath, 'onError', error, context.runInInteractiveMode, skipPostHooksCatch);