Merge pull request #504 from Accenture/develop

4.1.5

Author: JoernBerkefeld

.github/ISSUE_TEMPLATE/bug.yml

@@ -39,6 +39,7 @@ body:
           label: Version
           description: What version of our software are you running? (mcdev --version)
           options:
+              - 4.1.5
               - 4.1.4
               - 4.1.3
               - 4.1.2

README.md

@@ -123,7 +123,7 @@ If you experience issues installing Accenture SFMC DevTools, please check out th
 1. Install Accenture SFMC DevTools by running `npm install -g mcdev` (prefix with `sudo` on MacOS)
    - If you get an error, please see the below troubleshooting section.
 
-When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.4`).
+When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.5`).
 
 > **_Side note for proud nerds_:**
 >
@@ -277,10 +277,10 @@ _Note: Regardless of which tag or branch you install_
 **Install specific version (using a version tag on npm):**
 
 ```bash
-npm install -g mcdev@4.1.4
+npm install -g mcdev@4.1.5
 ```
 
-**Warning**: When you used the above method to install Accenture SFMC DevTools for a specific version or tag, trying to [update Accenture SFMC DevTools](#updating-mcdev) might not download the most recently published official version but instead stay on the version or branch you previously selected (in the above examples: develop, 4.1.4)!
+**Warning**: When you used the above method to install Accenture SFMC DevTools for a specific version or tag, trying to [update Accenture SFMC DevTools](#updating-mcdev) might not download the most recently published official version but instead stay on the version or branch you previously selected (in the above examples: develop, 4.1.5)!
 
 > **Note**: The version is currently _not_ updated on the developer branch until a new release is published. Hence, you will not see a change if you run `mcdev --version`.
 
@@ -476,7 +476,7 @@ Example url: `https://mcg123abcysykllg-0321cbs8bbt64.auth.marketingcloudapis.com
 > You can run this command without the interactive wizard asking questions using the `--skipInteraction` (or short`--yes`/`--y`) flag. In this case, you need to provide a few values in the command:
 >
 > ```bash
-> mcdev init --y.credentialsName "yourCustomCredentialName" --y.client_id "yourClientIdHere" --y.client_secret "yourClientSecretHere" --y.auth_url "https://yourTenantSubdomainHere.auth.marketingcloudapis.com/" --y.gitRemoteUrl "https://my.git.server.com/myrepo.git" --y.account_id 00000000
+> mcdev init --y.credentialName "yourCustomCredentialName" --y.client_id "yourClientIdHere" --y.client_secret "yourClientSecretHere" --y.auth_url "https://yourTenantSubdomainHere.auth.marketingcloudapis.com/" --y.gitRemoteUrl "https://my.git.server.com/myrepo.git" --y.account_id 00000000 --y.backupBUs "yes" --y.gitPush "yes"
 > ```
 
 #### 6.1.2. upgrade
@@ -1493,7 +1493,7 @@ Assuming you cloned Accenture SFMC DevTools into `C:\repos\sfmc-devtools\` (or `
 
 This should tell npm to create a symlink to your cloned local directoty, allowing you to see updates you make in your mcdev repo instantly.
 
-To test your new **global** developer setup, run `mcdev --version` in CLI which should return the current version (e.g. `4.1.4`). Then, go into your mcdev repo and update the version with the suffix `-dev`, e.g. to `4.1.4-dev` and then run `mcdev --version` again to verify that your change propagates instantly.
+To test your new **global** developer setup, run `mcdev --version` in CLI which should return the current version (e.g. `4.1.5`). Then, go into your mcdev repo and update the version with the suffix `-dev`, e.g. to `4.1.5-dev` and then run `mcdev --version` again to verify that your change propagates instantly.
 
 > **Not recommended:** Alternatively, you can install it locally only by opening a terminal in your project directory and executing `npm install --save-dev "C:\repos\sfmc-devtools"`
 > To run the local version you need to prepend "npx" before your commands, e.g. `npx mcdev --version`
@@ -1531,7 +1531,7 @@ The following explains how you _could_ install it locally for certain edge cases
 4. Afterwards, install Accenture SFMC DevTools by running `npm install --save-dev mcdev`
    - If you get an error, please see the below troubleshooting section.
 
-When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.4`).
+When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.5`).
 
 ### 9.3. NPM Scripts
 

docs/dist/documentation.md

@@ -81,7 +81,7 @@ yargs
         handler: (argv) => {
             Mcdev.setSkipInteraction(argv.skipInteraction);
             Mcdev.setLoggingLevel(argv);
-            Mcdev.initProject(argv.credentialsName, argv.skipInteraction);
+            Mcdev.initProject(argv.credentialsName);
         },
     })
     .command({

lib/cli.js

@@ -50,12 +50,10 @@ class Mcdev {
     into deploy directory
      * @param {string} [argv.filter] filter file paths that start with any
      * @param {TYPE.DeltaPkgItem[]} [argv.diffArr] list of files to include in delta package (skips git diff when provided)
-     * @param {TYPE.skipInteraction} [argv.skipInteraction] allows to skip interactive wizard
      * @returns {Promise.<TYPE.DeltaPkgItem[]>} list of changed items
      */
     static async createDeltaPkg(argv) {
         Util.logger.info('Create Delta Package ::');
-        Mcdev.setSkipInteraction(argv.skipInteraction);
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
             return null;
@@ -65,12 +63,7 @@ class Mcdev {
             ? // get source market and source BU from config
               DevOps.getDeltaList(properties, argv.range, true, argv.filter)
             : // If no custom filter was provided, use deployment marketLists & templating
-              DevOps.buildDeltaDefinitions(
-                  properties,
-                  argv.range,
-                  argv.diffArr,
-                  argv.skipInteraction
-              );
+              DevOps.buildDeltaDefinitions(properties, argv.range, argv.diffArr);
     }
 
     /**
@@ -90,17 +83,15 @@ class Mcdev {
         Cli.explainTypes();
     }
     /**
-     * @param {boolean | TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {Promise.<boolean>} success flag
      */
-    static async upgrade(skipInteraction) {
-        Mcdev.setSkipInteraction(skipInteraction);
+    static async upgrade() {
         const properties = await config.getProperties();
         if (!properties) {
             Util.logger.error('No config found. Please run mcdev init');
             return false;
         }
-        if ((await InitGit.initGitRepo(skipInteraction)).status === 'error') {
+        if ((await InitGit.initGitRepo()).status === 'error') {
             return false;
         }
 
@@ -295,14 +286,12 @@ class Mcdev {
      * Creates template file for properties.json
      *
      * @param {string} [credentialsName] identifying name of the installed package / project
-     * @param {boolean | TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {Promise.<void>} -
      */
-    static async initProject(credentialsName, skipInteraction) {
+    static async initProject(credentialsName) {
         Util.logger.info('mcdev:: Setting up project');
-        Mcdev.setSkipInteraction(skipInteraction);
         const properties = await config.getProperties(!!credentialsName);
-        await Init.initProject(properties, credentialsName, skipInteraction);
+        await Init.initProject(properties, credentialsName);
     }
 
     /**

lib/index.js

@@ -18,26 +18,25 @@ const Cli = {
      * used when initially setting up a project.
      * loads default config and adds first credential
      *
-     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {Promise.<boolean>} success of init
      */
-    async initMcdevConfig(skipInteraction) {
+    async initMcdevConfig() {
         Util.logger.info('-- Initialising server connection --');
         Util.logger.info('Please enter a name for your "Installed Package" credentials:');
         const propertiesTemplate = await config.getDefaultProperties();
         delete propertiesTemplate.credentials.default;
 
         // wait for the interaction to finish or else an outer await will run before this is done
-        return this._setCredential(propertiesTemplate, null, skipInteraction);
+        return this._setCredential(propertiesTemplate, null);
     },
     /**
      * Extends template file for properties.json
      *
      * @param {TYPE.Mcdevrc} properties config file's json
-     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {Promise.<void>} -
      */
-    async addExtraCredential(properties, skipInteraction) {
+    async addExtraCredential(properties) {
+        const skipInteraction = Util.skipInteraction;
         if (!(await config.checkProperties(properties))) {
             // return null here to avoid seeing 2 error messages for the same issue
             return null;
@@ -54,7 +53,7 @@ const Cli = {
                     `Credential '${skipInteraction.credentialName}' already existing. If you tried updating please provide run 'mcdev init ${skipInteraction.credentialName}'`
                 );
             }
-            return this._setCredential(properties, null, skipInteraction);
+            return this._setCredential(properties, null);
         }
     },
     /**
@@ -63,15 +62,15 @@ const Cli = {
      *
      * @param {TYPE.Mcdevrc} properties config file's json
      * @param {string} credName name of credential that needs updating
-     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {Promise.<boolean>} success of update
      */
-    async updateCredential(properties, credName, skipInteraction) {
+    async updateCredential(properties, credName) {
+        const skipInteraction = Util.skipInteraction;
         if (credName) {
             if (!skipInteraction) {
                 Util.logger.info(`Please enter the details for '${credName}'`);
             }
-            return await this._setCredential(properties, credName, skipInteraction);
+            return await this._setCredential(properties, credName);
         }
     },
     /**
@@ -226,10 +225,10 @@ const Cli = {
      *
      * @param {TYPE.Mcdevrc} properties from config file
      * @param {string} [credName] name of credential that needs updating
-     * @param {TYPE.skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {Promise.<boolean | string>} success of refresh or credential name
      */
-    async _setCredential(properties, credName, skipInteraction) {
+    async _setCredential(properties, credName) {
+        const skipInteraction = Util.skipInteraction;
         // Get user input
         let credentialsGood = null;
         let inputData;

lib/util/cli.js

@@ -249,10 +249,10 @@ const DevOps = {
      * @param {TYPE.Mcdevrc} properties project config file
      * @param {string} range git commit range
      * @param {TYPE.DeltaPkgItem[]} [diffArr] instead of running git diff the method can also get a list of files to process
-     * @param {TYPE.SkipInteraction} [skipInteraction] allows to skip interactive wizard
      * @returns {Promise.<TYPE.DeltaPkgItem[]>} -
      */
-    async buildDeltaDefinitions(properties, range, diffArr, skipInteraction) {
+    async buildDeltaDefinitions(properties, range, diffArr) {
+        const skipInteraction = Util.skipInteraction;
         // check if sourceTargetMapping is valid
         if (
             !properties.options.deployment.sourceTargetMapping ||

lib/util/devops.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:`