mcdev 4.0.1 → 4.0.2

package/.github/ISSUE_TEMPLATE/bug.yml

@@ -1,76 +1,78 @@
 name: 🐞 Bug
 description: File a bug/issue
-title: "[BUG] <title>"
+title: '[BUG] <title>'
 labels: [bug, NEW]
 body:
-- type: checkboxes
-  attributes:
-    label: Is there an existing issue for this?
-    description: Please [search here](https://github.com/Accenture/sfmc-devtools/issues) to see if an issue already exists for your problem.
-    options:
-    - label: I have searched the existing issues
-      required: true
-- type: textarea
-  attributes:
-    label: Current Behavior
-    description: A clear & concise description of what you're experiencing.
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Expected Behavior
-    description: A clear & concise description of what you expected to happen.
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Steps To Reproduce
-    description: Steps to reproduce the behavior.
-    value: |
-      1. Go to '...'
-      2. Click on '....'
-      3. Run '...'
-      4. See error...
-  validations:
-    required: false
-- type: dropdown
-  id: version
-  attributes:
-    label: Version
-    description: What version of our software are you running? (mcdev --version)
-    options:
-      - 4.0.0
-      - 3.1.3
-      - 3.1.2
-      - 3.1.1
-      - 3.1.0
-      - 3.0.3
-      - 3.0.2
-      - 3.0.1
-      - develop-branch
-  validations:
-    required: true
-- type: textarea
-  attributes:
-    label: Environment
-    description: |
-      examples:
-        - **Operating system (Windows/Mac/Linux/...)**: Windows 10
-        - **Node (node --version)**: 13.14.0
-        - **npm (npm --version)**: 7.6.3
-    value: |
-        - OS:
-        - Node:
-        - npm:
-  validations:
-    required: false
-- type: checkboxes
-  attributes:
-    label: Participation
-    options:
-      - label: I am willing to submit a pull request for this issue.
-        required: false
-- type: textarea
-  attributes:
-    label: Additional comments
-    description: Is there anything else that's important for the team to know?
+    - type: checkboxes
+      attributes:
+          label: Is there an existing issue for this?
+          description: Please [search here](https://github.com/Accenture/sfmc-devtools/issues) to see if an issue already exists for your problem.
+          options:
+              - label: I have searched the existing issues
+                required: true
+    - type: textarea
+      attributes:
+          label: Current Behavior
+          description: A clear & concise description of what you're experiencing.
+      validations:
+          required: false
+    - type: textarea
+      attributes:
+          label: Expected Behavior
+          description: A clear & concise description of what you expected to happen.
+      validations:
+          required: false
+    - type: textarea
+      attributes:
+          label: Steps To Reproduce
+          description: Steps to reproduce the behavior.
+          value: |
+              1. Go to '...'
+              2. Click on '....'
+              3. Run '...'
+              4. See error...
+      validations:
+          required: false
+    - type: dropdown
+      id: version
+      attributes:
+          label: Version
+          description: What version of our software are you running? (mcdev --version)
+          options:
+              - 4.0.2
+              - 4.0.1
+              - 4.0.0
+              - 3.1.3
+              - 3.1.2
+              - 3.1.1
+              - 3.1.0
+              - 3.0.3
+              - 3.0.2
+              - 3.0.1
+              - develop-branch
+      validations:
+          required: true
+    - type: textarea
+      attributes:
+          label: Environment
+          description: |
+              examples:
+                - **Operating system (Windows/Mac/Linux/...)**: Windows 10
+                - **Node (node --version)**: 13.14.0
+                - **npm (npm --version)**: 7.6.3
+          value: |
+              - OS:
+              - Node:
+              - npm:
+      validations:
+          required: false
+    - type: checkboxes
+      attributes:
+          label: Participation
+          options:
+              - label: I am willing to submit a pull request for this issue.
+                required: false
+    - type: textarea
+      attributes:
+          label: Additional comments
+          description: Is there anything else that's important for the team to know?

package/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 you will see `+ mcdev@3.2.0` printed to your screen (or the current version of it respectively).
+When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.0.2`).
 
 > **_Side note for proud nerds_:**
 >
@@ -272,13 +272,15 @@ To work with our **developer-version** or to install a **specific older version*
 npm install -g accenture/sfmc-devtools#develop
 ```
 
+_Note: Regardless of which tag or branch you install_
+
 **Install specific version (using a version tag on npm):**
 
 ```bash
-npm install -g mcdev@3.2.0
+npm install -g mcdev@4.0.2
 ```
 
-**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, 3.2.0)!
+**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.0.2)!
 
 > **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`.
 
@@ -1509,7 +1511,7 @@ If you use Accenture SFMC DevTools in your team it is recommended to install you
 
 If you do need to install it locally, make sure you don't commit your project's package.json with this change or you might break mcdev for other developers in your team that either didn't clone the Accenture SFMC DevTools repo or stored in a different directory.
 
-To test your new **global** developer setup, run `mcdev --version` in CLI which should return the current version (e.g. `3.2.0`). Then, go into your mcdev repo and update the version with the suffix `-dev`, e.g. to `3.2.0-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.0.2`). Then, go into your mcdev repo and update the version with the suffix `-dev`, e.g. to `4.0.2-dev` and then run `mcdev --version` again to verify that your change propagates instantly.
 
 <a name="local-install"></a>
 
@@ -1536,7 +1538,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 you will see `+ mcdev@3.2.0` printed to your screen (or the current version of it respectively).
+When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.0.2`).
 
 ### 9.3. NPM Scripts
 

