Merge pull request #1116 from Accenture/feature/1108-allow-importing-…

…certain-parts-of-mcdev-directly

Feature/1108 allow importing certain parts of mcdev directly

.github/ISSUE_TEMPLATE/bug.yml

@@ -39,6 +39,7 @@ body:
           label: Version
           description: What version of our software are you running? (mcdev --version)
           options:
+              - 6.0.0
               - 5.3.0
               - 5.2.0
               - 5.1.0

.prettierrc

@@ -10,6 +10,12 @@
                 "parser": "json"
             }
         },
+        {
+            "files": "package.json",
+            "options": {
+                "printWidth": 40
+            }
+        },
         {
             "files": "*.ssjs",
             "options": {

docs/dist/documentation.md

@@ -137,9 +137,6 @@ Provides default functionality that can be overwritten by child metadata type cl
 ## Constants
 
 <dl>
-<dt><a href="#MetadataTypeInfo">MetadataTypeInfo</a></dt>
-<dd><p>Provides access to all metadataType classes</p>
-</dd>
 <dt><a href="#BusinessUnit">BusinessUnit</a></dt>
 <dd><p>Helper that handles retrieval of BU info</p>
 </dd>
@@ -521,6 +518,7 @@ main class
 **Kind**: global class  
 
 * [Mcdev](#Mcdev)
+    * [.version()](#Mcdev.version) ⇒ <code>string</code>
     * [.setSkipInteraction([skipInteraction])](#Mcdev.setSkipInteraction) ⇒ <code>void</code>
     * [.setLoggingLevel(argv)](#Mcdev.setLoggingLevel) ⇒ <code>void</code>
     * [.setOptions(argv)](#Mcdev.setOptions) ⇒ <code>void</code>
@@ -547,6 +545,11 @@ main class
     * [.pause(businessUnit, [selectedType], [keys])](#Mcdev.pause) ⇒ <code>Promise.&lt;Object.&lt;string, Array.&lt;string&gt;&gt;&gt;</code>
     * [.fixKeys(businessUnit, selectedType, [keys])](#Mcdev.fixKeys) ⇒ <code>Promise.&lt;Object.&lt;string, Array.&lt;string&gt;&gt;&gt;</code>
 
+<a name="Mcdev.version"></a>
+
+### Mcdev.version() ⇒ <code>string</code>
+**Kind**: static method of [<code>Mcdev</code>](#Mcdev)  
+**Returns**: <code>string</code> - current version of mcdev  
 <a name="Mcdev.setSkipInteraction"></a>
 
 ### Mcdev.setSkipInteraction([skipInteraction]) ⇒ <code>void</code>
@@ -6284,12 +6287,6 @@ helper for [Retriever.retrieve](Retriever.retrieve) to get all dependencies of t
 | --- | --- | --- |
 | metadataTypes | <code>Array.&lt;TYPE.SupportedMetadataTypes&gt;</code> | list of metadata types to retrieve; can include subtypes! |
 
-<a name="MetadataTypeInfo"></a>
-
-## MetadataTypeInfo
-Provides access to all metadataType classes
-
-**Kind**: global constant  
 <a name="BusinessUnit"></a>
 
 ## BusinessUnit

lib/MetadataTypeDefinitions.js

@@ -37,7 +37,7 @@ import user from './metadataTypes/definitions/User.definition.js';
 import verification from './metadataTypes/definitions/Verification.definition.js';
 
 /**
- * Provides access to all metadataType classes
+ * Provides access to definitions of all metadataType classes
  */
 export default {
     asset,

lib/MetadataTypeInfo.js

@@ -39,7 +39,7 @@ import verification from './metadataTypes/Verification.js';
 /**
  * Provides access to all metadataType classes
  */
-const MetadataTypeInfo = {
+export default {
     asset,
     attributeGroup,
     attributeSet,
@@ -76,5 +76,3 @@ const MetadataTypeInfo = {
     user,
     verification,
 };
-
-export default MetadataTypeInfo;

lib/index.js

@@ -21,6 +21,13 @@ import cache from './util/cache.js';
  * main class
  */
 class Mcdev {
+    /**
+     * @returns {string} current version of mcdev
+     */
+    static version() {
+        console.log('mcdev v' + Util.packageJsonMcdev.version); // eslint-disable-line no-console
+        return Util.packageJsonMcdev.version;
+    }
     /**
      * helper method to use unattended mode when including mcdev as a package
      *

package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "5.3.0",
+    "version": "6.0.0",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -31,6 +31,12 @@
         "rest"
     ],
     "main": "./lib/index.js",
+    "exports": {
+        ".": {
+            "default": "./lib/index.js"
+        },
+        "./*": "./*.js"
+    },
     "bin": {
         "mcdev": "./lib/cli.js"
     },
@@ -104,7 +110,9 @@
         "fsevents": "*"
     },
     "lint-staged": {
-        "*.{js,jsx,ts,tsx}": ["eslint --fix"]
+        "*.{js,jsx,ts,tsx}": [
+            "eslint --fix"
+        ]
     },
     "type": "module"
 }

test/mockRoot/.mcdevrc.json

@@ -78,5 +78,5 @@
             "triggeredSend"
         ]
     },
-    "version": "5.3.0"
+    "version": "6.0.0"
 }