@ds-sfdc/sfparty 1.3.9 → 1.3.11

package/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm test

package/README.md

@@ -38,6 +38,10 @@ sfparty split
 sfparty combine
 ```
 
+### Update
+```bash
+sfparty update
+```
 ### Options
 
 ```
@@ -48,6 +52,7 @@ sfparty combine
 -t, --target   target path to directory to create yaml/json files  
 -g, --git      combine files based on git commits
 -h, --help     Show help  
+-v, --version  Show version
 ```
 
 ### Combine Options

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ds-sfdc/sfparty",
-  "version": "1.3.9",
+  "version": "1.3.11",
   "description": "Salesforce metadata XML splitter for CI/CD",
   "type": "module",
   "repository": {

package/src/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict'
-import { spawnSync } from 'child_process'
-import { readFileSync } from 'fs'
+import { spawnSync, spawn, execSync } from 'child_process'
+import fs from 'fs'
 import path from 'path'
 import yargs from 'yargs'
 import { hideBin } from 'yargs/helpers'
@@ -66,8 +66,8 @@ const typeArray = ['label', 'profile', 'permset', 'workflow']
 
 global.git = {
 	enabled: false,
-	last: undefined,
-	latest: undefined,
+	lastCommit: undefined,
+	latestCommit: undefined,
 	append: false,
 	delta: false,
 }
@@ -104,20 +104,25 @@ const packageDir = getRootPath()
 
 let errorMessage = clc.red(
 	'Please specify the action of ' +
-	clc.whiteBright.bgRedBright('split') +
-	' or ' +
-	clc.whiteBright.bgRedBright('combine') +
-	'.',
+		clc.whiteBright.bgRedBright('split') +
+		' or ' +
+		clc.whiteBright.bgRedBright('combine') +
+		'.',
 )
 
 displayHeader() // display header mast
 
+let checkYargs = false
+
 yargs(hideBin(process.argv))
 	.command({
 		command: 'help',
 		alias: 'h',
+		builder: (yargs) => {
+			yargs.check(yargCheck)
+		},
 		handler: (argv) => {
-			const data = readFileSync(
+			const data = fs.readFileSync(
 				path.join(process.cwd(), 'README.md'),
 				'utf8',
 			)
@@ -126,6 +131,9 @@ yargs(hideBin(process.argv))
 	})
 	.command({
 		command: '[test]',
+		builder: (yargs) => {
+			yargs.check(yargCheck)
+		},
 		alias: 'test',
 		handler: (argv) => {
 			// THIS IS A PLACE TO TEST NEW CODE
@@ -151,13 +159,6 @@ yargs(hideBin(process.argv))
 			})
 		},
 	})
-	.command({
-		command: '[version]',
-		alias: 'version',
-		builder: (yargs) => {
-			yargs.check(yargCheck)
-		},
-	})
 	.command({
 		command: '[split]',
 		alias: 'split',
@@ -193,12 +194,17 @@ yargs(hideBin(process.argv))
 					global.git.append = argv.append || global.git.append
 					global.git.delta = argv.delta || global.git.delta
 					if (argv.git === '') {
-						const commit = git.lastCommit(global.__basedir, '-1')
+						const commit = git.lastCommit({
+							dir: global.__basedir,
+							existsSync: fs.existsSync,
+							execSync,
+							fileUtils,
+						})
 						commit
 							.then((data, error) => {
-								global.git.latest = data.latestCommit
-								global.git.last = data.lastCommit
-								if (data.last === undefined) {
+								global.git.latestCommit = data.latestCommit
+								global.git.lastCommit = data.lastCommit
+								if (data.lastCommit === undefined) {
 									gitMode({ status: 'not active' })
 									resolve(false)
 								} else {
@@ -207,10 +213,12 @@ yargs(hideBin(process.argv))
 										lastCommit: data.lastCommit,
 										latestCommit: data.latestCommit,
 									})
-									const diff = git.diff(
-										global.__basedir,
-										`${data.lastCommit}..${data.latestCommit}`,
-									)
+									const diff = git.diff({
+										dir: global.__basedir,
+										gitRef: `${data.lastCommit}..${data.latestCommit}`,
+										existsSync: fs.existsSync,
+										spawn,
+									})
 									diff.then((data, error) => {
 										gitFiles(data)
 										resolve(true)
@@ -226,7 +234,12 @@ yargs(hideBin(process.argv))
 							})
 					} else {
 						gitMode({ status: 'active', gitRef })
-						const diff = git.diff(global.__basedir, gitRef)
+						const diff = git.diff({
+							dir: global.__basedir,
+							gitRef,
+							existsSync: fs.existsSync,
+							spawn,
+						})
 						diff.then((data, error) => {
 							gitFiles(data)
 							resolve(true)
@@ -255,7 +268,16 @@ yargs(hideBin(process.argv))
 		['$0 combine --type=permset --all'],
 		['$0 combine --type=permset --name="Permission Set Name"'],
 	])
-	.help(false).argv.parse
+	.help(false)
+	.version(false)
+
+if (!checkYargs)
+	checkVersion({
+		axios,
+		spawnSync,
+		currentVersion: pkgObj.version,
+		update: false,
+	})
 
 function gitMode({ status, gitRef, lastCommit, latestCommit }) {
 	let statusMessage
@@ -266,10 +288,11 @@ function gitMode({ status, gitRef, lastCommit, latestCommit }) {
 	} else {
 		statusMessage = clc.magentaBright('active:')
 		if (gitRef === undefined) {
-			displayMessage = `${clc.bgBlackBright(lastCommit) +
+			displayMessage = `${
+				clc.bgBlackBright(lastCommit) +
 				'..' +
 				clc.bgBlackBright(latestCommit)
-				}`
+			}`
 		} else {
 			let delimiter = '..'
 
@@ -289,6 +312,7 @@ function gitMode({ status, gitRef, lastCommit, latestCommit }) {
 }
 
 function yargCheck(argv, options) {
+	checkYargs = true
 	const argvKeys = Object.keys(argv)
 	const invalidKeys = argvKeys.filter(
 		(key) =>
@@ -331,8 +355,8 @@ function yargCheck(argv, options) {
 			throw new Error(
 				clc.redBright(
 					'You cannot specify ' +
-					clc.whiteBright.bgRedBright('--name') +
-					' when using multiple types.',
+						clc.whiteBright.bgRedBright('--name') +
+						' when using multiple types.',
 				),
 			)
 		}
@@ -343,8 +367,8 @@ function yargCheck(argv, options) {
 					throw new Error(
 						clc.redBright(
 							'You cannot specify ' +
-							clc.whiteBright.bgRedBright('--name') +
-							'  when using label.',
+								clc.whiteBright.bgRedBright('--name') +
+								'  when using label.',
 						),
 					)
 				}
@@ -361,12 +385,12 @@ function displayMessageAndDuration(startTime, message) {
 	let minutes = Math.floor(
 		(executionTime.seconds +
 			Math.round(executionTime.milliseconds / 100000)) /
-		60,
+			60,
 	)
 	let seconds = Math.round(
 		(executionTime.seconds +
 			Math.round(executionTime.milliseconds / 100000)) %
-		60,
+			60,
 	)
 	if (minutes == 0 && seconds == 0) {
 		durationMessage = message + clc.magentaBright(`<1s`)
@@ -459,17 +483,17 @@ function processSplit(typeItem, argv) {
 
 		if (!all) {
 			let metaFilePath = path.join(metaDirPath, name)
-			if (!fileUtils.fileExists(metaFilePath)) {
+			if (!fileUtils.fileExists({ filePath: metaFilePath, fs })) {
 				name += metaExtension
 				metaFilePath = path.join(metaDirPath, name)
-				if (!fileUtils.fileExists(metaFilePath)) {
+				if (!fileUtils.fileExists({ filePath: metaFilePath, fs })) {
 					global.logger.error('File not found: ' + metaFilePath)
 					process.exit(1)
 				}
 			}
 			fileList.push(name)
 		} else {
-			if (fileUtils.directoryExists(sourceDir)) {
+			if (fileUtils.directoryExists({ dirPath: sourceDir, fs })) {
 				fileUtils.getFiles(sourceDir, metaExtension).forEach((file) => {
 					fileList.push(file)
 				})
@@ -512,12 +536,13 @@ function processSplit(typeItem, argv) {
 				processed.current > promList.length
 					? promList.length
 					: processed.current,
-			)} file(s) ${processed.errors > 0
+			)} file(s) ${
+				processed.errors > 0
 					? 'with ' +
-					clc.bgBlackBright.red(processed.errors) +
-					' error(s) '
+					  clc.bgBlackBright.red(processed.errors) +
+					  ' error(s) '
 					: ''
-				}in `
+			}in `
 			displayMessageAndDuration(startTime, message)
 			resolve(true)
 		})
@@ -532,8 +557,13 @@ function combineHandler(argv, startTime) {
 			console.log()
 			combineHandler(argv, startTime)
 		} else {
-			if (global.git.latest !== undefined) {
-				git.updateLastCommit(global.__basedir, global.git.latest)
+			if (global.git.latestCommit !== undefined) {
+				git.updateLastCommit({
+					dir: global.__basedir,
+					latest: global.git.latestCommit,
+					fileUtils,
+					fs,
+				})
 			}
 			if (argv.type === undefined || argv.type.split(',').length > 1) {
 				let message = `Split completed in `
@@ -610,7 +640,7 @@ function processCombine(typeItem, argv) {
 			}
 		} else if (!all) {
 			let metaDirPath = path.join(sourceDir, name)
-			if (!fileUtils.directoryExists(metaDirPath)) {
+			if (!fileUtils.directoryExists({ dirPath: metaDirPath, fs })) {
 				global.logger.error('Directory not found: ' + metaDirPath)
 				process.exit(1)
 			}
@@ -675,10 +705,11 @@ function processCombine(typeItem, argv) {
 					errors++
 				}
 			})
-			let message = `Combined ${clc.bgBlackBright(successes)} file(s) ${errors > 0
+			let message = `Combined ${clc.bgBlackBright(successes)} file(s) ${
+				errors > 0
 					? 'with ' + clc.bgBlackBright(errors) + 'error(s) '
 					: ''
-				}in `
+			}in `
 			displayMessageAndDuration(startTime, message)
 			resolve(true)
 		})
@@ -762,10 +793,11 @@ function displayHeader() {
 		horizontal: '─',
 		vertical: '│',
 	}
-	let versionString = `sfparty v${pkgObj.version}${process.stdout.columns > pkgObj.description.length + 15
+	let versionString = `sfparty v${pkgObj.version}${
+		process.stdout.columns > pkgObj.description.length + 15
 			? ' - ' + pkgObj.description
 			: ''
-		}`
+	}`
 	let titleMessage = `${global.icons.party} ${clc.yellowBright(
 		versionString,
 	)} ${global.icons.party}`
@@ -782,16 +814,16 @@ function displayHeader() {
 	console.log(
 		`${clc.blackBright(
 			box.topLeft +
-			box.horizontal.repeat(process.stdout.columns - 2) +
-			box.topRight,
+				box.horizontal.repeat(process.stdout.columns - 2) +
+				box.topRight,
 		)}`,
 	)
 	console.log(titleMessage)
 	console.log(
 		`${clc.blackBright(
 			box.bottomLeft +
-			box.horizontal.repeat(process.stdout.columns - 2) +
-			box.bottomRight,
+				box.horizontal.repeat(process.stdout.columns - 2) +
+				box.bottomRight,
 		)}`,
 	)
 	console.log()
@@ -802,9 +834,9 @@ function getRootPath(packageDir) {
 	let defaultDir
 	if (rootPath) {
 		global.__basedir = fileUtils.fileInfo(rootPath).dirname
-		let packageJSON
+		let projectJSON
 		try {
-			packageJSON = JSON.parse(readFileSync(rootPath))
+			projectJSON = JSON.parse(fs.readFileSync(rootPath))
 		} catch (error) {
 			if (error.message.indexOf('JSON at position') > 0) {
 				global.displayError('sfdx-project.json has invalid JSON', true)
@@ -812,11 +844,11 @@ function getRootPath(packageDir) {
 				global.displayError(error, true)
 			}
 		}
-		if (Array.isArray(packageJSON.packageDirectories)) {
-			packageJSON.packageDirectories.every((directory) => {
+		if (Array.isArray(projectJSON.packageDirectories)) {
+			projectJSON.packageDirectories.every((directory) => {
 				if (
 					directory.default ||
-					packageJSON.packageDirectories.length == 1
+					projectJSON.packageDirectories.length == 1
 				)
 					defaultDir = directory.path
 				if (directory == packageDir) {

package/src/lib/checkVersion.js

@@ -39,7 +39,7 @@ export async function checkVersion({
 		)
 		const latestVersion = data['dist-tags'].latest
 		if (semver.gt(latestVersion, currentVersion)) {
-			const version = clc.bgCyanBright(data['dist-tags'].latest)
+			const version = clc.bgMagenta(data['dist-tags'].latest)
 			const icon = update ? global.icons.working : global.icons.fail
 			console.log()
 			console.log(`${icon} A newer version ${version} is available.`)

package/src/lib/fileUtils.js

@@ -4,12 +4,12 @@ import * as path from 'path'
 import * as yaml from 'js-yaml'
 import { Parser } from 'xml2js'
 
-export function directoryExists(dirPath, fsTmp = fs) {
-	return fsTmp.existsSync(dirPath) && fsTmp.statSync(dirPath).isDirectory()
+export function directoryExists({ dirPath, fs }) {
+	return fs.existsSync(dirPath) && fs.statSync(dirPath).isDirectory()
 }
 
-export function fileExists(filePath, fsTmp = fs) {
-	return fsTmp.existsSync(filePath) && fsTmp.statSync(filePath).isFile()
+export function fileExists({ filePath, fs }) {
+	return fs.existsSync(filePath) && fs.statSync(filePath).isFile()
 }
 
 export function createDirectory(dirPath, fsTmp = fs) {
@@ -19,7 +19,7 @@ export function createDirectory(dirPath, fsTmp = fs) {
 }
 
 export function deleteDirectory(dirPath, recursive = false, fsTmp = fs) {
-	if (!directoryExists(dirPath, fsTmp)) {
+	if (!directoryExists({ dirPath, fs: fsTmp })) {
 		return false
 	} else {
 		if (fsTmp.existsSync(dirPath)) {
@@ -40,7 +40,7 @@ export function deleteDirectory(dirPath, recursive = false, fsTmp = fs) {
 
 export function getFiles(dirPath, filter = undefined, fsTmp = fs) {
 	const filesList = []
-	if (directoryExists(dirPath, fsTmp)) {
+	if (directoryExists({ dirPath, fs: fsTmp })) {
 		fsTmp.readdirSync(dirPath).forEach((file) => {
 			if (!filter) {
 				filesList.push(file)
@@ -62,7 +62,7 @@ export function getFiles(dirPath, filter = undefined, fsTmp = fs) {
 }
 
 export function getDirectories(dirPath, fsTmp = fs) {
-	if (directoryExists(dirPath, fsTmp)) {
+	if (directoryExists({ dirPath, fs: fsTmp })) {
 		return fsTmp
 			.readdirSync(dirPath, { withFileTypes: true })
 			.filter((dirent) => dirent.isDirectory())
@@ -73,7 +73,7 @@ export function getDirectories(dirPath, fsTmp = fs) {
 }
 
 export function deleteFile(filePath, fsTmp = fs) {
-	if (!fileExists(filePath, fsTmp)) {
+	if (!fileExists({ filePath, fs: fsTmp })) {
 		return false
 	} else {
 		return fsTmp.unlinkSync(filePath, { recursive: false, force: true })
@@ -117,19 +117,19 @@ export function saveFile(
 	}
 }
 
-export function readFile(fileName, convert = true, fsTmp = fs) {
+export function readFile(filePath, convert = true, fsTmp = fs) {
 	try {
 		let result = undefined
-		if (fileExists(fileName, fsTmp)) {
-			const data = fsTmp.readFileSync(fileName, {
+		if (fileExists({ filePath, fs: fsTmp })) {
+			const data = fsTmp.readFileSync(filePath, {
 				encoding: 'utf8',
 				flag: 'r',
 			})
-			if (convert && fileName.indexOf('.yaml') != -1) {
+			if (convert && filePath.indexOf('.yaml') != -1) {
 				result = yaml.load(data)
-			} else if (convert && fileName.indexOf('.json') != -1) {
+			} else if (convert && filePath.indexOf('.json') != -1) {
 				result = JSON.parse(data)
-			} else if (convert && fileName.indexOf('.xml') != -1) {
+			} else if (convert && filePath.indexOf('.xml') != -1) {
 				// returns a promise
 				result = convertXML(data)
 			} else {

package/src/lib/gitUtils.js

@@ -1,13 +1,9 @@
 import path from 'path'
-import { execSync } from 'node:child_process'
 import * as os from 'node:os'
-import { existsSync } from 'fs'
-import * as fileUtils from './fileUtils.js'
 
 const defaultDefinition = {
 	git: {
 		lastCommit: undefined,
-		latestCommit: undefined,
 	},
 	local: {
 		lastDate: undefined,
@@ -49,48 +45,90 @@ const status = {
 	},
 }
 
-export function diff(
-	dir,
-	gitRef = 'HEAD',
-	existsSyncStub = existsSync,
-	execSyncStub = execSync,
-) {
+export function diff({ dir, gitRef = 'HEAD', existsSync, spawn }) {
 	return new Promise((resolve, reject) => {
-		if (!existsSyncStub(dir) || !existsSyncStub(path.join(dir, '.git'))) {
-			reject(new Error(`The directory "${dir}" is not a git repository`))
-		}
-
-		let data = ''
 		try {
-			data = execSyncStub(
-				`git diff --name-status --oneline --relative ${gitRef} -- *-party/*`,
-				{ cwd: dir, maxBuffer: 1024 * 1024 * 10 },
-			).toString()
+			if (!existsSync(dir)) {
+				throw new Error(`The directory "${dir}" does not exist`)
+			}
+			if (!existsSync(path.join(dir, '.git'))) {
+				throw new Error(
+					`The directory "${dir}" is not a git repository`,
+				)
+			}
+
+			const git = spawn('git', ['--version'])
+			git.on('error', (err) => {
+				throw new Error('Git is not installed on this machine')
+			})
+			git.on('close', (code) => {
+				if (code !== 0) {
+					reject(
+						new Error(
+							`git --version command failed with code ${code}`,
+						),
+					)
+				}
+
+				const gitDiff = spawn(
+					'git',
+					[
+						'diff',
+						'--name-status',
+						'--oneline',
+						'--no-renames',
+						'--relative',
+						gitRef,
+						'--',
+						'*-party/*',
+					],
+					{ cwd: dir },
+				)
+				let data = ''
+				gitDiff.stdout.setEncoding('utf8')
+				gitDiff.stderr.on('data', (data) => {
+					if (data !== '')
+						reject(
+							new Error(
+								`git diff command failed with error: ${data}`,
+							),
+						)
+				})
+				gitDiff.stdout.on('data', (chunk) => {
+					data += chunk
+				})
+				gitDiff.stdout.on('close', (code) => {
+					if (code !== 0 && code !== false) {
+						reject(
+							new Error(
+								`git diff command failed with code ${code}`,
+							),
+						)
+					}
+					const gitData = data.toString().split(os.EOL)
+					const files = gitData.reduce((acc, gitRow) => {
+						if (gitRow.lastIndexOf('\t') > 0) {
+							const file = gitRow.split('\t')
+							if (file.slice(-1)[0] !== '') {
+								const statusType = status[file[0]]
+								acc.push({
+									type:
+										statusType !== undefined
+											? statusType.type
+											: 'A',
+									path: file.slice(-1)[0],
+									action: statusType.action,
+								})
+							}
+						}
+						return acc
+					}, [])
+					resolve(files)
+				})
+			})
 		} catch (error) {
 			reject(error)
 		}
-
-		const gitData = data.toString().split(os.EOL)
-		const files = gitData.reduce((acc, gitRow) => {
-			if (gitRow.indexOf('\t') > 0) {
-				const file = gitRow.split('\t')
-				if (file.slice(-1) !== '') {
-					const statusType =
-						status[
-							file[0] === file.slice(-1)
-								? 'A'
-								: Array.from(file[0])[0]
-						]
-					acc.push({
-						type: statusType.type,
-						path: file.slice(-1)[0],
-						action: statusType.action,
-					})
-				}
-			}
-			return acc
-		}, [])
-		resolve(files)
 	})
 }
 
@@ -110,39 +148,41 @@ export function log(dir, gitRef, execSyncStub = execSync) {
 	}
 }
 
-export function lastCommit(
+export function lastCommit({
 	dir,
 	fileName = 'index.yaml',
-	existsSyncStub = existsSync,
-	execSyncStub = execSync,
-	fileUtilsStub = fileUtils,
-) {
-	try {
-		const folder = path.resolve(dir, '.sfdx', 'sfparty')
-		const filePath = path.resolve(folder, fileName)
-		let lastCommit = undefined
+	existsSync,
+	execSync,
+	fileUtils,
+}) {
+	return new Promise((resolve, reject) => {
+		try {
+			const folder = path.resolve(dir, '.sfdx', 'sfparty')
+			const filePath = path.resolve(folder, fileName)
+			let lastCommit = undefined
 
-		fileUtilsStub.createDirectory(folder)
-		if (existsSyncStub(filePath)) {
-			const data = fileUtilsStub.readFile(filePath)
-			if (data.git.lastCommit !== undefined) {
-				lastCommit = data.git.lastCommit
+			fileUtils.createDirectory(folder)
+			if (existsSync(filePath)) {
+				const data = fileUtils.readFile(filePath)
+				if (data.git.lastCommit !== undefined) {
+					lastCommit = data.git.lastCommit
+				}
 			}
+			const latestCommit = execSync(`git log --format=format:%H -1`, {
+				cwd: dir,
+				encoding: 'utf-8',
+			})
+			resolve({
+				lastCommit: lastCommit,
+				latestCommit: latestCommit,
+			})
+		} catch (error) {
+			reject(error)
 		}
-		const latestCommit = execSyncStub(`git log --format=format:%H -1`, {
-			cwd: dir,
-			encoding: 'utf-8',
-		})
-		return {
-			lastCommit: lastCommit,
-			latestCommit: latestCommit,
-		}
-	} catch (error) {
-		throw new Error(error)
-	}
+	})
 }
 
-export function updateLastCommit(dir, latest, fileUtilsStub = fileUtils) {
+export function updateLastCommit({ dir, latest, fileUtils, fs }) {
 	if (typeof latest !== 'string' && typeof latest !== 'undefined')
 		throw new Error(
 			`updateLastCommit received a ${typeof latest} instead of string`,
@@ -151,8 +191,8 @@ export function updateLastCommit(dir, latest, fileUtilsStub = fileUtils) {
 		const folder = path.join(dir, '.sfdx', 'sfparty')
 		const fileName = path.join(folder, 'index.yaml')
 		let data = undefined
-		if (fileUtilsStub.fileExists(fileName)) {
-			data = fileUtilsStub.readFile(fileName)
+		if (fileUtils.fileExists({ filePath: fileName, fs })) {
+			data = fileUtils.readFile(fileName)
 		}
 
 		if (data === undefined) {
@@ -160,6 +200,6 @@ export function updateLastCommit(dir, latest, fileUtilsStub = fileUtils) {
 		}
 
 		data.git.lastCommit = latest
-		fileUtilsStub.saveFile(data, fileName)
+		fileUtils.saveFile(data, fileName)
 	}
 }