mcdev 7.0.3 → 7.1.0

package/lib/util/devops.js

@@ -1,6 +1,6 @@
 import File from './file.js';
 import path from 'node:path';
-import inquirer from 'inquirer';
+import { select, confirm, Separator } from '@inquirer/prompts';
 import { Util } from './util.js';
 import Cli from './cli.js';
 import { simpleGit } from 'simple-git';
@@ -70,23 +70,24 @@ const DevOps = {
                 '--skip=1',
                 `-${commitHistory || properties.options.deployment.commitHistory || 10}`,
             ]);
-            const display = commits.all.map((commit) => ({
-                name: commit.date + ' / ' + commit.message + ' / ' + commit.author_name,
+            /** @type {({value: string, name?: string, description?: string, disabled?: boolean | string} | Separator)[]} */
+            const choices = commits.all.map((commit) => ({
+                name:
+                    commit.date.split('T').join(' ').split('+')[0] +
+                    ' / ' +
+                    commit.message +
+                    ' / ' +
+                    commit.author_name,
                 value: commit.hash,
             }));
-            // @ts-expect-error type checking this push() makes things very complicated...
-            display.push(new inquirer.Separator(' ==== '));
+            choices.push(new Separator(' ==== '));
 
-            const responses = await inquirer.prompt([
-                {
-                    type: 'list',
-                    message: 'Select base commit for comparison with current commit',
-                    name: 'commit',
-                    pageSize: 10,
-                    choices: display,
-                },
-            ]);
-            range = `${responses.commit}..HEAD`;
+            const baseCommit = await select({
+                message: 'Select base commit for comparison with current commit',
+                pageSize: 10,
+                choices: choices,
+            });
+            range = `${baseCommit}..HEAD`;
         }
 
         const metadata = {};
@@ -99,7 +100,8 @@ const DevOps = {
         /**
          * @type {DeltaPkgItem[]}
          */
-        const delta = (await git.diffSummary([range])).files
+        // first, process everything that can be done synchronously here
+        const deltaSync = (await git.diffSummary([range])).files
             // populate additional info for all changed files
             .map((/** @type {DeltaPkgItem} */ file) => {
                 // If file was moved it's path needs to be parsed
@@ -146,8 +148,13 @@ const DevOps = {
                     );
                     return false;
                 }
-            })
-            .map(async (/** @type {DeltaPkgItem} */ file) => {
+            });
+        // second, we need to do asynchronous file operations
+        /**
+         * @type {DeltaPkgItem[]}
+         */
+        const delta = await Promise.all(
+            deltaSync.map(async (/** @type {DeltaPkgItem} */ file) => {
                 // Gets external key based on file name und the assumption that filename = externalKey
                 if (file.type === 'folder') {
                     file.externalKey = null;
@@ -206,7 +213,8 @@ const DevOps = {
                     }
                 }
                 return file;
-            });
+            })
+        );
         if (
             !gitActionsCounter['add/update'] &&
             !gitActionsCounter.move &&
@@ -286,21 +294,17 @@ const DevOps = {
                 }
             }
 
-            let responses;
+            let isPurgeDeployFolder;
             if (!Util.skipInteraction) {
                 // deploy folder is in targets for definition creation
                 // recommend to purge their content first
-                responses = await inquirer.prompt([
-                    {
-                        type: 'confirm',
-                        name: 'isPurgeDeployFolder',
-                        message:
-                            'Do you want to empty the deploy folder (ensures no files from previous deployments remain)?',
-                        default: true,
-                    },
-                ]);
+                isPurgeDeployFolder = await confirm({
+                    message:
+                        'Do you want to empty the deploy folder (ensures no files from previous deployments remain)?',
+                    default: true,
+                });
             }
