mcdev 7.0.3 → 7.0.4

package/lib/cli.js

@@ -10,18 +10,18 @@ import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import Mcdev from './index.js';
 
+// use this instead of setting "true" directly to more easily find deprecated commands in this file
+const isDeprecated = true;
 /**
  * @typedef {import('../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
  */
 yargs(hideBin(process.argv))
     .scriptName('mcdev')
     .usage('$0 <command> [options]')
-    // @ts-expect-error
-    .command({
-        command: 'retrieve [BU] [TYPE] [KEY]',
-        aliases: ['r'],
-        desc: 'retrieves metadata of a business unit',
-        builder: (yargs) => {
+    .command(
+        ['retrieve [BU] [TYPE] [KEY]', 'r'],
+        'retrieves metadata of a business unit',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -48,9 +48,8 @@ yargs(hideBin(process.argv))
                     group: 'Options for retrieve:',
                     describe:
                         'filter metadata components (can include % as wildcard or _ for a single character)',
-                });
-        },
-        handler: (argv) => {
+                }),
+        (argv) => {
             Mcdev.setOptions(argv);
             const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
             if ('undefined' === typeof typeKeyCombo) {
@@ -58,14 +57,12 @@ yargs(hideBin(process.argv))
             } else {
                 Mcdev.retrieve(argv.BU, typeKeyCombo);
             }
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'deploy [BU] [TYPE] [KEY]',
-        aliases: ['d'],
-        desc: 'deploys local metadata to a business unit',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['deploy [BU] [TYPE] [KEY]', 'd'],
+        'deploys local metadata to a business unit',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -144,9 +141,8 @@ yargs(hideBin(process.argv))
                     group: 'Options for deploy:',
                     describe:
                         "ensure that updates to shared DataExtensions become visible in child BU's data designer (SF Known issue W-11031095)",
-                });
-        },
-        handler: (argv) => {
+                }),
+        (argv) => {
             Mcdev.setOptions(argv);
 
             const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
@@ -155,69 +151,55 @@ yargs(hideBin(process.argv))
             } else {
                 Mcdev.deploy(argv.BU, typeKeyCombo);
             }
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'init [credentialsName]',
-        desc: `creates '${Util.configFileName}' in your root or adds additional credentials to the existing one`,
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['init [credentialsName]'],
+        `creates '${Util.configFileName}' in your root or adds additional credentials to the existing one`,
+        (yargs) =>
             yargs.positional('credentialsName', {
                 type: 'string',
                 describe: 'name of your installed package',
-            });
-        },
-        handler: (argv) => {
+            }),
+        (argv) => {
             Mcdev.setOptions(argv);
             Mcdev.initProject(argv.credentialsName);
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'join',
-        desc: `clones an existing project from git`,
-        handler: (argv) => {
-            Mcdev.setOptions(argv);
-            Mcdev.joinProject();
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'reloadBUs [credentialsName]',
-        aliases: ['rb', 'refreshBUs'],
-        desc: 'loads the list of available BUs from the server and saves it to your config',
-        builder: (yargs) => {
+        }
+    )
+    .command(['join'], `clones an existing project from git`, {}, (argv) => {
+        Mcdev.setOptions(argv);
+        Mcdev.joinProject();
+    })
+    .command(
+        ['reloadBUs [credentialsName]', 'rb', 'refreshBUs'],
+        'loads the list of available BUs from the server and saves it to your config',
+        (yargs) =>
             yargs.positional('credentialsName', {
                 type: 'string',
                 describe: 'name of your installed package',
-            });
-        },
-        handler: (argv) => {
+            }),
+        (argv) => {
             Mcdev.setOptions(argv);
             Mcdev.findBUs(argv.credentialsName);
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'badKeys [BU]',
-        desc: 'lists metadata with random API names in specified Business Unit directory',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['badKeys [BU]'],
+        'lists metadata with random API names in specified Business Unit directory',
+        (yargs) =>
             yargs.positional('BU', {
                 type: 'string',
                 describe: 'the business unit to deploy to',
-            });
-        },
-        handler: (argv) => {
+            }),
+        (argv) => {
             Mcdev.setOptions(argv);
             Mcdev.badKeys(argv.BU);
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'document <BU> <TYPE>',
-        aliases: ['doc'],
-        desc: 'Creates Markdown or HTML documentation for the selected type',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['document <BU> <TYPE>', 'doc'],
+        'Creates Markdown or HTML documentation for the selected type',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -228,19 +210,16 @@ yargs(hideBin(process.argv))
                     type: 'string',
                     describe:
                         'metadata type to generate docs for; currently supported: dataExtension, role',
-                });
-        },
-        handler: (argv) => {
+                }),
+        (argv) => {
             Mcdev.setOptions(argv);
             Mcdev.document(argv.BU, argv.TYPE);
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'delete <BU> [TYPE] [KEY]',
-        aliases: ['del'],
-        desc: 'deletes metadata of selected type and external key',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['delete <BU> [TYPE] [KEY]', 'del'],
+        'deletes metadata of selected type and external key',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -258,30 +237,25 @@ yargs(hideBin(process.argv))
                 .option('metadata', {
                     type: 'string',
                     alias: 'm',
-                    group: 'Options for retrieve:',
-                    describe:
-                        'type or type:key or type:i:id or type:n:name to retrieve; if not provided, all metadata will be retrieved',
-                });
-        },
-        handler: (argv) => {
+                    group: 'Options for delete:',
+                    describe: 'type or type:key or type:i:id or type:n:name to delete',
+                }),
+        (argv) => {
             Mcdev.setOptions(argv);
-            const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata, ['key', 'id'], true);
+            const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata, ['key', 'id']);
             if ('undefined' === typeof typeKeyCombo) {
                 if (argv.TYPE && argv.KEY) {
-                    Mcdev.deleteByKey(argv.BU, argv.TYPE, argv.KEY);
+                    Mcdev.deleteByKey(argv.BU, argv.TYPE, csvToArray(argv.KEY));
                 }
             } else {
-                const type = Object.keys(typeKeyCombo)[0];
-                Mcdev.deleteByKey(argv.BU, type, typeKeyCombo[type][0]);
+                Mcdev.deleteByKey(argv.BU, typeKeyCombo, null);
             }
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'resolveId <BU> <TYPE> <ID>',
-        aliases: ['rid'],
-        desc: 'resolves metadata key by ID',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['resolveId <BU> <TYPE> <ID>', 'rid'],
+        'resolves metadata key by ID',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -300,20 +274,17 @@ yargs(hideBin(process.argv))
                     type: 'boolean',
                     group: 'Options for resolveId:',
                     describe: 'optionaly return info in json format',
