@ds-sfdc/sfparty 1.0.0 → 1.1.1

package/README.md

@@ -2,9 +2,9 @@
 
 [![NPM](https://img.shields.io/npm/v/@ds-sfdc/sfparty.svg?label=@ds-sfdc/sfparty)](https://www.npmjs.com/package/@ds-sfdc/sfparty) [![Downloads/week](https://img.shields.io/npm/dw/@ds-sfdc/sfparty.svg)](https://npmjs.org/package/@ds-sfdc/sfparty) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://github.com/TimPaulaskasDS/sfparty/blob/main/LICENSE.md)
 
-## Using the template
+## What is sfparty?
 
-This tool will split Salesforce metadata XML files into YAML parts (or JSON).
+For those that are familiar with Salesforce metadata, you know that it uses large XML files. These XML files are difficult to diff, hard to read, and can cause conflicts and corrupted XML when merging. This tool will split Salesforce metadata XML files into YAML parts (or JSON), and combine them back into XML files. A great solution for your CI/CD needs.
 
 ## Install
 
@@ -13,6 +13,72 @@ npm i @ds-sfdc/sfparty
 ```
 ## Commands
 
-<!-- commands -->
+### Split
+```bash
+sfparty split
+```
+
+### Combine
+```bash
+sfparty combine
+```
+
+### Options
+
+```
+  -n, --name     name of metadata file  
+  -s, --source   package directory path specified in sfdx-project.json  
+  -t, --target   target path to directory to create yaml/json files  
+  -h, --help     Show help  
+```
+## Examples
+### Custom Labels
+```bash
+sfparty split --type=label
+```
+
+### Permission Set
+```bash
+sfparty split --type=permset
+sfparty split --type=permset --name="My Permission Set"
+```
+### Profile
+```bash
+sfparty split --type=profile
+sfparty split --type=profile --name="My Profile"
+```
+### Workflow
+```bash
+sfparty split --type=workflow
+sfparty split --type=workflow --name="Workflow"
+```
+### Source Directory
+The source directory will use your default package folder as specified in the sfdx-project.json file, and therefore must be executed from your Salesforce project directory. It will create the main/default folders if they do not exist.
 
-<!-- commandsstop -->
+```
+{
+    "packageDirectories": [
+        {
+            "path": "force-app",
+            "default": true
+        },
+        {
+            "path": "my-package"
+        }
+    ],
+    "namespace": "",
+    "sfdcLoginUrl": "https://login.salesforce.com",
+    "sourceApiVersion": "53.0"
+}
+```
+
+```bash
+sfparty split --source="my-package"
+```
+
+### Target Directory
+The source directory will use your default package folder as specified in the sfdx-project.json file, and append `-party` to the end. For example, if the default source path is `force-app`, then the default target directory will be `force-app-party` unless otherwise specified. The target does not need to be specified in the sfdx-project.json, however the combine command will not work on folders that are not specified in the sfdx-project.json.
+
+```bash
+sfparty split --target="test"
+```

package/package.json

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

package/src/index.js

@@ -9,6 +9,7 @@ import chalk from 'chalk'
 import convertHrtime from 'convert-hrtime'
 import * as fileUtils from './lib/fileUtils.js'
 import * as pkgObj from '../package.json'  assert { type: "json" }
+import * as yargOptions from './meta/yargs.js'
 import * as metadataSplit from './party/split.js'
 import * as metadataCombine from './party/combine.js'
 import * as labelDefinition from './meta/CustomLabels.js'
@@ -16,8 +17,7 @@ import * as profileDefinition from './meta/Profiles.js'
 import * as permsetDefinition from './meta/PermissionSets.js'
 import * as workflowDefinition from './meta/Workflows.js'
 
-const startTime = process.hrtime.bigint()
-
+const processStartTime = process.hrtime.bigint()
 
 global.logger = winston.createLogger({
     levels: winston.config.syslog.levels,
@@ -28,12 +28,6 @@ global.logger = winston.createLogger({
     ],
 });
 
-global.processed = {
-    total: 0,
-    errors: 0,
-    current: 1,
-}
-
 global.icons = {
     "warn": '🔕',
     "success": chalk.greenBright('✔'),
@@ -68,6 +62,8 @@ const metaTypes = {
     },
 }
 
+let types = []
+
 function getRootPath(packageDir) {
     let rootPath = fileUtils.find('sfdx-project.json')
     let defaultDir
@@ -100,7 +96,7 @@ let errorMessage = chalk.red('Please specify the action of ' + chalk.whiteBright
 displayHeader() // display header mast
 
 function displayHeader() {
-    const table = {
+    const box = {
         topLeft: '╭',
         topRight: '╮',
         bottomLeft: '╰',
@@ -112,10 +108,10 @@ function displayHeader() {
     let titleMessage = `${global.icons.party} ${chalk.yellowBright(versionString)} ${global.icons.party}`
     titleMessage = titleMessage.padEnd((process.stdout.columns / 2) + versionString.length / 1.65)
     titleMessage = titleMessage.padStart(process.stdout.columns)
-    titleMessage = chalk.blackBright(table.vertical) + '  ' + titleMessage + '      ' + chalk.blackBright(table.vertical)
-    console.log(`${chalk.blackBright(table.topLeft + table.horizontal.repeat(process.stdout.columns - 2) + table.topRight)}`)
+    titleMessage = chalk.blackBright(box.vertical) + '  ' + titleMessage + '      ' + chalk.blackBright(box.vertical)
+    console.log(`${chalk.blackBright(box.topLeft + box.horizontal.repeat(process.stdout.columns - 2) + box.topRight)}`)
     console.log(titleMessage)
-    console.log(`${chalk.blackBright(table.bottomLeft + table.horizontal.repeat(process.stdout.columns - 2) + table.bottomRight)}`)
+    console.log(`${chalk.blackBright(box.bottomLeft + box.horizontal.repeat(process.stdout.columns - 2) + box.bottomRight)}`)
     console.log()
 }
 
@@ -124,316 +120,33 @@ yargs(hideBin(process.argv))
     .command({
         command: '[split]',
         alias: 'split',
-        description: 'splits metadata xml to json files',
+        description: 'splits metadata xml to yaml/json files',
         builder: (yargs) => {
             yargs
-                .example([
-                    ['$0 split --type=profile --all'],
-                    ['$0 split --type=permset --name="Permission Set Name"'],
-                    ['--source=packageDir --target=dir/dir'],
-                    ['name portion of file: [name].profile-meta.xml'],
-                    ['Example: --name="Admin" for Admin.profile-meta.xml'],
-                    ['\nCommands not supporting name or all parameters:'],
-                    ['$0 split --type=label'],
-                ])
-                .options({
-                    type: {
-                        demand: true,
-                        alias: 'type',
-                        description: 'type of metadata to split',
-                        demandOption: true,
-                        type: 'string',
-                    },
-                    format: {
-                        demand: true,
-                        alias: 'format',
-                        default: 'yaml',
-                        description: 'type of output',
-                        demandOption: true,
-                        type: 'string',
-                    },
-                    name: {
-                        alias: 'n',
-                        description: 'name of metadata file to split',
-                        demandOption: false,
-                        type: 'string',
-                    },
-                    all: {
-                        alias: 'a',
-                        description: 'all metadata files of type will be split',
-                        demandOption: false,
-                        type: 'boolean',
-                    },
-                    source: {
-                        demand: false,
-                        alias: 's',
-                        description: 'package directory path specified in sfdx-project.json',
-                        type: 'string',
-                    },
-                    target: {
-                        demand: false,
-                        alias: 't',
-                        description: 'target path to directory to create json files',
-                        type: 'string',
-                    }
-                })
-                .choices('type', typeArray)
+                .example(yargOptions.splitExamples)
+                .options(yargOptions.splitOptions)
                 .choices('format', ['json', 'yaml'])
-                .check((argv, options) => {
-                    const name = argv.name
-                    const all = argv.all
-
-                    switch (argv.type) {
-                        case 'profile':
-                        case 'permset':
-                        case 'workflow':
-                            if ((typeof name != 'undefined' || name == '') && (typeof all != 'undefined' && all)) {
-                                throw new Error(chalk.redBright('You cannot specify ' + chalk.whiteBright.bgRedBright('--name') + ' and ' + chalk.whiteBright.bgRedBright('--all') + ' at the same time.'))
-                            } else if (typeof name == 'undefined' && (typeof all == 'undefined' || !all)) {
-                                throw new Error(chalk.redBright('You must specify the ' + chalk.whiteBright.bgRedBright('--name') + ' parameter or use the ' + chalk.whiteBright.bgRedBright('--all') + ' switch.'))
-                            } else {
-                                return true // tell Yargs that the arguments passed the check
-                            }
-                        case 'label':
-                            if ((typeof name != 'undefined' && name != '') || (typeof all != 'undefined' && all)) {
-                                throw new Error(chalk.redBright('You cannot specify ' + chalk.whiteBright.bgRedBright('--name') + ' or ' + chalk.whiteBright.bgRedBright('--all') + ' when using label.'))
-                            }
-                            return true
-                    }
-                })
+                .check(yargCheck)
         },
         handler: (argv) => {
-            if (!typeArray.includes(argv.type)) {
-                global.logger.error('Metadata type not supported: ' + type)
-                process.exit(1)
-            }
-            const fileList = []
-            const typeObj = metaTypes[argv.type]
-            const type = typeObj.type
-            const metaExtension = `.${type}-meta.xml`
             global.format = argv.format
-
-            let sourceDir = argv.source || ''
-            let targetDir = argv.target || ''
-            let name = argv.name
-            let all = argv.all
-            let packageDir = getRootPath(sourceDir)
-
-            if (type == metaTypes.label.type) {
-                name = metaTypes.label.definition.root
-            }
-            sourceDir = path.join(global.__basedir, packageDir, 'main', 'default', typeObj.definition.directory)
-            if (targetDir == '') {
-                targetDir = path.join(global.__basedir, packageDir + '-party', 'main', 'default', typeObj.definition.directory)
-            } else {
-                targetDir = path.join(targetDir, 'main', 'default', typeObj.definition.directory)
-            }
-            let metaDirPath = sourceDir
-            console.log(`${chalk.bgBlackBright('Source path:')} ${sourceDir}`)
-            console.log(`${chalk.bgBlackBright('Target path:')} ${targetDir}`)
-            console.log()
-
-            if (!all) {
-                let metaFilePath = path.join(metaDirPath, name)
-                if (!fileUtils.fileExists(metaFilePath)) {
-                    name += metaExtension
-                    metaFilePath = path.join(metaDirPath, name)
-                    if (!fileUtils.fileExists(metaFilePath)) {
-                        global.logger.error('File not found: ' + metaFilePath)
-                        process.exit(1)
-                    }
-                }
-                fileList.push(name)
-            } else {
-                if (fileUtils.directoryExists(sourceDir)) {
-                    fileUtils.getFiles(sourceDir, metaExtension).forEach(file => {
-                        fileList.push(file)
-                    })
-                }
-            }
-
-            global.processed.total = fileList.length
-            console.log(`Splitting a total of ${fileList.length} file(s)`)
-            console.log()
-            const promList = []
-            fileList.forEach(metaFile => {
-                const metadataItem = new metadataSplit.Split({
-                    metadataDefinition: typeObj.definition,
-                    sourceDir: sourceDir,
-                    targetDir: targetDir,
-                    metaFilePath: path.join(sourceDir, metaFile),
-                    sequence: promList.length + 1,
-                })
-                const metadataItemProm = metadataItem.split()
-                promList.push(metadataItemProm)
-                metadataItemProm.then((resolve, reject) => {
-                    if (resolve == false) {
-                        global.processed.errors++
-                        global.processed.current--
-                    } else {
-                        global.processed.current++
-                    }
-                })
-            })
-            Promise.allSettled(promList).then((results) => {
-                let message = `Split ${chalk.bgBlackBright((global.processed.current > promList.length) ? promList.length : global.processed.current)} file(s) ${(global.processed.errors > 0) ? 'with ' + chalk.bgBlackBright.red(global.processed.errors) + ' error(s) ' : ''}in `
-                displayMessageAndDuration(startTime, message)
-            })
+            splitHandler(argv, processStartTime)
         }
     })
     .command({
         command: '[combine]',
         alias: 'combine',
-        description: 'combines json files into metadata xml',
+        description: 'combines yaml/json files into metadata xml',
         builder: (yargs) => {
             yargs
-                .example([
-                    ['$0 combine --type=profile --all'],
-                    ['$0 combine --type=permset --name="Permission Set Name"'],
-                    ['--source=packageDir --target=dir/dir'],
-                    ['name portion of file: [name].profile-meta.xml'],
-                    ['Example: --name="Admin" for Admin.profile-meta.xml'],
-                    ['\nCommands not supporting name or all parameters:'],
-                    ['$0 combine --type=label'],])
-                .options({
-                    type: {
-                        demand: true,
-                        alias: 'type',
-                        description: 'type of metadata to combine',
-                        demandOption: true,
-                        type: 'string',
-                    },
-                    format: {
-                        demand: true,
-                        alias: 'format',
-                        default: 'yaml',
-                        description: 'type of output',
-                        demandOption: true,
-                        type: 'string',
-                    },
-                    name: {
-                        alias: 'n',
-                        description: 'name of metadata file to combine',
-                        demandOption: false,
-                        type: 'string',
-                    },
-                    all: {
-                        alias: 'a',
-                        description: 'all json files of type will be combined',
-                        demandOption: false,
-                        type: 'boolean',
-                    },
-                    source: {
-                        demand: false,
-                        alias: 's',
-                        description: 'package directory path specified in sfdx-project.json',
-                        type: 'string',
-                    },
-                    target: {
-                        demand: false,
-                        alias: 't',
-                        description: 'target path to directory to create xml files',
-                        type: 'string',
-                    }
-                })
-                .choices('type', typeArray)
+                .example(yargOptions.combineExamples)
+                .options(yargOptions.combineOptions)
                 .choices('format', ['json', 'yaml'])
-                .check((argv, options) => {
-                    const name = argv.name
-                    const all = argv.all
-
-                    switch (argv.type) {
-                        case 'profile':
-                        case 'permset':
-                        case 'workflow':
-                            if ((typeof name != 'undefined' || name == '') && (typeof all != 'undefined' && all)) {
-                                throw new Error(chalk.redBright('You cannot specify ' + chalk.whiteBright.bgRedBright('--name') + ' and ' + chalk.whiteBright.bgRedBright('--all') + ' at the same time.'))
-                            } else if (typeof name == 'undefined' && (typeof all == 'undefined' || !all)) {
-                                throw new Error(chalk.redBright('You must specify the ' + chalk.whiteBright.bgRedBright('--name') + ' parameter or use the ' + chalk.whiteBright.bgRedBright('--all') + ' switch.'))
-                            } else {
-                                return true // tell Yargs that the arguments passed the check
-                            }
-                        case 'label':
-                            if ((typeof name != 'undefined' && name != '') || (typeof all != 'undefined' && all)) {
-                                throw new Error(chalk.redBright('You cannot specify ' + chalk.whiteBright.bgRedBright('--name') + ' or ' + chalk.whiteBright.bgRedBright('--all') + ' when using label.'))
-                            }
-                            return true
-                    }
-                })
+                .check(yargCheck)
         },
         handler: (argv) => {
-            if (!typeArray.includes(argv.type)) {
-                global.logger.error('Metadata type not supported: ' + type)
-                process.exit(1)
-            }
-            let processList = []
             global.format = argv.format
-            const typeObj = metaTypes[argv.type]
-            const type = typeObj.type
-
-            let sourceDir = argv.source || ''
-            let targetDir = argv.target || ''
-            let name = argv.name
-            let all = argv.all
-            let packageDir = getRootPath(sourceDir)
-
-            sourceDir = path.join(global.__basedir, packageDir + '-party', 'main', 'default', typeObj.definition.directory)
-            if (targetDir == '') {
-                targetDir = path.join(global.__basedir, packageDir, 'main', 'default', typeObj.definition.directory)
-            } else {
-                targetDir = path.join(targetDir, 'main', 'default', typeObj.definition.directory)
-            }
-
-            console.log(`${chalk.bgBlackBright('Source path:')} ${sourceDir}`)
-            console.log(`${chalk.bgBlackBright('Target path:')} ${targetDir}`)
-            console.log()
-
-            if (type == metaTypes.label.type) {
-                processList.push(metaTypes.label.definition.root)
-            } else if (!all) {
-                let metaDirPath = path.join(sourceDir, name)
-                if (!fileUtils.directoryExists(metaDirPath)) {
-                    global.logger.error('Directory not found: ' + metaDirPath)
-                    process.exit(1)
-                }
-                processList.push(name)
-            } else {
-                processList = fileUtils.getDirectories(sourceDir)
-            }
-
-            global.processed.total = processList.length
-            console.log(`Combining a total of ${global.processed.total} file(s)`)
-            console.log()
-
-            const promList = []
-            processList.forEach(metaDir => {
-                const metadataItem = new metadataCombine.Combine({
-                    metadataDefinition: typeObj.definition,
-                    sourceDir: sourceDir,
-                    targetDir: targetDir,
-                    metaDir: metaDir,
-                    sequence: promList.length + 1,
-                })
-                const metadataItemProm = metadataItem.combine()
-                promList.push(metadataItemProm)
-                metadataItemProm.then((resolve, reject) => {
-                    global.processed.current++
-                })
-            })
-
-            Promise.allSettled(promList).then((results) => {
-                let successes = 0
-                let errors = 0
-                results.forEach(result => {
-                    if (result.value == true) {
-                        successes++
-                    } else if (result.value == false) {
-                        errors++
-                    }
-                })
-                let message = `Combined ${chalk.bgBlackBright(successes)} file(s) ${(errors > 0) ? 'with ' + chalk.bgBlackBright(errors) + 'error(s) ' : ''}in `
-                displayMessageAndDuration(startTime, message)
-            })
+            combineHandler(argv, processStartTime)
         }
     })
     .demandCommand(1, errorMessage)
@@ -447,6 +160,35 @@ yargs(hideBin(process.argv))
     .argv
     .parse
 
+function yargCheck(argv, options) {
+    const name = argv.name
+    types = (argv.type !== undefined) ? argv.type.split(',') : typeArray
+    types.forEach(type => {
+        type = type.trim()
+        if (!typeArray.includes(type)) {
+            throw new Error(`Invalid type: ${type}`)
+        }
+    })
+
+    if (types.length > 1) {
+        // if using multiple types you cannot specify name
+        if ((typeof name != 'undefined' && name != '')) {
+            throw new Error(chalk.redBright('You cannot specify ' + chalk.whiteBright.bgRedBright('--name') + ' when using multiple types.'))
+        }
+        return true
+    } else {
+        switch (argv.type) {
+            case 'label':
+                if ((typeof name != 'undefined' && name != '')) {
+                    throw new Error(chalk.redBright('You cannot specify ' + chalk.whiteBright.bgRedBright('--name') + '  when using label.'))
+                }
+                break
+            default:
+                return true
+        }
+    }
+}
+
 function displayMessageAndDuration(startTime, message) {
     const diff = process.hrtime.bigint() - BigInt(startTime)
     let durationMessage
@@ -471,4 +213,215 @@ process.on('SIGINT', function () {
     }
 
     callAmount++;
-})
+})
+
+function splitHandler(argv) {
+    const split = processSplit(types[0], argv)
+    split.then((resolve) => {
+        types.shift() // remove first item from array
+        if (types.length > 0) {
+            console.log()
+            splitHandler(argv)
+        } else {
+            if (argv.type === undefined || argv.type.split(',').length > 1) {
+                let message = `Split completed in `
+                displayMessageAndDuration(startTime, message)
+            }
+        }
+    })
+}
+
+function processSplit(typeItem, argv) {
+    return new Promise((resolve, reject) => {
+        const processed = {
+            total: 0,
+            errors: 0,
+            current: 1,
+        }
+        const startTime = process.hrtime.bigint()
+
+        if (!typeArray.includes(typeItem)) {
+            global.logger.error('Metadata type not supported: ' + typeItem)
+            process.exit(1)
+        }
+
+        const fileList = []
+        const typeObj = metaTypes[typeItem]
+        const type = typeObj.type
+        const metaExtension = `.${type}-meta.xml`
+
+        let sourceDir = argv.source || ''
+        let targetDir = argv.target || ''
+        let name = argv.name
+        let all = (argv.type === undefined || argv.type.split(',').length > 1) ? true : argv.all
+        let packageDir = getRootPath(sourceDir)
+
+        if (type == metaTypes.label.type) {
+            name = metaTypes.label.definition.root
+        }
+        sourceDir = path.join(global.__basedir, packageDir, 'main', 'default', typeObj.definition.directory)
+        if (targetDir == '') {
+            targetDir = path.join(global.__basedir, packageDir + '-party', 'main', 'default', typeObj.definition.directory)
+        } else {
+            targetDir = path.join(targetDir, 'main', 'default', typeObj.definition.directory)
+        }
+        let metaDirPath = sourceDir
+
+        if (!all) {
+            let metaFilePath = path.join(metaDirPath, name)
+            if (!fileUtils.fileExists(metaFilePath)) {
+                name += metaExtension
+                metaFilePath = path.join(metaDirPath, name)
+                if (!fileUtils.fileExists(metaFilePath)) {
+                    global.logger.error('File not found: ' + metaFilePath)
+                    process.exit(1)
+                }
+            }
+            fileList.push(name)
+        } else {
+            if (fileUtils.directoryExists(sourceDir)) {
+                fileUtils.getFiles(sourceDir, metaExtension).forEach(file => {
+                    fileList.push(file)
+                })
+            }
+        }
+
+        processed.total = fileList.length
+
+        console.log(`${chalk.bgBlackBright('Source path:')} ${sourceDir}`)
+        console.log(`${chalk.bgBlackBright('Target path:')} ${targetDir}`)
+        console.log()
+        console.log(`Splitting a total of ${processed.total} file(s)`)
+        console.log()
+
+        const promList = []
+        fileList.forEach(metaFile => {
+            const metadataItem = new metadataSplit.Split({
+                metadataDefinition: typeObj.definition,
+                sourceDir: sourceDir,
+                targetDir: targetDir,
+                metaFilePath: path.join(sourceDir, metaFile),
+                sequence: promList.length + 1,
+                total: processed.total,
+            })
+            const metadataItemProm = metadataItem.split()
+            promList.push(metadataItemProm)
+            metadataItemProm.then((resolve, reject) => {
+                if (resolve == false) {
+                    processed.errors++
+                    processed.current--
+                } else {
+                    processed.current++
+                }
+            })
+        })
+        Promise.allSettled(promList).then((results) => {
+            let message = `Split ${chalk.bgBlackBright((processed.current > promList.length) ? promList.length : processed.current)} file(s) ${(processed.errors > 0) ? 'with ' + chalk.bgBlackBright.red(processed.errors) + ' error(s) ' : ''}in `
+            displayMessageAndDuration(startTime, message)
+            resolve(true)
+        })
+    })
+}
+
+function combineHandler(argv, startTime) {
+    const combine = processCombine(types[0], argv)
+    combine.then((resolve) => {
+        types.shift() // remove first item from array
+        if (types.length > 0) {
+            console.log()
+            combineHandler(argv, startTime)
+        } else {
+            if (argv.type === undefined || argv.type.split(',').length > 1) {
+                let message = `Split completed in `
+                displayMessageAndDuration(startTime, message)
+            }
+        }
+    })
+
+}
+
+function processCombine(typeItem, argv) {
+    return new Promise((resolve, reject) => {
+        const processed = {
+            total: 0,
+            errors: 0,
+            current: 1,
+        }
+        const startTime = process.hrtime.bigint()
+
+        if (!typeArray.includes(typeItem)) {
+            global.logger.error('Metadata type not supported: ' + typeItem)
+            process.exit(1)
+        }
+
+        let processList = []
+        const typeObj = metaTypes[typeItem]
+        const type = typeObj.type
+
+        let sourceDir = argv.source || ''
+        let targetDir = argv.target || ''
+        let name = argv.name
+        let all = (argv.type === undefined || argv.type.split(',').length > 1) ? true : argv.all
+        let packageDir = getRootPath(sourceDir)
+
+        sourceDir = path.join(global.__basedir, packageDir + '-party', 'main', 'default', typeObj.definition.directory)
+        if (targetDir == '') {
+            targetDir = path.join(global.__basedir, packageDir, 'main', 'default', typeObj.definition.directory)
+        } else {
+            targetDir = path.join(targetDir, 'main', 'default', typeObj.definition.directory)
+        }
+
+        console.log(`${chalk.bgBlackBright('Source path:')} ${sourceDir}`)
+        console.log(`${chalk.bgBlackBright('Target path:')} ${targetDir}`)
+        console.log()
+
+        if (type == metaTypes.label.type) {
+            processList.push(metaTypes.label.definition.root)
+        } else if (!all) {
+            let metaDirPath = path.join(sourceDir, name)
+            if (!fileUtils.directoryExists(metaDirPath)) {
+                global.logger.error('Directory not found: ' + metaDirPath)
+                process.exit(1)
+            }
+            processList.push(name)
+        } else {
+            processList = fileUtils.getDirectories(sourceDir)
+        }
+
+        processed.total = processList.length
+        console.log(`Combining a total of ${processed.total} file(s)`)
+        console.log()
+
+        const promList = []
+        processList.forEach(metaDir => {
+            const metadataItem = new metadataCombine.Combine({
+                metadataDefinition: typeObj.definition,
+                sourceDir: sourceDir,
+                targetDir: targetDir,
+                metaDir: metaDir,
+                sequence: promList.length + 1,
+                total: processed.total,
+            })
+            const metadataItemProm = metadataItem.combine()
+            promList.push(metadataItemProm)
+            metadataItemProm.then((resolve, reject) => {
+                processed.current++
+            })
+        })
+
+        Promise.allSettled(promList).then((results) => {
+            let successes = 0
+            let errors = 0
+            results.forEach(result => {
+                if (result.value == true) {
+                    successes++
+                } else if (result.value == false) {
+                    errors++
+                }
+            })
+            let message = `Combined ${chalk.bgBlackBright(successes)} file(s) ${(errors > 0) ? 'with ' + chalk.bgBlackBright(errors) + 'error(s) ' : ''}in `
+            displayMessageAndDuration(startTime, message)
+            resolve(true)
+        })
+    })
+}

package/src/meta/yargs.js

@@ -0,0 +1,75 @@
+const options = {
+    type: {
+        demand: false,
+        alias: 'type',
+        description: 'type of metadata to $1',
+        demandOption: false,
+        type: 'string',
+    },
+    format: {
+        demand: true,
+        alias: 'format',
+        default: 'yaml',
+        description: 'type of output',
+        demandOption: true,
+        type: 'string',
+    },
+    name: {
+        alias: 'n',
+        description: 'name of metadata file to $1',
+        demandOption: false,
+        type: 'string',
+    },
+    source: {
+        demand: false,
+        alias: 's',
+        description: 'package directory path specified in sfdx-project.json',
+        type: 'string',
+    },
+    target: {
+        demand: false,
+        alias: 't',
+        description: 'target path to directory to create yaml/json files',
+        type: 'string',
+    }
+}
+
+function getOptions(type) {
+    let optionObj = {... options}
+    Object.keys(optionObj).forEach(key => {
+        Object.keys(optionObj[key]).forEach(subKey => {
+            if (typeof optionObj[key][subKey] == 'string') {
+                optionObj[key][subKey] = optionObj[key][subKey].replaceAll('$1', type)
+            }
+        })
+    })
+
+    return optionObj
+}
+
+export const splitOptions = getOptions('split')
+export const combineOptions = getOptions('combine')
+
+const examples = [
+    ['$0 $1'],
+    ['$0 $1 --type=profile'],
+    ['$0 $1 --type="profile,label"'],
+    ['$0 $1 --type=permset --name="Permission Set Name"'],
+    ['--source=packageDir --target=dir/dir'],
+    ['name portion of file: [name].profile-meta.xml'],
+    ['Example: --name="Admin" for Admin.profile-meta.xml'],
+    ['\nCommands not supporting name or all parameters:'],
+    ['$0 $1 --type=label'],
+]
+
+function getExamples(type) {
+    let exArr = [...examples]
+    exArr.forEach(arrItem => {
+        arrItem[0] = arrItem[0].replaceAll('$1', type)
+    })
+
+    return exArr
+}
+
+export const splitExamples = getExamples('split')
+export const combineExamples = getExamples('combine')

package/src/party/combine.js

@@ -8,6 +8,12 @@ import * as xml2js from 'xml2js'
 import * as fileUtils from '../lib/fileUtils.js'
 
 const spinner = cliSpinners['dots']
+const processed = {
+    total: 0,
+    errors: 0,
+    current: 0,
+    type: undefined,
+}
 
 export class Combine {
     #type = undefined
@@ -33,6 +39,7 @@ export class Combine {
         this.targetDir = config.targetDir
         this.metaDir = config.metaDir
         this.sequence = config.sequence
+        this.total = config.total
     }
 
     get metadataDefinition() {
@@ -102,13 +109,19 @@ export class Combine {
         })
 
         function getXML(that) {
+            if (processed.type != that.#root) {
+                processed.current = 0
+                processed.type = that.#root
+            }
+            processed.current++
+
             that.#startTime = process.hrtime.bigint()
-            that.#spinnerMessage = `[%1] of ${global.processed.total} - ${that.#root}: [%4]${chalk.yellowBright('[%5]')}[%2][%3]`
+            that.#spinnerMessage = `[%1] of ${that.total} - ${that.#root}: [%4]${chalk.yellowBright('[%5]')}[%2][%3]`
 
             that.#types.forEach(key => {
                 // display message
                 logUpdate(that.#spinnerMessage
-                    .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                    .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                     .replace('[%2]', `\n${chalk.magentaBright(nextFrame(that))} ${key}`)
                     .replace('[%3]', `${that.#errorMessage}`)
                     .replace('[%4]', `${global.icons.working} `)
@@ -157,7 +170,7 @@ export class Combine {
                 // iterate over fileList
                 fileList.forEach((file, index) => {
                     logUpdate(that.#spinnerMessage
-                        .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                        .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                         .replace('[%2]', `\n${chalk.magentaBright(nextFrame(that))} ${key} - ${index + 1} of ${fileList.length} - ${chalk.magentaBright(file)}`)
                         .replace('[%3]', `${that.#errorMessage}`)
                         .replace('[%4]', `${global.icons.working} `)
@@ -292,7 +305,7 @@ export class Combine {
             let stateIcon = (that.#errorMessage == '') ? global.icons.success : global.icons.fail
 
             logUpdate(that.#spinnerMessage
-                .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                 .replace('[%2]', `. Processed in ${durationMessage}.`)
                 .replace('[%3]', `${that.#errorMessage}`)
                 .replace('[%4]', `${stateIcon} `)

package/src/party/split.js

@@ -12,6 +12,12 @@ import cliSpinners from 'cli-spinners'
 import * as fileUtils from '../lib/fileUtils.js'
 
 const spinner = cliSpinners['dots']
+const processed = {
+    total: 0,
+    errors: 0,
+    current: 0,
+    type: undefined,
+}
 
 export class Split {
     #type = undefined
@@ -33,6 +39,7 @@ export class Split {
         this.targetDir = config.targetDir
         this.metaFilePath = config.metaFilePath
         this.sequence = config.sequence
+        this.total = config.total
     }
 
     get metadataDefinition() {
@@ -117,13 +124,18 @@ export class Split {
         })
 
         function processJSON(that, json, baseDir) {
-            that.#spinnerMessage = `[%1] of ${global.processed.total} - Workflow: [%4]${chalk.yellowBright(that.#fileName.shortName)}[%2][%3]`
+            that.#spinnerMessage = `[%1] of ${that.total} - ${that.#root}: [%4]${chalk.yellowBright(that.#fileName.shortName)}[%2][%3]`
 
             let targetDir = baseDir
+            if (processed.type != that.#root) {
+                processed.current = 0
+                processed.type = that.#root
+            }
+            processed.current++
             Object.keys(json).forEach(key => {
-                that.sequence = global.processed.current
+                that.sequence = processed.current
                 logUpdate(that.#spinnerMessage
-                    .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                    .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                     .replace('[%2]', `\n${chalk.magentaBright(nextFrame(that))} ${key}`)
                     .replace('[%3]', `${that.#errorMessage}`)
                     .replace('[%4]', `${global.icons.working} `)
@@ -157,9 +169,9 @@ export class Split {
             }
             mainInfo.main.name = that.#fileName.shortName
             that.metadataDefinition.main.forEach(key => {
-                that.sequence = global.processed.current
+                that.sequence = processed.current
                 logUpdate(that.#spinnerMessage
-                    .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                    .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                     .replace('[%2]', `\n${chalk.magentaBright(nextFrame(that))} ${key}`)
                     .replace('[%3]', `${that.#errorMessage}`)
                     .replace('[%4]', `${global.icons.working} `)
@@ -182,7 +194,7 @@ export class Split {
             let durationMessage = `${executionTime.seconds}.${executionTime.milliseconds}s`
             let stateIcon = (that.#errorMessage == '') ? global.icons.success : global.icons.fail
             logUpdate(that.#spinnerMessage
-                .replace('[%1]', that.sequence.toString().padStart(global.processed.total.toString().length, ' '))
+                .replace('[%1]', that.sequence.toString().padStart(that.total.toString().length, ' '))
                 .replace('[%2]', `. Processed in ${durationMessage}.`)
                 .replace('[%3]', `${that.#errorMessage}`)
                 .replace('[%4]', `${stateIcon} `)