package/docs/dist/documentation.md

@@ -4448,7 +4448,7 @@ CLI entry for SFMC DevTools
     * [.inverseGet(objs, val)](#Util.inverseGet) ⇒ <code>string</code>
     * [.getMetadataHierachy(metadataTypes)](#Util.getMetadataHierachy) ⇒ <code>Array.&lt;string&gt;</code>
     * [.resolveObjPath(path, obj)](#Util.resolveObjPath) ⇒ <code>any</code>
-    * [.execSync(cmd, [args])](#Util.execSync) ⇒ <code>undefined</code>
+    * [.execSync(cmd, [args], [hideOutput])](#Util.execSync) ⇒ <code>undefined</code>
     * [.templateSearchResult(results, keyToSearch, searchValue)](#Util.templateSearchResult) ⇒ <code>TYPE.MetadataTypeItem</code>
     * [.setLoggingLevel(argv)](#Util.setLoggingLevel) ⇒ <code>void</code>
 
@@ -4645,7 +4645,7 @@ let's you dynamically walk down an object and get a value
 
 <a name="Util.execSync"></a>
 
-### Util.execSync(cmd, [args]) ⇒ <code>undefined</code>
+### Util.execSync(cmd, [args], [hideOutput]) ⇒ <code>undefined</code>
 helper to run other commands as if run manually by user
 
 **Kind**: static method of [<code>Util</code>](#Util)  
@@ -4654,6 +4654,7 @@ helper to run other commands as if run manually by user
 | --- | --- | --- |
 | cmd | <code>string</code> | to be executed command |
 | [args] | <code>Array.&lt;string&gt;</code> | list of arguments |
+| [hideOutput] | <code>boolean</code> | if true, output of command will be hidden from CLI |
 
 <a name="Util.templateSearchResult"></a>
 
@@ -6206,7 +6207,7 @@ Util that contains logger and simple util methods
     * [.inverseGet(objs, val)](#Util.inverseGet) ⇒ <code>string</code>
     * [.getMetadataHierachy(metadataTypes)](#Util.getMetadataHierachy) ⇒ <code>Array.&lt;string&gt;</code>
     * [.resolveObjPath(path, obj)](#Util.resolveObjPath) ⇒ <code>any</code>
-    * [.execSync(cmd, [args])](#Util.execSync) ⇒ <code>undefined</code>
+    * [.execSync(cmd, [args], [hideOutput])](#Util.execSync) ⇒ <code>undefined</code>
     * [.templateSearchResult(results, keyToSearch, searchValue)](#Util.templateSearchResult) ⇒ <code>TYPE.MetadataTypeItem</code>
     * [.setLoggingLevel(argv)](#Util.setLoggingLevel) ⇒ <code>void</code>
 
@@ -6403,7 +6404,7 @@ let's you dynamically walk down an object and get a value
 
 <a name="Util.execSync"></a>
 
-### Util.execSync(cmd, [args]) ⇒ <code>undefined</code>
+### Util.execSync(cmd, [args], [hideOutput]) ⇒ <code>undefined</code>
 helper to run other commands as if run manually by user
 
 **Kind**: static method of [<code>Util</code>](#Util)  
@@ -6412,6 +6413,7 @@ helper to run other commands as if run manually by user
 | --- | --- | --- |
 | cmd | <code>string</code> | to be executed command |
 | [args] | <code>Array.&lt;string&gt;</code> | list of arguments |
+| [hideOutput] | <code>boolean</code> | if true, output of command will be hidden from CLI |
 
 <a name="Util.templateSearchResult"></a>
 

package/lib/metadataTypes/Automation.js

@@ -792,9 +792,8 @@ class Automation extends MetadataType {
                 output += `* Recurrance: every ${ical.INTERVAL > 1 ? ical.INTERVAL : ''} ${
                     frequency === 'dai' ? 'day' : frequency
                 }${ical.INTERVAL > 1 ? 's' : ''} ${ical.COUNT ? `for ${ical.COUNT} times` : ''}\n`;
-                output += '\n';
             } else if (json.schedule) {
-                output += `**Schedule:** Not defined\n\n`;
+                output += `**Schedule:** Not defined\n`;
             }
         } else if (json.type === 'triggered' && json.fileTrigger) {
             output += `**File Trigger:**\n\n`;
@@ -803,12 +802,19 @@ class Automation extends MetadataType {
             output += `* Pattern: ${json.fileTrigger.fileNamingPattern}\n`;
             output += `* Folder:  ${json.fileTrigger.folderLocationText}\n`;
         }
+        // show table with automation steps
         if (tabled && tabled.length) {
+            // add empty line to ensure the following table is rendered properly
+            output += '\n';
             let tableSeparator = '';
             const row1 = [];
             for (const column of tabled[0]) {
                 row1.push(
-                    `| ${column.title}${column.description ? `<br>_${column.description}_` : ''} `
+                    `| ${column.title}${
+                        column.description
+                            ? `<br>_<small>${column.description.replace(/\n/g, '<br>')}</small>_`
+                            : ''
+                    } `
                 );
                 tableSeparator += '| --- ';
             }

package/lib/util/init.js

@@ -161,7 +161,7 @@ const Init = {
             if (initGit.status === 'init') {
                 Util.logger.info(`Committing initial setup to Git:`);
                 Util.execSync('git', ['add', '.']);
-                Util.execSync('git', ['commit', '-m', '"Initial commit"', '--quiet']);
+                Util.execSync('git', ['commit', '-n', '-m', '"Initial commit"', '--quiet']);
                 Util.logger.info(`✔️  Configuration committed`);
             }
 
@@ -204,7 +204,7 @@ const Init = {
             if (gitStatus === 'init') {
                 Util.logger.info(`Committing first backup of your SFMC instance:`);
                 Util.execSync('git', ['add', '.']);
-                Util.execSync('git', ['commit', '-m', '"First instance backup"', '--quiet']);
+                Util.execSync('git', ['commit', '-n', '-m', '"First instance backup"', '--quiet']);
                 Util.logger.info(`✔️  SFMC instance backed up`);
             } else if (gitStatus === 'update') {
                 Util.logger.warn(

package/lib/util/init.npm.js

@@ -49,7 +49,7 @@ const Init = {
             this._getDefaultPackageJson(projectPackageJson);
             await File.writeToFile('./', 'package', 'json', JSON.stringify(projectPackageJson));
             // execute "no questions asked" npm init
-            Util.execSync('npm', ['init', '--yes']);
+            Util.execSync('npm', ['init', '--yes'], true);
             try {
                 fileContent = File.readFileSync('package.json', 'utf8');
                 if (fileContent) {

package/lib/util/util.js

@@ -353,15 +353,16 @@ const Util = {
      *
      * @param {string} cmd to be executed command
      * @param {string[]} [args] list of arguments
+     * @param {boolean} [hideOutput] if true, output of command will be hidden from CLI
      * @returns {undefined}
      */
-    execSync(cmd, args) {
+    execSync(cmd, args, hideOutput) {
         args = args || [];
         Util.logger.info('⚡ ' + cmd + ' ' + args.join(' '));
 
         // the following options ensure the user sees the same output and
         // interaction options as if the command was manually run
-        const options = { stdio: [0, 1, 2] };
+        const options = hideOutput ? {} : { stdio: [0, 1, 2] };
         return child_process.execSync(cmd + ' ' + args.join(' '), options);
     },
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "4.0.1",
+    "version": "4.0.2",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",