-                });
-            // TODO: add option --metadata
-        },
-        handler: (argv) => {
+                }),
+        // TODO: add option --metadata
+        (argv) => {
             Mcdev.setOptions(argv);
             Mcdev.resolveId(argv.BU, argv.TYPE, argv.ID);
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'retrieveAsTemplate <BU> <TYPE> <NAME> <MARKET>',
-        aliases: ['rt'],
-        desc: '[DEPRECATED] Retrieves a specific metadata file by name from the server for templating',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['retrieveAsTemplate <BU> <TYPE> <NAME> <MARKET>', 'rt'],
+        '[DEPRECATED] Retrieves a specific metadata file by name from the server for templating',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -331,19 +302,19 @@ yargs(hideBin(process.argv))
                 .positional('MARKET', {
                     type: 'string',
                     describe: 'market used for reverse building template',
-                });
-        },
-        handler: (argv) => {
+                }),
+
+        (argv) => {
             Mcdev.setOptions(argv);
             Mcdev.retrieveAsTemplate(argv.BU, argv.TYPE, csvToArray(argv.NAME), argv.MARKET);
         },
-        deprecated: true,
-    })
-    // @ts-expect-error
-    .command({
-        command: 'build',
-        desc: 'runs buildTemplate followed by buildDefinition',
-        builder: (yargs) => {
+        [],
+        isDeprecated
+    )
+    .command(
+        ['build'],
+        'runs buildTemplate followed by buildDefinition',
+        (yargs) =>
             yargs
                 .option('metadata', {
                     type: 'string',
@@ -386,9 +357,8 @@ yargs(hideBin(process.argv))
                     describe:
                         'if defined, the marketTo parameter has to be a marketList and buildDefinitionBulk is executed',
                     demandOption: true,
-                });
-        },
-        handler: (argv) => {
+                }),
+        (argv) => {
             Mcdev.setOptions(argv);
             const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
             if ('undefined' !== typeof typeKeyCombo) {
@@ -401,14 +371,12 @@ yargs(hideBin(process.argv))
                     argv.bulk
                 );
             }
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'buildTemplate <BU> [TYPE] [KEY] [MARKET]',
-        aliases: ['bt'],
-        desc: 'builds a template out of a specific metadata file already in your retrieve folder',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['buildTemplate <BU> [TYPE] [KEY] [MARKET]', 'bt'],
+        'builds a template out of a specific metadata file already in your retrieve folder',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -437,9 +405,8 @@ yargs(hideBin(process.argv))
                     type: 'string',
                     group: 'Options for buildTemplate:',
                     describe: 'market used for reverse building template',
-                });
-        },
-        handler: (argv) => {
+                }),
+        (argv) => {
             Mcdev.setOptions(argv);
             const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
             if ('undefined' === typeof typeKeyCombo) {
@@ -452,14 +419,12 @@ yargs(hideBin(process.argv))
             } else {
                 Mcdev.buildTemplate(argv.BU, typeKeyCombo, null, argv.MARKET || argv.market);
             }
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'buildDefinition <BU> [TYPE] [FILENAME] [MARKET]',
-        aliases: ['bd'],
-        desc: 'builds metadata definition based on template',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['buildDefinition <BU> [TYPE] [FILENAME] [MARKET]', 'bd'],
+        'builds metadata definition based on template',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -487,9 +452,8 @@ yargs(hideBin(process.argv))
                     type: 'string',
                     group: 'Options for buildDefinition:',
                     describe: 'market used for building deployable definition',
-                });
-        },
-        handler: (argv) => {
+                }),
+        (argv) => {
             Mcdev.setOptions(argv);
             const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
             if ('undefined' === typeof typeKeyCombo) {
@@ -502,14 +466,12 @@ yargs(hideBin(process.argv))
             } else {
                 Mcdev.buildDefinition(argv.BU, typeKeyCombo, null, argv.MARKET || argv.market);
             }
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'buildDefinitionBulk <LISTNAME> [TYPE] [FILENAME]',
-        aliases: ['bdb'],
-        desc: 'builds metadata definition based on template en bulk',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['buildDefinitionBulk <LISTNAME> [TYPE] [FILENAME]', 'bdb'],
+        'builds metadata definition based on template en bulk',
+        (yargs) =>
             yargs
                 .positional('LISTNAME', {
                     type: 'string',
@@ -528,9 +490,8 @@ yargs(hideBin(process.argv))
                     alias: 'm',
                     group: 'Options for buildDefinitionBulk:',
                     describe: 'type:templateName combos to build template for',
-                });
-        },
-        handler: (argv) => {
+                }),
+        (argv) => {
             Mcdev.setOptions(argv);
             const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
             if ('undefined' === typeof typeKeyCombo) {
@@ -538,41 +499,35 @@ yargs(hideBin(process.argv))
             } else {
                 Mcdev.buildDefinitionBulk(argv.LISTNAME, typeKeyCombo);
             }
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'selectTypes',
-        aliases: ['st'],
-        desc: 'lets you choose what metadata types to retrieve',
-        handler: (argv) => {
+        }
+    )
+    .command(
+        ['selectTypes', 'st'],
+        'lets you choose what metadata types to retrieve',
+        {},
+        (argv) => {
             Mcdev.setOptions(argv);
             Mcdev.selectTypes();
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'explainTypes',
-        aliases: ['et'],
-        desc: 'explains metadata types that can be retrieved',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['explainTypes', 'et'],
+        'explains metadata types that can be retrieved',
+        (yargs) =>
             yargs.option('json', {
                 type: 'boolean',
                 group: 'Options for explainTypes:',
                 describe: 'optionaly return info in json format',
-            });
-        },
-        handler: (argv) => {
+            }),
+        (argv) => {
             Mcdev.setOptions(argv);
             Mcdev.explainTypes();
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'createDeltaPkg [range]',
-        aliases: ['cdp'],
-        desc: 'Copies commit-based file delta into deploy folder',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['createDeltaPkg [range]', 'cdp'],
+        'Copies commit-based file delta into deploy folder',
+        (yargs) =>
             yargs
                 .positional('range', {
                     type: 'string',
@@ -588,20 +543,16 @@ yargs(hideBin(process.argv))
                     type: 'number',
                     group: 'Options for createDeltaPkg:',
                     describe: 'Number of commits to look back for changes (supersedes config)',
-                });
-        },
-        handler: (argv) => {
+                }),
+        (argv) => {
             Mcdev.setOptions(argv);
-            // @ts-expect-error - us passing in argv directly here is a bit lazy and ts warns us about it...
             Mcdev.createDeltaPkg(argv);
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'getFilesToCommit <BU> <TYPE> <KEY>',
-        aliases: ['fc'],
-        desc: 'returns a list of relative paths to files one needs to include in a commit',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['getFilesToCommit <BU> <TYPE> <KEY>', 'fc'],
+        'returns a list of relative paths to files one needs to include in a commit',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -615,20 +566,17 @@ yargs(hideBin(process.argv))
                 .positional('KEY', {
                     type: 'string',
                     describe: 'key(s) of the metadata component(s)',
-                });
-            // TODO: add option --metadata
-        },
-        handler: (argv) => {
+                }),
+        // TODO: add option --metadata
+        (argv) => {
             Mcdev.setOptions(argv);
             Mcdev.getFilesToCommit(argv.BU, argv.TYPE, csvToArray(argv.KEY));
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'refresh <BU> [TYPE] [KEY]',
-        aliases: ['re'],
-        desc: 'ensures that updates are properly published',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['refresh <BU> [TYPE] [KEY]', 're'],
+        'ensures that updates are properly published',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -641,20 +589,17 @@ yargs(hideBin(process.argv))
                 .positional('KEY', {
                     type: 'string',
                     describe: 'key(s) of the metadata component(s)',
-                });
-            // TODO: add option --metadata
-        },
-        handler: (argv) => {
+                }),
+        // TODO: add option --metadata
+        (argv) => {
             Mcdev.setOptions(argv);
             Mcdev.refresh(argv.BU, argv.TYPE, csvToArray(argv.KEY));
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'execute <BU> <TYPE> [KEY]',
-        aliases: ['exec', 'start'],
-        desc: 'executes the entity (query/journey/automation etc.)',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['execute <BU> <TYPE> [KEY]', 'exec', 'start'],
+        'executes the entity (query/journey/automation etc.)',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -679,21 +624,18 @@ yargs(hideBin(process.argv))
                     group: 'Options for execute:',
                     describe:
                         'optionally start existing schedule instead of running item once immediately (only works for automations)',
-                });
-            // TODO: add option --metadata
-        },
-        handler: (argv) => {
+                }),
+        // TODO: add option --metadata
+        (argv) => {
             Mcdev.setOptions(argv);
             // ! do not allow multiple types to be passed in here via csvToArray
             Mcdev.execute(argv.BU, argv.TYPE, csvToArray(argv.KEY));
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'schedule <BU> <TYPE> [KEY]',
-        aliases: ['sched'],
-        desc: 'starts the predefined schedule of the item (shortcut for running execute --schedule)',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['schedule <BU> <TYPE> [KEY]', 'sched'],
+        'starts the predefined schedule of the item (shortcut for running execute --schedule)',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -712,21 +654,18 @@ yargs(hideBin(process.argv))
                     group: 'Options for execute:',
                     describe:
                         'filter metadata components (can include % as wildcard or _ for a single character)',
-                });
-            // TODO: add option --metadata
-        },
-        handler: (argv) => {
+                }),
+        // TODO: add option --metadata
+        (argv) => {
             Mcdev.setOptions(argv);
             // ! do not allow multiple types to be passed in here via csvToArray
             Mcdev.schedule(argv.BU, argv.TYPE, csvToArray(argv.KEY));
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'pause <BU> <TYPE> [KEY]',
-        aliases: ['p', 'stop'],
-        desc: 'pauses the entity (automation etc.)',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['pause <BU> <TYPE> [KEY]', 'p', 'stop'],
+        'pauses the entity (automation etc.)',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -745,21 +684,18 @@ yargs(hideBin(process.argv))
                     group: 'Options for pause:',
                     describe:
                         'filter metadata components (can include % as wildcard or _ for a single character)',
-                });
-            // TODO: add option --metadata
-        },
-        handler: (argv) => {
+                }),
+        // TODO: add option --metadata
+        (argv) => {
             Mcdev.setOptions(argv);
             // ! do not allow multiple types to be passed in here via csvToArray
             Mcdev.pause(argv.BU, argv.TYPE, csvToArray(argv.KEY));
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'fixKeys <BU> [TYPE] [KEY]',
-        aliases: ['fx'],
-        desc: 'changes the key of the items to match the name',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['fixKeys <BU> [TYPE] [KEY]', 'fx'],
+        'changes the key of the items to match the name',
+        (yargs) =>
             yargs
                 .positional('BU', {
                     type: 'string',
@@ -805,9 +741,8 @@ yargs(hideBin(process.argv))
                     group: 'Options for fixKeys:',
                     describe:
                         'optionally start existing schedule instead of running item once immediately (only works for automations)',
-                });
-        },
-        handler: (argv) => {
+                }),
+        (argv) => {
             Mcdev.setOptions(argv);
             const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
             if ('undefined' === typeof typeKeyCombo) {
@@ -815,14 +750,12 @@ yargs(hideBin(process.argv))
             } else {
                 Mcdev.fixKeys(argv.BU, typeKeyCombo);
             }
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'replaceContentBlock',
-        aliases: ['rcb'],
-        desc: 'Replaces ContentBlockById, ContentBlockByKey or ContentBlockByName functions with each other in AMPscript',
-        builder: (yargs) => {
+        }
+    )
+    .command(
+        ['replaceContentBlock', 'rcb'],
+        'Replaces ContentBlockById, ContentBlockByKey or ContentBlockByName functions with each other in AMPscript',
+        (yargs) =>
             yargs
                 .option('bu', {
                     type: 'string',
@@ -882,24 +815,22 @@ yargs(hideBin(process.argv))
                         }
                     }
                     return true;
-                });
-        },
-        handler: (argv) => {
+                }),
+        (argv) => {
             Mcdev.setOptions(argv);
             const typeKeyCombo = Mcdev.metadataToTypeKey(argv.metadata);
             Mcdev.replaceCbReference(argv.bu, typeKeyCombo, argv.to, argv.from);
-        },
-    })
-    // @ts-expect-error
-    .command({
-        command: 'upgrade',
-        aliases: ['up'],
-        desc: 'Add NPM dependencies and IDE configuration files to your project',
-        handler: (argv) => {
+        }
+    )
+    .command(
+        ['upgrade', 'up'],
+        'Add NPM dependencies and IDE configuration files to your project',
+        {},
+        (argv) => {
             Mcdev.setOptions(argv);
             Mcdev.upgrade();
-        },
-    })
+        }
+    )
     .option('verbose', {
         type: 'boolean',
         description: 'Run with verbose CLI output',