mcdev 4.1.10 → 4.1.12

package/.github/ISSUE_TEMPLATE/bug.yml

@@ -39,6 +39,8 @@ body:
           label: Version
           description: What version of our software are you running? (mcdev --version)
           options:
+              - 4.1.12
+              - 4.1.11
               - 4.1.10
               - 4.1.9
               - 4.1.8

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 run `mcdev --version` and it will show you which version you installed (e.g. `4.1.10`).
+When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.12`).
 
 > **_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.10
+npm install -g mcdev@4.1.12
 ```
 
-**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.10)!
+**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.12)!
 
 > **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`.
 
@@ -1505,7 +1505,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 directory, 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.10`). Then, go into your mcdev repo and update the version with the suffix `-dev`, e.g. to `4.1.10-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.12`). Then, go into your mcdev repo and update the version with the suffix `-dev`, e.g. to `4.1.12-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`
@@ -1543,7 +1543,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.10`).
+When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.12`).
 
 ### 9.3. NPM Scripts
 

package/boilerplate/files/.vscode/settings.json

@@ -12,22 +12,23 @@
         "tsconfig.json": "tsconfig.*.json",
         "package.json": "package-lock.json, yarn.lock",
         "*-doc.md": "${capture}-meta.json",
+        "*-meta.amp": "${capture}-meta.json",
+        "*-meta.html": "${capture}-meta.json",
+        "*-meta.sql": "${capture}-meta.json",
+        "*-meta.ssjs": "${capture}-meta.json",
         "*.asset-asset-meta.html": "${dirname}.asset-asset-meta.json",
         "*.asset-message-meta.html": "${dirname}.asset-message-meta.json",
-        "*.html": "${capture}.asset-code-meta.json",
         "*.css": "${capture}.asset-code-meta.json",
         "*.docx": "${capture}.asset-document-meta.json",
+        "*.eps": "${capture}.asset-image-meta.json",
+        "*.gif": "${capture}.asset-image-meta.json",
+        "*.html": "${capture}.asset-code-meta.json",
         "*.ics": "${capture}.asset-document-meta.json",
-        "*.pdf": "${capture}.asset-document-meta.json",
-        "*.jpg": "${capture}.asset-image-meta.json",
         "*.jpeg": "${capture}.asset-image-meta.json",
+        "*.jpg": "${capture}.asset-image-meta.json",
+        "*.pdf": "${capture}.asset-document-meta.json",
         "*.png": "${capture}.asset-image-meta.json",