-            if (Util.skipInteraction || responses.isPurgeDeployFolder) {
+            if (Util.skipInteraction || isPurgeDeployFolder) {
                 // Clear output folder structure for selected sub-type
                 for (const buObject of Object.values(buObjects)) {
                     await File.remove(
@@ -317,7 +321,7 @@ const DevOps = {
             const copied = delta
                 .filter((file) => !file.file.endsWith('.md')) // filter documentation files
                 .map((file) =>
-                    File.copyFile(
+                    File.copyFileSimple(
                         file.file,
                         path
                             .normalize(file.file)
@@ -489,21 +493,17 @@ const DevOps = {
                 (Array.isArray(properties.directories.templateBuilds) &&
                     properties.directories.templateBuilds.includes(properties.directories.deploy))
             ) {
-                let responses;
+                let isPurgeDeployFolder;
                 if (!skipInteraction) {
                     // deploy folder is in targets for definition creation
                     // recommend to purge their content first
-                    responses = await inquirer.prompt([
-                        {
-                            type: 'confirm',
-                            name: 'isPurgeDeployFolder',
-                            message:
-                                'Do you want to empty the deploy folder (ensures no files from previous deployments remain)?',
-                            default: true,
-                        },
-                    ]);
+                    isPurgeDeployFolder = await confirm({
+                        message:
+                            'Do you want to empty the deploy folder (ensures no files from previous deployments remain)?',
+                        default: true,
+                    });
                 }
-                if (skipInteraction || responses.isPurgeDeployFolder) {
+                if (skipInteraction || isPurgeDeployFolder) {
                     // Clear output folder structure for selected sub-type
                     await File.remove(File.normalizePath([properties.directories.deploy]));
                 }
@@ -561,7 +561,6 @@ const DevOps = {
         for (let i = 1; i < tabled.length; i++) {
             for (let field of tabled[i]) {
                 if (field !== '') {
-                    // @ts-expect-error bad typing in jsonToTable
                     field = field === true ? '✓' : field === false ? '✗' : field;
                     output += `| ${field} `;
                 }

package/lib/util/file.js

@@ -1,6 +1,4 @@
-/* eslint-disable no-control-regex */
 'use strict';
-
 import fs from 'fs-extra';
 
 import path from 'node:path';
@@ -50,7 +48,7 @@ const File = {
      * @param {string} to - full filepath including name where file should go
      * @returns {Promise.<{status:'ok'|'skipped'|'failed', statusMessage:string, file:string}>} - results object
      */
-    async copyFile(from, to) {
+    async copyFileSimple(from, to) {
         try {
             await fs.copy(from, to);
             return { status: 'ok', statusMessage: null, file: from };
@@ -321,6 +319,7 @@ const File = {
 
             // save prettier errror into log file
             // Note: we have to filter color codes from prettier's error message before saving it to file
+            /* eslint-disable no-control-regex */
             this.writeToFile(
                 directory,
                 filename + '.error',
@@ -331,6 +330,7 @@ const File = {
                     ''
                 )}`
             );
+            /* eslint-enable no-control-regex */
 
             formatted = content;
         }
@@ -371,7 +371,7 @@ const File = {
      * @param {string | string[]} directory directory where the file is stored
      * @param {string} filename name of the file without '.json' ending
      * @param {boolean} cleanPath filters illegal chars if true
-     * @returns {Promise.<object> | object | void} Promise or JSON object depending on if async or not; void on error
+     * @returns {Promise.<object | object | void>} Promise or JSON object depending on if async or not; void on error
      */
     readJSONFile: async function (directory, filename, cleanPath) {
         try {
@@ -409,11 +409,8 @@ const File = {
         try {
             directory = this.filterIllegalPathChars(this.normalizePath(directory));
             filename = this.filterIllegalFilenames(filename);
-            // @ts-expect-error - somehow, the declared type does not allow for encoding to be passed in as a string, despite that working and being stated in the docs.
-            return await fs.readFile(
-                path.join(directory, filename + '.' + filetype),
-                encoding || 'utf8'
-            );
+            // @ts-expect-error somehow, the typing for fs-extra is not correct
+            return fs.readFile(path.join(directory, filename + '.' + filetype), encoding || 'utf8');
         } catch (ex) {
             Util.logger.debug('File.readFilteredFilename:: error | ' + ex.message);
         }
@@ -574,6 +571,6 @@ const File = {
         }
     },
 };
-const FileFs = { ...fs, ...File };
 
+const FileFs = Object.assign(fs, File);
 export default FileFs;

package/lib/util/init.config.js

@@ -4,7 +4,7 @@ import Cli from './cli.js';
 import File from './file.js';
 import config from './config.js';
 import { Util } from './util.js';
-import inquirer from 'inquirer';
+import { confirm } from '@inquirer/prompts';
 import path from 'node:path';
 import semver from 'semver';
 import { fileURLToPath } from 'node:url';
@@ -407,15 +407,11 @@ const Init = {
                     `- ✋  ${fileName} found with differences to the new standard version. We recommend updating it.`
                 );
                 if (!Util.skipInteraction) {
-                    const responses = await inquirer.prompt([
-                        {
-                            type: 'confirm',
-                            name: 'overrideFile',
-                            message: 'Would you like to update (override) it?',
-                            default: true,
-                        },
-                    ]);
-                    if (!responses.overrideFile) {
+                    const overrideFile = await confirm({
+                        message: 'Would you like to update (override) it?',
+                        default: true,
+                    });
+                    if (!overrideFile) {
                         // skip override without error
                         return true;
                     }

package/lib/util/init.git.js

@@ -1,7 +1,7 @@
 'use strict';
 import File from './file.js';
 
-import inquirer from 'inquirer';
+import { confirm, input } from '@inquirer/prompts';
 import { Util } from './util.js';
 import commandExists from 'command-exists';
 import { simpleGit } from 'simple-git';
@@ -100,18 +100,14 @@ const Init = {
                 Util.logger.info(
                     `Your remote Git repository is still empty and ready to store your initial backup. Hint: This is the server version of the repo which you share with your team.`
                 );
-                let responses;
+                let gitPush;
                 if (!skipInteraction) {
-                    responses = await inquirer.prompt([
-                        {
-                            type: 'confirm',
-                            name: 'gitPush',
-                            message: `Would you like to 'push' your backup to the remote Git repo?`,
-                            default: true,
-                        },
-                    ]);
+                    gitPush = await confirm({
+                        message: `Would you like to 'push' your backup to the remote Git repo?`,
+                        default: true,
+                    });
                 }
-                if (skipInteraction?.gitPush === 'true' || responses?.gitPush) {
+                if (skipInteraction?.gitPush === 'true' || gitPush) {
                     Util.execSync('git', ['push', '-u', 'origin', 'master']);
                 }
             } else if (remoteBranchesExist === true) {
@@ -129,49 +125,42 @@ const Init = {
     async _addGitRemote() {
         const skipInteraction = Util.skipInteraction;
         // #1 ask if the user wants to do it now
-        let responses;
+        let gitOriginKnown;
         if (!skipInteraction) {
-            responses = await inquirer.prompt([
-                {
-                    type: 'confirm',
-                    name: 'gitOriginKnown',
-                    message: `Do you know the remote/clone URL of your Git repo (starts with ssh:// or http:// and ends on '.git')?`,
-                    default: true,
-                },
-            ]);
+            gitOriginKnown = await confirm({
+                message: `Do you know the remote/clone URL of your Git repo (starts with ssh:// or http:// and ends on '.git')?`,
+                default: true,
+            });
         }
-        if (skipInteraction || responses.gitOriginKnown) {
+        if (skipInteraction || gitOriginKnown) {
             // #2 if yes, guide the user to input the right url
-            /* eslint-disable unicorn/prefer-ternary */
+
+            let answers = {};
             if (skipInteraction) {
-                responses = skipInteraction;
+                answers = skipInteraction;
             } else {
-                responses = await inquirer.prompt([
-                    {
-                        type: 'input',
-                        name: 'gitRemoteUrl',
-                        message: 'Git Remote URL',
-                        validate: (value) => {
-                            value = value.trim();
-                            if (!value || value.length < 10) {
-                                return 'Please enter a valid remote URL';
-                            } else if (!value.startsWith('http') && !value.startsWith('ssh')) {
-                                return `Your Git Remote URL should start with 'http' or 'ssh'`;
-                            } else if (value.endsWith('.git')) {
-                                // all good
-                                return true;
-                            } else {
-                                return `Your Git Remote URL should end with '.git'`;
-                            }
-                        },
+                answers.gitRemoteUrl = await input({
+                    message: 'Git Remote URL',
+                    validate: (value) => {
+                        value = value.trim();
+                        if (!value || value.length < 10) {
+                            return 'Please enter a valid remote URL';
+                        } else if (!value.startsWith('http') && !value.startsWith('ssh')) {
+                            return `Your Git Remote URL should start with 'http' or 'ssh'`;
+                        } else if (value.endsWith('.git')) {
+                            // all good
+                            return true;
+                        } else {
+                            return `Your Git Remote URL should end with '.git'`;
+                        }
                     },
-                ]);
+                });
             }
-            /* eslint-enable unicorn/prefer-ternary */
-            if (typeof responses.gitRemoteUrl === 'string') {
-                responses.gitRemoteUrl = responses.gitRemoteUrl.trim();
-                Util.execSync('git', ['remote', 'add', 'origin', responses.gitRemoteUrl]);
-                return responses.gitRemoteUrl.split('/').pop().split('.')[0];
+
+            if (typeof answers.gitRemoteUrl === 'string') {
+                answers.gitRemoteUrl = answers.gitRemoteUrl.trim();
+                Util.execSync('git', ['remote', 'add', 'origin', answers.gitRemoteUrl]);
+                return answers.gitRemoteUrl.split('/').pop().split('.')[0];
             }
         }
     },
@@ -187,6 +176,7 @@ const Init = {
             `Please confirm your Git user name & email. It should be in the format 'FirstName LastName' and 'your.email@accenture.com'. The current (potentially wrong) values are provided as default. If correct, confirm with ENTER, otherwise please update:`
         );
         let responses;
+
         /* eslint-disable unicorn/prefer-ternary */
         if (skipInteraction) {
             responses = {
@@ -194,10 +184,8 @@ const Init = {
                 email: gitUser['user.email'],
             };
         } else {
-            responses = await inquirer.prompt([
-                {
-                    type: 'input',
-                    name: 'name',
+            responses = {
+                name: await input({
                     message: 'Git user.name',
                     default: gitUser['user.name'] || null,
                     // eslint-disable-next-line jsdoc/require-jsdoc
@@ -212,10 +200,8 @@ const Init = {
                         }
                         return true;
                     },
-                },
-                {
-                    type: 'input',
-                    name: 'email',
+                }),
+                email: await input({
                     message: 'Git user.email',
                     default: gitUser['user.email'] || null,
                     // eslint-disable-next-line jsdoc/require-jsdoc
@@ -228,8 +214,8 @@ const Init = {
                         }
                         return true;
                     },
-                },
-            ]);
+                }),
+            };
         }
         /* eslint-enable unicorn/prefer-ternary */
 

package/lib/util/init.js

@@ -5,7 +5,7 @@ import config from './config.js';
 import InitGit from './init.git.js';
 import InitNpm from './init.npm.js';
 import InitConfig from './init.config.js';
-import inquirer from 'inquirer';
+import { confirm, input, select } from '@inquirer/prompts';
 import { Util } from './util.js';
 import fs from 'node:fs';
 import path from 'node:path';
@@ -132,7 +132,7 @@ const Init = {
                 // add-credential mode
                 Util.logger.warn(Util.configFileName + ' found in root');
 
-                let responses;
+                let isAddCredential;
                 if (skipInteraction) {
                     if (
                         skipInteraction.client_id &&
@@ -151,17 +151,13 @@ const Init = {
                         );
                     }
                 } else {
-                    responses = await inquirer.prompt([
-                        {
-                            type: 'confirm',
-                            name: 'isAddCredential',
-                            message: 'Do you want to add another credential instead?',
-                            default: false,
-                        },
-                    ]);
+                    isAddCredential = await confirm({
+                        message: 'Do you want to add another credential instead?',
+                        default: false,
+                    });
                 }
                 let credentialName;
-                if (skipInteraction || responses.isAddCredential) {
+                if (skipInteraction || isAddCredential) {
                     credentialName = await Cli.addExtraCredential(properties);
                 }
                 if (credentialName) {
@@ -224,29 +220,22 @@ const Init = {
             return;
         }
 
-        const responses = await inquirer.prompt([
-            {
-                type: 'confirm',
-                name: 'isJoin',
-                message:
-                    'Do you want to join an existing project for which you have a Git-Repository URL?',
-                default: true,
-            },
-        ]);
-        if (responses.isJoin) {
-            const gitRepoQs = await inquirer.prompt([
-                {
-                    type: 'input',
-                    name: 'gitRepoUrl',
+        const isJoin = await confirm({
+            message:
+                'Do you want to join an existing project for which you have a Git-Repository URL?',
+            default: true,
+        });
+        if (isJoin) {
+            const gitRepoQs = {
+                gitRepoUrl: await input({
                     message: 'Please enter the Git-Repository URL',
-                },
-                {
-                    type: 'input',
-                    name: 'gitBranch',
+                }),
+                gitBranch: await input({
                     message:
                         'If you were asked to work on a specific branch, please enter it now (or leave empty for default)',
-                },
-            ]);
+                }),
+            };
+
             const repoName = gitRepoQs.gitRepoUrl.split('/').pop().replace('.git', '');
             // clone repo into current folder
             Util.logger.info(
@@ -330,15 +319,10 @@ const Init = {
                 );
             }
         } else {
-            const responses = await inquirer.prompt([
-                {
-                    type: 'list',
-                    name: 'developmentBu',
-                    message: 'Please select your development business unit:',
-                    choices: businessUnits.map((bu) => ({ name: bu, value: bu })),
-                },
-            ]);
-            sourceBuName = responses.developmentBu;
+            sourceBuName = await select({
+                message: 'Please select your development business unit:',
+                choices: businessUnits.map((bu) => ({ name: bu, value: bu })),
+            });
         }
         // set source list
         properties.marketList['deployment-source'][firstCredentialName + '/' + sourceBuName] =
@@ -362,18 +346,14 @@ const Init = {
      */
     async _downloadAllBUs(bu, gitStatus) {
         const skipInteraction = Util.skipInteraction;
-        let responses;
+        let initialRetrieveAll;
         if (!skipInteraction) {
-            responses = await inquirer.prompt([
-                {
-                    type: 'confirm',
-                    name: 'initialRetrieveAll',
-                    message: 'Do you want to start downloading all Business Units (recommended)?',
-                    default: true,
-                },
-            ]);
+            initialRetrieveAll = await confirm({
+                message: 'Do you want to start downloading all Business Units (recommended)?',
+                default: true,
+            });
         }
-        if (skipInteraction?.downloadBUs === 'true' || responses?.initialRetrieveAll) {
+        if (skipInteraction?.downloadBUs === 'true' || initialRetrieveAll) {
             Util.execSync('mcdev', ['retrieve', bu]);
 
             if (gitStatus === 'init') {
@@ -479,15 +459,11 @@ const Init = {
             cloudServiceFound = true;
         }
         if (cloudServiceFound) {
-            const responses = await inquirer.prompt([
-                {
-                    type: 'confirm',
-                    name: 'ignoreCloudWarning',
-                    message: 'Do you want to continue anyways?',
-                    default: false,
-                },
-            ]);
-            if (!responses.ignoreCloudWarning) {
+            const ignoreCloudWarning = await confirm({
+                message: 'Do you want to continue anyways?',
+                default: false,
+            });
+            if (!ignoreCloudWarning) {
                 Util.logger.error('Exiting due to cloud service warning');
                 return false;
             }