@ds-sfdc/sfparty 1.5.2 → 1.5.4

package/.github/workflows/cicd.yaml

@@ -9,8 +9,12 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [18, 20]
     env:
       working-directory: ./
+      HUSKY: 0  # Disable Husky during the CI/CD process
     steps:
       - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
       - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
@@ -20,7 +24,7 @@ jobs:
       - name: Setup node ${{ matrix.node }}
         uses: actions/setup-node@v3
         with:
-          node-version: 19
+          node-version: ${{ matrix.node }}
           cache: 'npm'
           cache-dependency-path: '**/package-lock.json'
       - run: npm ci
@@ -35,4 +39,4 @@ jobs:
       - run: echo "🧪 Running tests ${{ job.status }}."
       - run: npm test
         working-directory: ${{env.working-directory}}
-      - run: echo "🍏 This job's status is ${{ job.status }}."
+      - run: echo "🍏 This job's status is ${{ job.status }}."

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+	"editor.formatOnPaste": true,
+	"editor.formatOnSave": true,
+	"editor.formatOnType": true
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ds-sfdc/sfparty",
-	"version": "1.5.2",
+	"version": "1.5.4",
 	"description": "Salesforce metadata XML splitter for CI/CD",
 	"type": "module",
 	"repository": {
@@ -12,7 +12,8 @@
 	},
 	"main": "src/index.js",
 	"scripts": {
-		"test": "jest"
+		"test": "jest --no-cache",
+		"prepare": "husky || true"
 	},
 	"keywords": [
 		"salesforce,metadata,xml,split,yaml,json"
@@ -20,30 +21,33 @@
 	"author": "Tim Paulaskas",
 	"license": "BSD-3-Clause",
 	"dependencies": {
-		"axios": "^1.2.2",
-		"cli-color": "^2.0.3",
-		"cli-spinners": "^2.7.0",
+		"axios": "^1.6.8",
+		"cli-color": "^2.0.4",
+		"cli-spinners": "^2.9.2",
 		"convert-hrtime": "^5.0.0",
 		"js-yaml": "^4.1.0",
-		"log-update": "^5.0.1",
-		"marked": "^4.2.12",
-		"marked-terminal": "^5.1.1",
-		"pretty-quick": "^3.1.3",
-		"semver": "^7.3.8",
-		"util": "^0.10.3",
-		"winston": "^3.8.2",
+		"log-update": "^6.0.0",
+		"marked": "^12.0.1",
+		"marked-terminal": "^7.0.0",
+		"pretty-quick": "^4.0.0",
+		"semver": "^7.6.0",
+		"util": "^0.12.5",
+		"winston": "^3.13.0",
 		"xml2js": "^0.6.2",
-		"yargs": "^17.6.2"
+		"yargs": "^17.7.2"
 	},
 	"devDependencies": {
-		"@babel/core": "^7.20.12",
-		"@babel/preset-env": "^7.20.2",
-		"@commitlint/cli": "^17.4.0",
-		"@commitlint/config-conventional": "^17.4.0",
-		"babel-jest": "^29.3.1",
-		"jest": "^29.3.1",
-		"nodemon": "^3.0.3",
-		"prettier": "^2.8.3"
+		"@babel/core": "^7.24.4",
+		"@babel/preset-env": "^7.24.4",
+		"@commitlint/cli": "^19.2.2",
+		"@commitlint/config-conventional": "^19.2.2",
+		"babel-jest": "^29.7.0",
+		"eslint": "^9.0.0",
+		"husky": "^9.0.11",
+		"jest": "^29.7.0",
+		"lint-staged": "^15.2.2",
+		"nodemon": "^3.1.0",
+		"prettier": "^3.2.5"
 	},
 	"engines": {
 		"node": ">=0.11"
@@ -55,5 +59,11 @@
 	"directories": {
 		"lib": "lib",
 		"test": "tests"
+	},
+	"lint-staged": {
+		"*.js": [
+			"eslint --fix",
+			"prettier --write"
+		]
 	}
 }

package/src/index.js

@@ -104,7 +104,7 @@ global.metaTypes = {
 let types = []
 const packageDir = getRootPath()
 
-let errorMessage = clc.red(
+const errorMessage = clc.red(
 	'Please specify the action of ' +
 		clc.whiteBright.bgRedBright('split') +
 		' or ' +
@@ -193,7 +193,7 @@ yargs(hideBin(process.argv))
 			global.format = argv.format
 			const startProm = new Promise((resolve, reject) => {
 				if (argv.git !== undefined) {
-					let gitRef = argv.git.trim()
+					const gitRef = argv.git.trim()
 					global.git.append = argv.append || global.git.append
 					global.git.delta = argv.delta || global.git.delta
 					if (argv.git === '') {
@@ -259,9 +259,9 @@ yargs(hideBin(process.argv))
 				global.git.enabled = result
 
 				if (global.git.enabled) {
-					let addManifest =
+					const addManifest =
 						argv.package || 'manifest/package-party.xml'
-					let desManifest =
+					const desManifest =
 						argv.destructive ||
 						'manifest/destructiveChanges-party.xml'
 
@@ -413,13 +413,13 @@ function yargCheck(argv, options) {
 function displayMessageAndDuration(startTime, message) {
 	const diff = process.hrtime.bigint() - BigInt(startTime)
 	let durationMessage
-	let executionTime = convertHrtime(diff)
-	let minutes = Math.floor(
+	const executionTime = convertHrtime(diff)
+	const minutes = Math.floor(
 		(executionTime.seconds +
 			Math.round(executionTime.milliseconds / 100000)) /
 			60,
 	)
-	let seconds = Math.round(
+	const seconds = Math.round(
 		(executionTime.seconds +
 			Math.round(executionTime.milliseconds / 100000)) %
 			60,
@@ -453,7 +453,7 @@ function splitHandler(argv, startTime) {
 			splitHandler(argv, startTime)
 		} else {
 			if (argv.type === undefined || argv.type.split(',').length > 1) {
-				let message = `Split completed in `
+				const message = `Split completed in `
 				displayMessageAndDuration(startTime, message)
 			}
 			checkVersion({
@@ -488,7 +488,7 @@ function processSplit(typeItem, argv) {
 		let sourceDir = argv.source || ''
 		let targetDir = argv.target || ''
 		let name = argv.name
-		let all =
+		const all =
 			argv.type === undefined || name === undefined ? true : argv.all
 
 		if (type == global.metaTypes.label.type) {
@@ -517,7 +517,7 @@ function processSplit(typeItem, argv) {
 				typeObj.definition.directory,
 			)
 		}
-		let metaDirPath = sourceDir
+		const metaDirPath = sourceDir
 
 		if (!all) {
 			let metaFilePath = path.join(metaDirPath, name)
@@ -570,15 +570,15 @@ function processSplit(typeItem, argv) {
 			})
 		})
 		Promise.allSettled(promList).then((results) => {
-			let message = `Split ${clc.bgBlackBright(
+			const message = `Split ${clc.bgBlackBright(
 				processed.current > promList.length
 					? promList.length
 					: processed.current,
 			)} file(s) ${
 				processed.errors > 0
 					? 'with ' +
-					  clc.bgBlackBright.red(processed.errors) +
-					  ' error(s) '
+						clc.bgBlackBright.red(processed.errors) +
+						' error(s) '
 					: ''
 			}in `
 			displayMessageAndDuration(startTime, message)
@@ -590,6 +590,12 @@ function processSplit(typeItem, argv) {
 function combineHandler(argv, startTime) {
 	const combine = processCombine(types[0], argv)
 	combine.then((resolve) => {
+		if (resolve == false) {
+			global.logger.error(
+				'Will not continue due to YAML format issues. Please correct and try again.',
+			)
+			process.exit(1)
+		}
 		types.shift() // remove first item from array
 		if (types.length > 0) {
 			console.log()
@@ -608,7 +614,7 @@ function combineHandler(argv, startTime) {
 				desPkg.savePackage(xml2js, fileUtils)
 			}
 			if (argv.type === undefined || argv.type.split(',').length > 1) {
-				let message = `Combine completed in `
+				const message = `Combine completed in `
 				displayMessageAndDuration(startTime, message)
 			}
 			checkVersion({
@@ -644,8 +650,8 @@ function processCombine(typeItem, argv) {
 
 		let sourceDir = argv.source || ''
 		let targetDir = argv.target || ''
-		let name = argv.name
-		let all =
+		const name = argv.name
+		const all =
 			argv.type === undefined || name === undefined ? true : argv.all
 
 		sourceDir = path.join(
@@ -685,7 +691,7 @@ function processCombine(typeItem, argv) {
 				processList.push(global.metaTypes.label.definition.root)
 			}
 		} else if (!all) {
-			let metaDirPath = path.join(sourceDir, name)
+			const metaDirPath = path.join(sourceDir, name)
 			if (!fileUtils.directoryExists({ dirPath: metaDirPath, fs })) {
 				global.logger.error('Directory not found: ' + metaDirPath)
 				process.exit(1)
@@ -747,17 +753,24 @@ function processCombine(typeItem, argv) {
 			results.forEach((result) => {
 				if (result.value == true) {
 					successes++
-				} else if (result.value == false) {
+				} else if (
+					result.value == false ||
+					result.status == 'rejected'
+				) {
 					errors++
 				}
 			})
-			let message = `Combined ${clc.bgBlackBright(successes)} file(s) ${
+			const message = `Combined ${clc.bgBlackBright(successes)} file(s) ${
 				errors > 0
-					? 'with ' + clc.bgBlackBright(errors) + 'error(s) '
+					? 'with ' + clc.bgBlackBright(errors) + ' error(s) '
 					: ''
 			}in `
 			displayMessageAndDuration(startTime, message)
-			resolve(true)
+			if (successes == 0 && errors > 0) {
+				resolve(false)
+			} else {
+				resolve(true)
+			}
 		})
 	})
 }
@@ -839,7 +852,7 @@ function displayHeader() {
 		horizontal: '─',
 		vertical: '│',
 	}
-	let versionString = `sfparty v${pkgObj.version}${
+	const versionString = `sfparty v${pkgObj.version}${
 		process.stdout.columns > pkgObj.description.length + 15
 			? ' - ' + pkgObj.description
 			: ''
@@ -876,7 +889,7 @@ function displayHeader() {
 }
 
 function getRootPath(packageDir) {
-	let rootPath = fileUtils.find('sfdx-project.json')
+	const rootPath = fileUtils.find('sfdx-project.json')
 	let defaultDir
 	if (rootPath) {
 		global.__basedir = fileUtils.fileInfo(rootPath).dirname

package/src/lib/fileUtils.js

@@ -126,11 +126,11 @@ export function saveFile(
 		fileName = fileName.replaceSpecialChars()
 		switch (format) {
 			case 'json':
-				let jsonString = JSON.stringify(json, null, '\t')
+				const jsonString = JSON.stringify(json, null, '\t')
 				fsTmp.writeFileSync(fileName, jsonString)
 				break
 			case 'yaml':
-				let doc = yaml.dump(json)
+				const doc = yaml.dump(json)
 				fsTmp.writeFileSync(fileName, doc)
 				break
 		}
@@ -151,7 +151,11 @@ export function readFile(filePath, convert = true, fsTmp = fs) {
 				flag: 'r',
 			})
 			if (convert && filePath.indexOf('.yaml') != -1) {
-				result = yaml.load(data)
+				result = yaml.load(data, {
+					onWarning: (warning) => {
+						throw new Error(`YAML parsing warning: ${warning}`)
+					},
+				})
 			} else if (convert && filePath.indexOf('.json') != -1) {
 				result = JSON.parse(data)
 			} else if (convert && filePath.indexOf('.xml') != -1) {
@@ -173,7 +177,7 @@ export function readFile(filePath, convert = true, fsTmp = fs) {
 async function convertXML(data) {
 	return new Promise((resolve, reject) => {
 		try {
-			let parser = new Parser()
+			const parser = new Parser()
 			parser.parseString(data, function (err, result) {
 				if (err) throw err
 				resolve(result)

package/src/party/combine.js

@@ -89,7 +89,7 @@ export class Combine {
 
 			if (!fileUtils.directoryExists({ dirPath: that.sourceDir, fs }))
 				reject(`Path does not exist: ${that.sourceDir}`)
-			let types = ['directories', 'singleFiles', 'main']
+			const types = ['directories', 'singleFiles', 'main']
 			types.forEach((type) => {
 				if (that.metadataDefinition[type] !== undefined) {
 					that.#types = that.#types.concat(
@@ -120,9 +120,7 @@ export class Combine {
 			that.#delta = that.metadataDefinition.delta && global.git.delta
 
 			if (that.#delta) {
-				const pathMatch = `/${that.metadataDefinition.directory}/${
-					that.#fileName.shortName
-				}/`
+				const pathMatch = `/${that.metadataDefinition.directory}/${that.#fileName.shortName}/`
 
 				// get a list of all the added files
 				that.#addedFiles = global.metaTypes[
@@ -148,10 +146,10 @@ export class Combine {
 				)
 			}
 
-			let success = processParts(that)
+			const success = processParts(that)
 			// Ensure we only match existing metadata type directory and item
 
-			if (success) {
+			if (success === true) {
 				if (
 					!that.metadataDefinition.packageTypeIsDirectory &&
 					global.git.enabled
@@ -173,6 +171,12 @@ export class Combine {
 				}
 				saveXML(that)
 				return true
+			} else if (
+				success &&
+				success.name &&
+				success.name == 'YAMLException'
+			) {
+				throw error
 			} else {
 				logUpdate(
 					that.#spinnerMessage
@@ -253,7 +257,7 @@ export class Combine {
 								`main.${global.format}`,
 							),
 						}
-						let success = processFile(that, key, fileObj, 'main')
+						const success = processFile(that, key, fileObj, 'main')
 						if (!success) {
 							throw new Error('delete XML')
 						}
@@ -281,6 +285,8 @@ export class Combine {
 			} catch (error) {
 				if (error.message == 'delete XML') {
 					return false
+				} else if (error.name == 'YAMLException') {
+					throw error
 				} else {
 					return true
 				}
@@ -471,7 +477,12 @@ export class Combine {
 			) {
 				return true
 			}
-			let result = fileUtils.readFile(fileObj.fullName)
+			let result
+			try {
+				result = fileUtils.readFile(fileObj.fullName)
+			} catch (error) {
+				throw error
+			}
 			if (
 				fileObj.fullName ==
 					path.join(
@@ -559,7 +570,7 @@ export class Combine {
 
 		function hydrateObject(that, json, key, fileObj) {
 			const sortKey = that.metadataDefinition.sortKeys[key]
-			let object = json.object
+			const object = json.object
 
 			try {
 				json[key].forEach((arrItem) => {
@@ -631,9 +642,9 @@ export class Combine {
 		}
 
 		function finishMessage(that) {
-			let executionTime = getTimeDiff(BigInt(that.#startTime))
-			let durationMessage = `${executionTime.seconds}.${executionTime.milliseconds}s`
-			let stateIcon =
+			const executionTime = getTimeDiff(BigInt(that.#startTime))
+			const durationMessage = `${executionTime.seconds}.${executionTime.milliseconds}s`
+			const stateIcon =
 				that.#errorMessage == ''
 					? global.icons.success
 					: global.icons.fail
@@ -746,7 +757,7 @@ function arrangeKeys(that, json, key = undefined) {
 
 function getTimeDiff(startTime, endTime = process.hrtime.bigint()) {
 	const diff = BigInt(endTime) - BigInt(startTime)
-	let executionTime = convertHrtime(diff)
+	const executionTime = convertHrtime(diff)
 	executionTime.seconds = Math.round(executionTime.seconds)
 	executionTime.milliseconds = Math.round(executionTime.milliseconds / 1000)
 	if (executionTime.milliseconds == 0 && executionTime.nanoseconds > 0)