-        "*.gif": "${capture}.asset-image-meta.json",
-        "*.eps": "${capture}.asset-image-meta.json",
-        "*-meta.sql": "${capture}-meta.json",
-        "*-meta.ssjs": "${capture}-meta.json",
-        "*-meta.amp": "${capture}-meta.json",
-        "*-meta.html": "${capture}-meta.json"
+        "*.txt": "${capture}.asset-textfile-meta.json"
     },
     "editor.codeActionsOnSave": {
         "source.fixAll.eslint": true

package/boilerplate/forcedUpdates.json

@@ -1,4 +1,8 @@
 [
+    {
+        "version": "4.1.12",
+        "files": [".vscode/settings.json"]
+    },
     {
         "version": "4.1.1",
         "files": [".vscode/settings.json"]

package/docs/dist/documentation.md

@@ -4105,6 +4105,7 @@ Script MetadataType
     * [.buildTemplateForNested(templateDir, targetDir, metadata, templateVariables, templateName)](#Script.buildTemplateForNested) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
     * [._buildForNested(templateDir, targetDir, metadata, templateVariables, templateName, mode)](#Script._buildForNested) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
     * [.parseMetadata(metadata)](#Script.parseMetadata) ⇒ <code>TYPE.CodeExtractItem</code>
+    * [.prepExtractedCode(metadataScript, metadataName)](#Script.prepExtractedCode) ⇒ <code>Object</code>
     * [.getFilesToCommit(keyArr)](#Script.getFilesToCommit) ⇒ <code>Array.&lt;string&gt;</code>
 
 <a name="Script.retrieve"></a>
@@ -4276,6 +4277,19 @@ Splits the script metadata into two parts and parses in a standard manner
 | --- | --- | --- |
 | metadata | <code>TYPE.ScriptItem</code> | a single script activity definition |
 
+<a name="Script.prepExtractedCode"></a>
+
+### Script.prepExtractedCode(metadataScript, metadataName) ⇒ <code>Object</code>
+helper for [parseMetadata](parseMetadata) and [_buildForNested](_buildForNested)
+
+**Kind**: static method of [<code>Script</code>](#Script)  
+**Returns**: <code>Object</code> - returns found extension and file content  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| metadataScript | <code>string</code> | the code of the file |
+| metadataName | <code>string</code> | the name of the metadata |
+
 <a name="Script.getFilesToCommit"></a>
 
 ### Script.getFilesToCommit(keyArr) ⇒ <code>Array.&lt;string&gt;</code>

package/lib/Retriever.js

@@ -100,7 +100,8 @@ class Retriever {
                 } else {
                     let cacheResult = null;
                     if (
-                        Object.keys(typeKeyMap[metadataType])[0] !== null &&
+                        (typeKeyMap[metadataType].length > 1 ||
+                            typeKeyMap[metadataType][0] !== null) &&
                         (dependencies.includes(type) || dependencies.includes(metadataType))
                     ) {
                         // if we have a key-list and the type is a dependency, we need to cache the whole type

package/lib/metadataTypes/Script.js

@@ -214,6 +214,11 @@ class Script extends MetadataType {
     ) {
         // get SSJS from filesystem
         let code = await this._mergeCode(metadata, templateDir, templateName);
+        // try to remove script tags and decide on file extension (html/ssjs)
+        const file = Script.prepExtractedCode(code, metadata.name);
+        const fileExt = file.fileExt;
+        code = fileExt === 'ssjs' ? file.code.replace(/^\n/, '') : file.code;
+        // apply templating
         try {
             if (mode === 'definition') {
                 // replace template variables with their values
@@ -241,13 +246,13 @@ class Script extends MetadataType {
             File.writeToFile(
                 [targetDir, this.definition.type],
                 fileName + '.' + this.definition.type + '-meta',
-                'ssjs',
+                fileExt,
                 code
             );
             nestedFilePaths.push([
                 targetDir,
                 this.definition.type,
-                fileName + '.' + this.definition.type + '-meta.ssjs',
+                fileName + '.' + this.definition.type + '-meta.' + fileExt,
             ]);
         }
         return nestedFilePaths;
@@ -266,30 +271,42 @@ class Script extends MetadataType {
         // extract SSJS
         const codeArr = [];
         // keep between tags
+        const { fileExt, code } = Script.prepExtractedCode(metadata.script, metadata.name);
+        delete metadata.script;
+        codeArr.push({
+            subFolder: null,
+            fileName: metadata.key,
+            fileExt: fileExt,
+            content: code,
+        });
+
+        return { json: metadata, codeArr: codeArr, subFolder: null };
+    }
+    /**
+     * helper for {@link parseMetadata} and {@link _buildForNested}
+     *
+     * @param {string} metadataScript the code of the file
+     * @param {string} metadataName the name of the metadata
+     * @returns {{fileExt:string,code:string}} returns found extension and file content
+     */
+    static prepExtractedCode(metadataScript, metadataName) {
         const regex = /<\s*script .*?>(.+?)<\s*\/script>/gms;
-        let ssjs;
+        let code;
         let fileExt;
-        const regexMatches = regex.exec(metadata.script);
+        const regexMatches = regex.exec(metadataScript);
         if (regexMatches?.length > 1) {
-            ssjs = regexMatches[1];
+            code = regexMatches[1];
             fileExt = 'ssjs';
         } else {
-            ssjs = metadata.script;
+            code = metadataScript;
             fileExt = 'html';
             Util.logger.warn(
-                ` - Could not find script tags, saving code in ${metadata.name}.script-meta.html instead of as SSJS file.`
+                ` - Could not find script tags, saving code in ${metadataName}.script-meta.html instead of as SSJS file.`
             );
         }
-        delete metadata.script;
-        codeArr.push({
-            subFolder: null,
-            fileName: metadata.key,
-            fileExt: fileExt,
-            content: ssjs,
-        });
-
-        return { json: metadata, codeArr: codeArr, subFolder: null };
+        return { fileExt, code };
     }
+
     /**
      * should return only the json for all but asset, query and script that are saved as multiple files
      * additionally, the documentation for dataExtension and automation should be returned

package/lib/util/init.git.js

@@ -110,7 +110,7 @@ const Init = {
                         },
                     ]);
                 }
-                if (skipInteraction.gitPush === 'true' || responses?.gitPush) {
+                if (skipInteraction?.gitPush === 'true' || responses?.gitPush) {
                     Util.execSync('git', ['push', '-u', 'origin', 'master']);
                 }
             } else if (remoteBranchesExist === true) {

package/lib/util/init.js

@@ -202,7 +202,7 @@ const Init = {
                 },
             ]);
         }
-        if (skipInteraction.downloadBUs === 'true' || responses?.initialRetrieveAll) {
+        if (skipInteraction?.downloadBUs === 'true' || responses?.initialRetrieveAll) {
             Util.execSync('mcdev', ['retrieve', bu]);
 
             if (gitStatus === 'init') {

package/lib/util/util.js

@@ -130,6 +130,7 @@ const Util = {
      * @returns {void}
      */
     signalFatalError() {
+        Util.logger.debug('Util.signalFataError() sets process.exitCode = 1');
         process.exitCode = 1;
     },
     /**
@@ -497,7 +498,10 @@ function startLogger() {
          */
         errorStack: function (ex, message) {
             if (message) {
-                myWinston.error(message + ': ' + ex.message);
+                // ! this method only sets exitCode=1 if message-param was set
+                // if not, then this method purely outputs debug information and should not change the exitCode
+                winstonError(message + ': ' + ex.message);
+                Util.signalFatalError();
             }
             let stack;
             /* eslint-disable unicorn/prefer-ternary */
@@ -513,7 +517,6 @@ function startLogger() {
             }
             /* eslint-enable unicorn/prefer-ternary */
             myWinston.debug(stack);
-            Util.signalFatalError();
         },
         /**
          * errors should cause surrounding applications to take notice

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "4.1.10",
+    "version": "4.1.12",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -64,10 +64,10 @@
         "assert": "2.0.0",
         "axios-mock-adapter": "1.21.2",
         "chai": "4.3.6",
-        "eslint": "8.26.0",
+        "eslint": "8.27.0",
         "eslint-config-prettier": "8.5.0",
         "eslint-config-ssjs": "1.1.11",
-        "eslint-plugin-jsdoc": "39.4.0",
+        "eslint-plugin-jsdoc": "39.6.2",
         "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.10"
+    "version": "4.1.12"
 }