mcdev 3.1.3 → 4.0.1

package/lib/util/init.git.js

@@ -1,10 +1,10 @@
 'use strict';
-
+const TYPE = require('../../types/mcdev.d');
 const File = require('./file');
 const inquirer = require('inquirer');
 const Util = require('./util');
 const commandExists = require('command-exists');
-const git = require('simple-git/promise')();
+const git = require('simple-git')();
 
 /**
  * CLI helper class
@@ -13,9 +13,9 @@ const git = require('simple-git/promise')();
 const Init = {
     /**
      * check if git repo exists and otherwise create one
-     * @param {Object} [skipInteraction] signals what to insert automatically for things usually asked via wizard
-     * @param {String} skipInteraction.gitRemoteUrl URL of Git remote server
-     * @returns {Promise<{status:String, repoName:String}>} success flag
+     *
+     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     * @returns {Promise.<{status: string, repoName: string}>} success flag
      */
     async initGitRepo(skipInteraction) {
         const result = { status: null, repoName: null };
@@ -23,13 +23,13 @@ const Init = {
         if (!commandExists.sync('git')) {
             Util.logger.error('Git installation not found.');
             Util.logger.error(
-                'Please follow our tutorial on installing Git: https://go.accenture.com/mcdevdocs'
+                'Please follow our tutorial on installing Git: https://github.com/Accenture/sfmc-devtools#212-install-the-git-command-line'
             );
             result.status = 'error';
             return result;
         }
         // 3. test if in git repo
-        const gitRepoFoundInCWD = File.existsSync('.git');
+        const gitRepoFoundInCWD = await File.pathExists('.git');
         let newRepoInitialized = null;
         if (gitRepoFoundInCWD) {
             Util.logger.info(`✔️  Git repository found`);
@@ -37,7 +37,7 @@ const Init = {
         } else {
             Util.logger.warn('No Git repository found. Initializing git:');
             Util.execSync('git', ['init']);
-            if (File.existsSync('.git')) {
+            if (await File.pathExists('.git')) {
                 newRepoInitialized = true;
             } else {
                 Util.logger.error(
@@ -50,7 +50,7 @@ const Init = {
         Util.logger.info('Ensuring long file paths are not causing issues with git:');
         try {
             Util.execSync('git', ['config', '--local', 'core.longpaths', 'true']);
-        } catch (ex) {
+        } catch {
             Util.logger.warn(
                 `Updating your git config failed. We recommend running the above command manually yourself to avoid issues.`
             );
@@ -58,7 +58,7 @@ const Init = {
         Util.logger.info('Ensuring checkout (git pull) as-is and commit Unix-style line endings:');
         try {
             Util.execSync('git', ['config', '--local', 'core.autocrlf', 'input']);
-        } catch (ex) {
+        } catch {
             Util.logger.warn(
                 `Updating your git config failed. We recommend running the above command manually yourself to avoid issues.`
             );
@@ -77,7 +77,8 @@ const Init = {
     },
     /**
      * offer to push the new repo straight to the server
-     * @param {Boolean|Object} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     *
+     * @param {boolean | TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {void}
      */
     async gitPush(skipInteraction) {
@@ -101,19 +102,14 @@ const Init = {
                 );
                 let responses;
                 if (!skipInteraction) {
-                    const questions = [
+                    responses = await inquirer.prompt([
                         {
                             type: 'confirm',
                             name: 'gitPush',
                             message: `Would you like to 'push' your backup to the remote Git repo?`,
                             default: true,
                         },
-                    ];
-                    responses = await new Promise((resolve) => {
-                        inquirer.prompt(questions).then((answers) => {
-                            resolve(answers);
-                        });
-                    });
+                    ]);
                 }
                 if (skipInteraction || responses.gitPush) {
                     Util.execSync('git', ['push', '-u', 'origin', 'master']);
@@ -127,34 +123,30 @@ const Init = {
     },
     /**
      * offers to add the git remote origin
-     * @param {Object} [skipInteraction] signals what to insert automatically for things usually asked via wizard
-     * @param {String} skipInteraction.gitRemoteUrl URL of Git remote server
-     * @returns {String} repo name (optionally)
+     *
+     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     * @returns {string} repo name (optionally)
      */
     async _addGitRemote(skipInteraction) {
         // #1 ask if the user wants to do it now
         let responses;
         if (!skipInteraction) {
-            const questions = [
+            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,
                 },
-            ];
-            responses = await new Promise((resolve) => {
-                inquirer.prompt(questions).then((answers) => {
-                    resolve(answers);
-                });
-            });
+            ]);
         }
         if (skipInteraction || responses.gitOriginKnown) {
             // #2 if yes, guide the user to input the right url
+            /* eslint-disable unicorn/prefer-ternary */
             if (skipInteraction) {
                 responses = skipInteraction;
             } else {
-                const questions = [
+                responses = await inquirer.prompt([
                     {
                         type: 'input',
                         name: 'gitRemoteUrl',
@@ -173,13 +165,10 @@ const Init = {
                             }
                         },
                     },
-                ];
-                responses = await new Promise((resolve) => {
-                    inquirer.prompt(questions).then((answers) => {
-                        resolve(answers);
-                    });
-                });
+                ]);
             }
+            /* eslint-enable unicorn/prefer-ternary */
+
             responses.gitRemoteUrl = responses.gitRemoteUrl.trim();
             Util.execSync('git', ['remote', 'add', 'origin', responses.gitRemoteUrl]);
             return responses.gitRemoteUrl.split('/').pop().split('.')[0];
@@ -187,7 +176,8 @@ const Init = {
     },
     /**
      * checks global config and ask to config the user info and then store it locally
-     * @param {Object|Boolean} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     *
+     * @param {boolean | TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {void}
      */
     async _updateGitConfigUser(skipInteraction) {
@@ -196,19 +186,20 @@ 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 = {
                 name: gitUser['user.name'],
                 email: gitUser['user.email'],
             };
         } else {
-            const questions = [
+            responses = await inquirer.prompt([
                 {
                     type: 'input',
                     name: 'name',
                     message: 'Git user.name',
                     default: gitUser['user.name'] || null,
-                    // eslint-disable-next-line require-jsdoc
+                    // eslint-disable-next-line jsdoc/require-jsdoc
                     validate: function (value) {
                         if (
                             !value ||
@@ -226,7 +217,7 @@ const Init = {
                     name: 'email',
                     message: 'Git user.email',
                     default: gitUser['user.email'] || null,
-                    // eslint-disable-next-line require-jsdoc
+                    // eslint-disable-next-line jsdoc/require-jsdoc
                     validate: function (value) {
                         value = value.trim();
                         const regex =
@@ -237,24 +228,28 @@ const Init = {
                         return true;
                     },
                 },
-            ];
-            responses = await new Promise((resolve) => {
-                inquirer.prompt(questions).then((answers) => {
-                    resolve(answers);
-                });
-            });
+            ]);
         }
+        /* eslint-enable unicorn/prefer-ternary */
+
         if (responses.name && responses.email) {
             // name can contain spaces - wrap it in quotes
             const name = `"${responses.name.trim()}"`;
             const email = responses.email.trim();
-            Util.execSync('git', ['config', '--local', 'user.name', name]);
-            Util.execSync('git', ['config', '--local', 'user.email', email]);
+            try {
+                Util.execSync('git', ['config', '--local', 'user.name', name]);
+                Util.execSync('git', ['config', '--local', 'user.email', email]);
+            } catch (ex) {
+                // if project folder is not a git folder then using --local will lead to a fatal error
+                Util.logger.warn('- Could not update git user name and email');
+                Util.logger.debug(ex.message);
+            }
         }
     },
     /**
      * retrieves the global user.name and user.email values
-     * @returns {Promise<{'user.name': String, 'user.email': String}>} user.name and user.email
+     *
+     * @returns {Promise.<{'user.name': string, 'user.email': string}>} user.name and user.email
      */
     async _getGitConfigUser() {
         const gitConfigs = await git.listConfig();
@@ -262,14 +257,14 @@ const Init = {
         delete gitConfigs.values['.git/config'];
         const result = {};
 
-        Object.keys(gitConfigs.values).forEach((file) => {
+        for (const file of Object.keys(gitConfigs.values)) {
             if (gitConfigs.values[file]['user.name']) {
                 result['user.name'] = gitConfigs.values[file]['user.name'];
             }
             if (gitConfigs.values[file]['user.email']) {
                 result['user.email'] = gitConfigs.values[file]['user.email'];
             }
-        });
+        }
         if (!result['user.name'] || !result['user.email']) {
             return null;
         }

package/lib/util/init.js

@@ -1,7 +1,8 @@
 'use strict';
-
+const TYPE = require('../../types/mcdev.d');
 const Cli = require('./cli');
 const File = require('./file');
+const config = require('./config');
 const InitGit = require('./init.git');
 const InitNpm = require('./init.npm');
 const InitConfig = require('./init.config');
@@ -15,27 +16,27 @@ const Util = require('./util');
 const Init = {
     /**
      * Creates template file for properties.json
-     * @param {Object} properties config file's json
-     * @param {string} credentialsName identifying name of the installed package / project
-     * @param {Object} [skipInteraction] signals what to insert automatically for things usually asked via wizard
-     * @param {String} skipInteraction.clientId client id of installed package
-     * @param {String} skipInteraction.clientSecret client id of installed package
-     * @param {String} skipInteraction.tenant client id of installed package
-     * @param {String} skipInteraction.credentialsName how you would like the credential to be named
-     * @param {String} skipInteraction.gitRemoteUrl URL of Git remote server
-     * @returns {Promise<void>} -
+     *
+     * @param {TYPE.Mcdevrc} properties config file's json
+     * @param {string} credentialName identifying name of the installed package / project
+     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     * @returns {Promise.<void>} -
      */
-    async initProject(properties, credentialsName, skipInteraction) {
+    async initProject(properties, credentialName, skipInteraction) {
+        if (!properties) {
+            // try to get cached properties because we return null in case of a crucial error
+            properties = config.properties;
+        }
         const missingCredentials = this._getMissingCredentials(properties);
-        if (File.existsSync(Util.configFileName) && properties) {
+        if ((await File.pathExists(Util.configFileName)) && properties) {
             // config exists
-            if (credentialsName) {
-                Util.logger.info(`Updating credential '${credentialsName}'`);
+            if (credentialName) {
+                Util.logger.info(`Updating credential '${credentialName}'`);
                 // update-credential mode
-                if (!properties.credentials[credentialsName]) {
-                    Util.logger.error(`Could not find credential '${credentialsName}'`);
+                if (!properties.credentials[credentialName]) {
+                    Util.logger.error(`Could not find credential '${credentialName}'`);
                     const response = await Cli._selectBU(properties, null, true);
-                    credentialsName = response.credential;
+                    credentialName = response.credential;
                 }
                 let error;
                 do {
@@ -43,20 +44,20 @@ const Init = {
                     try {
                         const success = await Cli.updateCredential(
                             properties,
-                            credentialsName,
+                            credentialName,
                             skipInteraction
                         );
                         if (success) {
-                            Util.logger.info(`✔️  Credential '${credentialsName}' updated.`);
+                            Util.logger.info(`✔️  Credential '${credentialName}' updated.`);
                         } else {
                             error = true;
                         }
-                    } catch (ex) {
+                    } catch {
                         error = true;
                     }
                 } while (error && !skipInteraction);
                 Util.logger.debug('reloading config');
-                properties = File.loadConfigFile(true);
+                properties = await config.getProperties(true);
             } else if (missingCredentials.length) {
                 // forced update-credential mode - user likely cloned repo and is missing mcdev-auth.json
                 Util.logger.warn(
@@ -81,12 +82,12 @@ const Init = {
                             } else {
                                 error = true;
                             }
-                        } catch (ex) {
+                        } catch {
                             error = true;
                         }
                     } while (error);
                     Util.logger.debug('reloading config');
-                    properties = File.loadConfigFile(true);
+                    properties = await config.getProperties(true);
                 }
                 Util.logger.info('✔️  All credentials updated.');
                 // assume node dependencies are not installed
@@ -100,34 +101,30 @@ const Init = {
                 let responses;
                 if (skipInteraction) {
                     if (
-                        skipInteraction.clientId &&
-                        skipInteraction.clientSecret &&
-                        skipInteraction.tenant &&
-                        skipInteraction.credentialsName
+                        skipInteraction.client_id &&
+                        skipInteraction.client_secret &&
+                        skipInteraction.auth_url &&
+                        skipInteraction.account_id &&
+                        skipInteraction.credentialName
                     ) {
                         // assume automated input; only option here is to add a new credential
-                        // requires skipInteraction=={clientId,clientSecret,tenant,credentialsName}
+                        // requires skipInteraction=={client_id,client_secret,auth_url,account_id,credentialName}
                         // will be checked inside of Cli.addExtraCredential()
                         Util.logger.info('Adding another credential');
                     } else {
                         throw new Error(
-                            '--skipInteraction flag found but missing required input for clientId,clientSecret,tenant,credentialsName'
+                            '--skipInteraction flag found but missing required input for client_id,client_secret,auth_url,account_id,credentialName'
                         );
                     }
                 } else {
-                    const questions = [
+                    responses = await inquirer.prompt([
                         {
                             type: 'confirm',
                             name: 'isAddCredential',
                             message: 'Do you want to add another credential instead?',
                             default: false,
                         },
-                    ];
-                    responses = await new Promise((resolve) => {
-                        inquirer.prompt(questions).then((answers) => {
-                            resolve(answers);
-                        });
-                    });
+                    ]);
                 }
                 let credentialName;
                 if (skipInteraction || responses.isAddCredential) {
@@ -148,6 +145,7 @@ const Init = {
             }
 
             // set up IDE files and load npm dependencies
+
             let status = await this.upgradeProject(properties, true, initGit.repoName);
             if (!status) {
                 return;
@@ -182,27 +180,23 @@ const Init = {
     },
     /**
      * helper for this.initProject()
-     * @param {String} bu cred/bu or cred/* or *
-     * @param {String} gitStatus signals what state the git repo is in
-     * @param {Boolean|Object} [skipInteraction] signals what to insert automatically for things usually asked via wizard
-     * @returns {Promise<void>} -
+     *
+     * @param {string} bu cred/bu or cred/* or *
+     * @param {string} gitStatus signals what state the git repo is in
+     * @param {boolean | TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     * @returns {Promise.<void>} -
      */
     async _downloadAllBUs(bu, gitStatus, skipInteraction) {
         let responses;
         if (!skipInteraction) {
-            const questions = [
+            responses = await inquirer.prompt([
                 {
                     type: 'confirm',
                     name: 'initialRetrieveAll',
                     message: 'Do you want to start downloading all Business Units (recommended)?',
                     default: true,
                 },
-            ];
-            responses = await new Promise((resolve) => {
-                inquirer.prompt(questions).then((answers) => {
-                    resolve(answers);
-                });
-            });
+            ]);
         }
         if (skipInteraction || responses.initialRetrieveAll) {
             Util.execSync('mcdev', ['retrieve', bu]);
@@ -226,14 +220,15 @@ const Init = {
     },
     /**
      * wrapper around npm dependency & configuration file setup
-     * @param {Object} properties config file's json
-     * @param {Boolean} [initial] print message if not part of initial setup
-     * @param {String} [repoName] if git URL was provided earlier, the repo name was extracted to use it for npm init
-     * @returns {Promise<Boolean>} success flag
+     *
+     * @param {TYPE.Mcdevrc} properties config file's json
+     * @param {boolean} [initial] print message if not part of initial setup
+     * @param {string} [repoName] if git URL was provided earlier, the repo name was extracted to use it for npm init
+     * @returns {Promise.<boolean>} success flag
      */
     async upgradeProject(properties, initial, repoName) {
         let status;
-
+        const versionBeforeUpgrade = properties?.version || '0.0.0';
         if (!initial) {
             Util.logger.info(
                 'Upgrading project with newest configuration, npm dependencies & other project configurations:'
@@ -244,10 +239,15 @@ const Init = {
             if (!status) {
                 return false;
             }
+            // version 4 release to simplify auth
+            status = await InitConfig.upgradeAuthFile(properties);
+            if (!status) {
+                return false;
+            }
         }
 
         // create files before installing dependencies to ensure .gitignore is properly set up
-        status = await InitConfig.createIdeConfigFiles();
+        status = await InitConfig.createIdeConfigFiles(versionBeforeUpgrade);
         if (!status) {
             return false;
         }
@@ -262,17 +262,30 @@ const Init = {
     },
     /**
      * finds credentials that are set up in config but not in auth file
-     * @param {object} properties javascript object in .mcdevrc.json
-     * @returns {String[]} list of credential names
+     *
+     * @param {TYPE.Mcdevrc} properties javascript object in .mcdevrc.json
+     * @returns {string[]} list of credential names
      */
     _getMissingCredentials(properties) {
         let missingCredentials;
-        if (properties && properties.credentials) {
+        if (properties?.credentials) {
+            // reload auth file because for some reason we didnt want that in our main properties object
+            let auth;
+            try {
+                auth = File.readJsonSync(Util.authFileName);
+            } catch (ex) {
+                Util.logger.error(`${ex.code}: ${ex.message}`);
+                return;
+            }
+            // walk through config credentials and check if the matching credential in the auth file is missing something
             missingCredentials = Object.keys(properties.credentials).filter(
                 (cred) =>
-                    !properties.credentials[cred].clientId ||
-                    !properties.credentials[cred].clientSecret ||
-                    !properties.credentials[cred].tenant
+                    !auth[cred] ||
+                    !auth[cred].account_id ||
+                    properties.credentials[cred].eid != auth[cred].account_id ||
+                    !auth[cred].client_id ||
+                    !auth[cred].client_secret ||
+                    !auth[cred].auth_url
             );
         }
         return missingCredentials || [];

package/lib/util/init.npm.js

@@ -1,9 +1,9 @@
 'use strict';
 
 const File = require('./file');
-const inquirer = require('inquirer');
-const path = require('path');
+const path = require('node:path');
 const Util = require('./util');
+const semver = require('semver');
 
 /**
  * CLI helper class
@@ -14,15 +14,16 @@ const Init = {
      * initiates npm project and then
      * takes care of loading the pre-configured dependency list
      * from the boilerplate directory to them as dev-dependencies
-     * @param {String} [repoName] if git URL was provided earlier, the repo name was extracted to use it for npm init
-     * @returns {Promise<Boolean>} install successful or error occured
+     *
+     * @param {string} [repoName] if git URL was provided earlier, the repo name was extracted to use it for npm init
+     * @returns {Promise.<boolean>} install successful or error occured
      */
     async installDependencies(repoName) {
         let fileContent;
         let projectPackageJson;
-        if (File.existsSync('package.json')) {
+        if (await File.pathExists('package.json')) {
             try {
-                fileContent = File.readFileSync('package.json', 'utf8');
+                fileContent = await File.readFile('package.json', 'utf8');
             } catch (ex) {
                 Util.logger.error(
                     'Your package.json was found but seems to be corrupted: ' + ex.message
@@ -55,7 +56,7 @@ const Init = {
                     projectPackageJson = JSON.parse(fileContent);
                 }
                 Util.logger.info('✔️  package.json created');
-            } catch (ex) {
+            } catch {
                 Util.logger.error('No package.json found. Please run "npm init" manually');
                 return false;
             }
@@ -67,55 +68,64 @@ const Init = {
             Util.boilerplateDirectory,
             'npm-dependencies.json'
         );
-        if (!File.existsSync(dependencyFile)) {
+        if (!(await File.pathExists(dependencyFile))) {
             Util.logger.debug(`Dependency file not found in ${dependencyFile}`);
             return false;
         }
-        const defaultDependencies = File.readJsonSync(dependencyFile);
+        const defaultDependencies = await File.readJson(dependencyFile);
+        const versionsDefault = {};
+        for (const name of defaultDependencies) {
+            // check mcdev.devDependencies first
+            versionsDefault[name] = Object.keys(Util.packageJsonMcdev.dependencies).includes(name)
+                ? Util.packageJsonMcdev.dependencies[name]
+                : // then check mcdev.devDependencies
+                Object.keys(Util.packageJsonMcdev.devDependencies).includes(name)
+                ? Util.packageJsonMcdev.devDependencies[name]
+                : // fallback to using latest version if not found
+                  'latest';
+        }
 
+        const versionsProject = {};
+        if (projectPackageJson.devDependencies) {
+            for (const name of defaultDependencies) {
+                // check project.devDependencies
+                versionsProject[name] = Object.keys(projectPackageJson.devDependencies).includes(
+                    name
+                )
+                    ? projectPackageJson.devDependencies[name].replace(/^[\^~]/, '')
+                    : // fallback to invalid version if not found
+                      '0.0.0';
+            }
+        }
         const loadDependencies = defaultDependencies.filter(
             (name) =>
                 !projectPackageJson ||
                 !projectPackageJson.devDependencies ||
-                !projectPackageJson.devDependencies[name]
+                !projectPackageJson.devDependencies[name] ||
+                versionsDefault[name] == 'latest' ||
+                semver.gt(versionsDefault[name], versionsProject[name])
         );
-        if (loadDependencies.length < defaultDependencies.length) {
-            Util.logger.info(
-                `✔️  ${
-                    !loadDependencies.length ? 'All' : 'Some'
-                } default dependencies are already installed: ` + defaultDependencies.join(', ')
-            );
-            const questions = [
-                {
-                    type: 'confirm',
-                    name: 'runUpdate',
-                    message: 'Would you like to attempt updating them?',
-                    default: true,
-                },
-            ];
-            const responses = await new Promise((resolve) => {
-                inquirer.prompt(questions).then((answers) => {
-                    resolve(answers);
-                });
-            });
-            if (responses.runUpdate) {
-                loadDependencies.length = 0;
-                loadDependencies.push(...defaultDependencies);
-            }
-        }
         if (loadDependencies.length) {
-            Util.logger.info('Installing Dependencies:');
-            const args = ['install', '--save-dev'].concat(loadDependencies);
+            Util.logger.info('Installing/Updating Dependencies:');
+            const args = ['install', '--save-dev'].concat(
+                loadDependencies.map((name) => `${name}@${versionsDefault[name]}`)
+            );
 
             Util.execSync('npm', args);
             Util.logger.info('✔️  Dependencies installed.');
+        } else {
+            Util.logger.info(
+                `✔️  All default dependencies are already installed: ` +
+                    defaultDependencies.map((name) => `${name}@${versionsProject[name]}`).join(', ')
+            );
         }
         return true;
     },
     /**
      * ensure we have certain default values in our config
-     * @param {Object} [currentContent] what was read from existing package.json file
-     * @returns {Promise<{script: Object, author: String, license: String}>} extended currentContent
+     *
+     * @param {object} [currentContent] what was read from existing package.json file
+     * @returns {Promise.<{script: object, author: string, license: string}>} extended currentContent
      */
     async _getDefaultPackageJson(currentContent) {
         currentContent = currentContent || {};
@@ -124,7 +134,6 @@ const Init = {
             build: 'sfmc-build all',
             'build-cp': 'sfmc-build cloudPages',
             'build-email': 'sfmc-build emails',
-            upgrade: 'npm-check --update',
             'eslint-check': 'eslint',
         };
         if (!currentContent.scripts) {