mcdev 4.1.3 → 4.1.5

package/lib/util/init.git.js

@@ -1,5 +1,5 @@
 'use strict';
-const TYPE = require('../../types/mcdev.d');
+// const TYPE = require('../../types/mcdev.d');
 const File = require('./file');
 const inquirer = require('inquirer');
 const Util = require('./util');
@@ -14,10 +14,9 @@ const Init = {
     /**
      * check if git repo exists and otherwise create one
      *
-     * @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) {
+    async initGitRepo() {
         const result = { status: null, repoName: null };
         // check if git is installed (https://www.npmjs.com/package/command-exists)
         if (!commandExists.sync('git')) {
@@ -65,10 +64,10 @@ const Init = {
         }
 
         // offer to update local user.name and user.email
-        await this._updateGitConfigUser(skipInteraction);
+        await this._updateGitConfigUser();
         if (newRepoInitialized) {
             // offer to insert git remote url now
-            result.repoName = await this._addGitRemote(skipInteraction);
+            result.repoName = await this._addGitRemote();
         }
 
         Util.logger.info('✔️  Git initialization done.');
@@ -78,10 +77,10 @@ const Init = {
     /**
      * offer to push the new repo straight to the server
      *
-     * @param {boolean | TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {void}
      */
-    async gitPush(skipInteraction) {
+    async gitPush() {
+        const skipInteraction = Util.skipInteraction;
         const gitRemotes = (await git.getRemotes(true)).filter((item) => item.name === 'origin');
         if (gitRemotes.length && gitRemotes[0].refs.push) {
             // check if remote repo is still empty (otherwise to risky to blindly push)
@@ -101,7 +100,7 @@ const Init = {
                     `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;
-                if (!skipInteraction) {
+                if (!skipInteraction || !skipInteraction.gitPush !== 'yes') {
                     responses = await inquirer.prompt([
                         {
                             type: 'confirm',
@@ -111,7 +110,7 @@ const Init = {
                         },
                     ]);
                 }
-                if (skipInteraction || responses.gitPush) {
+                if (skipInteraction.gitPush === 'yes' || responses.gitPush) {
                     Util.execSync('git', ['push', '-u', 'origin', 'master']);
                 }
             } else if (remoteBranchesExist === true) {
@@ -124,10 +123,10 @@ const Init = {
     /**
      * offers to add the git remote origin
      *
-     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {string} repo name (optionally)
      */
-    async _addGitRemote(skipInteraction) {
+    async _addGitRemote() {
+        const skipInteraction = Util.skipInteraction;
         // #1 ask if the user wants to do it now
         let responses;
         if (!skipInteraction) {
@@ -177,10 +176,10 @@ const Init = {
     /**
      * checks global config and ask to config the user info and then store it locally
      *
-     * @param {boolean | TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {void}
      */
-    async _updateGitConfigUser(skipInteraction) {
+    async _updateGitConfigUser() {
+        const skipInteraction = Util.skipInteraction;
         const gitUser = (await this._getGitConfigUser()) || {};
         Util.logger.info(
             `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:`

package/lib/util/init.js

@@ -19,10 +19,10 @@ const Init = {
      *
      * @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, credentialName, skipInteraction) {
+    async initProject(properties, credentialName) {
+        const skipInteraction = Util.skipInteraction;
         if (!properties) {
             // try to get cached properties because we return null in case of a crucial error
             properties = config.properties;
@@ -42,11 +42,7 @@ const Init = {
                 do {
                     error = false;
                     try {
-                        const success = await Cli.updateCredential(
-                            properties,
-                            credentialName,
-                            skipInteraction
-                        );
+                        const success = await Cli.updateCredential(properties, credentialName);
                         if (success) {
                             Util.logger.info(`✔️  Credential '${credentialName}' updated.`);
                         } else {
@@ -72,11 +68,7 @@ const Init = {
                     do {
                         error = false;
                         try {
-                            const success = await Cli.updateCredential(
-                                properties,
-                                badCredName,
-                                skipInteraction
-                            );
+                            const success = await Cli.updateCredential(properties, badCredName);
                             if (success) {
                                 Util.logger.info(`✔️  Credential '${badCredName}' updated.`);
                             } else {
@@ -128,10 +120,10 @@ const Init = {
                 }
                 let credentialName;
                 if (skipInteraction || responses.isAddCredential) {
-                    credentialName = await Cli.addExtraCredential(properties, skipInteraction);
+                    credentialName = await Cli.addExtraCredential(properties);
                 }
                 if (credentialName) {
-                    await this._downloadAllBUs(`${credentialName}/*`, 'update', skipInteraction);
+                    await this._downloadAllBUs(`${credentialName}/*`, 'update');
                 }
             }
         } else {
@@ -139,7 +131,7 @@ const Init = {
             // assuming it's the first time this command is run for this project
 
             // initialize git repo
-            const initGit = await InitGit.initGitRepo(skipInteraction);
+            const initGit = await InitGit.initGitRepo();
             if (initGit.status === 'error') {
                 return;
             }
@@ -152,7 +144,7 @@ const Init = {
             }
 
             // ask for credentials and create mcdev config
-            status = await Cli.initMcdevConfig(skipInteraction);
+            status = await Cli.initMcdevConfig();
             if (!status) {
                 return;
             }
@@ -169,7 +161,7 @@ const Init = {
             await this._downloadAllBUs('"*"', initGit.status);
 
             // backup to server
-            await InitGit.gitPush(skipInteraction);
+            await InitGit.gitPush();
 
             // all done
             Util.logger.info('You are now ready to work with Accenture SFMC DevTools!');
@@ -183,12 +175,12 @@ const Init = {
      *
      * @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) {
+    async _downloadAllBUs(bu, gitStatus) {
+        const skipInteraction = Util.skipInteraction;
         let responses;
-        if (!skipInteraction) {
+        if (!skipInteraction || skipInteraction.backupBUs !== 'yes') {
             responses = await inquirer.prompt([
                 {
                     type: 'confirm',
@@ -198,7 +190,7 @@ const Init = {
                 },
             ]);
         }
-        if (skipInteraction || responses.initialRetrieveAll) {
+        if (skipInteraction.backupBUs === 'yes' || responses.initialRetrieveAll) {
             Util.execSync('mcdev', ['retrieve', bu]);
 
             if (gitStatus === 'init') {

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "mcdev",
-    "version": "4.1.3",
+    "version": "4.1.5",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
-    "author": "joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
+    "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
     "repository": {
         "type": "git",
@@ -67,7 +67,7 @@
         "eslint": "8.26.0",
         "eslint-config-prettier": "8.5.0",
         "eslint-config-ssjs": "1.1.11",
-        "eslint-plugin-jsdoc": "39.3.25",
+        "eslint-plugin-jsdoc": "39.4.0",
         "eslint-plugin-mocha": "10.1.0",
         "eslint-plugin-prettier": "4.2.1",
         "eslint-plugin-unicorn": "44.0.2",

package/test/mockRoot/.mcdevrc.json

@@ -63,5 +63,5 @@
             "triggeredSendDefinition"
         ]
     },
-    "version": "4.1.3"
+    "version": "4.1.5"
 }