mcdev 3.0.1 → 3.1.1

package/.eslintrc.json

@@ -11,7 +11,7 @@
         "SharedArrayBuffer": "readonly"
     },
     "parserOptions": {
-        "ecmaVersion": 2018,
+        "ecmaVersion": 2020,
         "sourceType": "module"
     },
     "rules": {

package/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,72 @@
+name: 🐞 Bug
+description: File a bug/issue
+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:
+      - 3.1.0 (Default)
+      - 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/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE] "
+labels: NEW, enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/ISSUE_TEMPLATE/task.md

@@ -0,0 +1,10 @@
+---
+name: Task
+about: Technical improvements without functional impact / changes to the Documentation
+title: "[TASK] "
+labels: NEW, chores
+assignees: ''
+
+---
+
+

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -2,6 +2,8 @@
 
 ## What is the purpose of this pull request? (put an "X" next to an item)
 
+_Please delete options that are not relevant._
+
 - [ ] Documentation update
 - [ ] Bug fix
 - [ ] New metadata support
@@ -17,3 +19,12 @@
 ## Is there anything you'd like reviewers to focus on?
 
 ...
+
+## Checklist
+
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] ESLint & Prettier are not outputting errors or warnings
+- [ ] README.md updated (if applicable)
+- [ ] CHANGELOG.md updated
+- [ ] ran `npm run docs` to update developer docs

package/.issuetracker

@@ -2,6 +2,14 @@
 #
 # (note that '\' need to be escaped).
 
-[issuetracker "Jira Rule"]
-  regex = "CSCLSROZ-(\\d+)"
-  url = "https://alm.accenture.com/jira/browse/CSCLSROZ-$1"
+[issuetracker "Accenture Jira Rule"]
+  regex = "(CSCLSROZ)-(\\d+)"
+  url = "https://alm.accenture.com/jira/browse/$1-$2"
+
+[issuetracker "GitHub Pull Request Rule"]
+  regex = "pull request #(\\d+)"
+  url = "https://github.com/Accenture/sfmc-devtools/pull/$1"
+
+[issuetracker "GitHub Issue Rule"]
+  regex = "#(\\d+)"
+  url = "https://github.com/Accenture/sfmc-devtools/issues/$1"

package/.vscode/settings.json

@@ -12,9 +12,10 @@
     "javascript.validate.enable": false,
     "markdown.extension.italic.indicator": "_",
     "markdown.extension.list.indentationSize": "adaptive",
-    "markdown.extension.tableFormatter.enabled": false,
     "markdown.extension.toc.levels": "2..6",
     "markdown.extension.toc.orderedList": false,
+    "markdown.extension.toc.slugifyMode": "github",
+    "markdown.extension.tableFormatter.enabled": false,
     "sql-formatter.indent": "    ",
     "sql-formatter.uppercase": true,
     "[html]": {
@@ -30,14 +31,13 @@
         "editor.defaultFormatter": "esbenp.prettier-vscode"
     },
     "[markdown]": {
-        "editor.defaultFormatter": "esbenp.prettier-vscode"
+        "editor.defaultFormatter": "yzhang.markdown-all-in-one"
     },
     "[typescript]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode"
     },
     "markdown-toc.orderedList": true,
     "markdown-toc.insertAnchor": true,
-    "markdown-toc.anchorMode": "gitlab.com",
     "outline.showProperties": false,
     "outline.showVariables": false,
     "breadcrumbs.showVariables": false,

package/CHANGELOG.md

@@ -4,7 +4,109 @@ Accenture SFMC DevTools follows [semantic versioning](https://semver.org/).
 
 ---
 
-## 3.0.1 - 2021-04-11
+## [3.1.1](https://github.com/Accenture/sfmc-devtools/compare/v3.1.0...v3.1.1) - 2022-01-10
+
+**Bugfixes:**
+
+- [#160](https://github.com/Accenture/sfmc-devtools/issues/160) mcdev outputs bogus text since dependency colorjs got corrupted ( [background story](https://www.theverge.com/2022/1/9/22874949/developer-corrupts-open-source-libraries-projects-affected))
+
+**Chores:**
+
+- bumped cli-progress to 3.10.0 (removes colors dependency)
+- bumped winston to 3.3.4 (removes colors dependency)
+
+---
+
+## [3.1.0](https://github.com/Accenture/sfmc-devtools/compare/v3.0.3...v3.1.0) - 2021-12-27
+
+**Features:**
+
+- [#55](https://github.com/Accenture/sfmc-devtools/issues/55) added user / roles documentation
+- [#64](https://github.com/Accenture/sfmc-devtools/issues/64) Added `accountUser` (system users) support (retrieve)
+- [#103](https://github.com/Accenture/sfmc-devtools/issues/103) Add rename `dataExtensionField` option (via Name_new)
+- [#130](https://github.com/Accenture/sfmc-devtools/issues/130) offer `retrieveChangelog` option to other node packages including mcdev (see [retrieveChangelog.js](/lib/retrieveChangelog.js) for a how-to)
+- [#133](https://github.com/Accenture/sfmc-devtools/issues/133) `dataExtensionField` validation during DE update (see [README](README.md#722-addingupdating-fields-on-existing-data-extensions) for details)
+- [#136](https://github.com/Accenture/sfmc-devtools/issues/136) enable including mcdev in other node packages (see [README](README.md#26-using-mcdev-in-other-node-packages) for a how-to)
+- [#144](https://github.com/Accenture/sfmc-devtools/issues/144) added file type .ai to `asset` - thanks to @fbellgr
+
+**Bugfixes:**
+
+- [#112](https://github.com/Accenture/sfmc-devtools/issues/112) add (unknown) new type 783 to defintion of `importFile`
+- [#117](https://github.com/Accenture/sfmc-devtools/issues/117) `queries` not deployable when target is `shared DE`
+- [#118](https://github.com/Accenture/sfmc-devtools/issues/118) `automation` start not auto-retried during deploy
+- [#119](https://github.com/Accenture/sfmc-devtools/issues/119) fixed `list` dependency for importFile
+- [#122](https://github.com/Accenture/sfmc-devtools/issues/122) ECONNRESET on caching metadata during deploy
+- [#128](https://github.com/Accenture/sfmc-devtools/issues/128) `dataExtension` json not equal for retrieve/deploy
+- [#129](https://github.com/Accenture/sfmc-devtools/issues/129) `script` json not equal for retrieve/deploy
+- [#140](https://github.com/Accenture/sfmc-devtools/issues/140) avoid issues when retrieving `dataExtensions` that do not have a folder ID (edge case) - thanks to @fbellgr
+- [#144](https://github.com/Accenture/sfmc-devtools/issues/144) improved handling high volumes of `asset` - thanks to @fbellgr
+- [#149](https://github.com/Accenture/sfmc-devtools/issues/149) handle errors on upsert of data extensions gracefully
+
+**Chores:**
+
+- [#5](https://github.com/Accenture/sfmc-devtools/issues/5) removed postinstall msg after npm 7 dropped support for that
+- [#127](https://github.com/Accenture/sfmc-devtools/issues/127) bad message "info: updated automation: undefined"
+- [#132](https://github.com/Accenture/sfmc-devtools/issues/132) `dataExtension.SendableSubscriberField.Name` now has a slightly more readable value
+- [#137](https://github.com/Accenture/sfmc-devtools/issues/137) docs for installing a specific version were incorrect
+- [#138](https://github.com/Accenture/sfmc-devtools/issues/138) make issues and pull requests clickable in gitfork
+- change `mcdev document` to take the cred/BU first and then the type to align it with other commands
+- improved error handling of `document role` command
+- bumped cli-progress to 3.9.1
+- bumped eslint to 8.4.1
+- bumped eslint-plugin-mocha to 10.0.1
+- bumped eslint-plugin-prettier to 4.0.0
+- bumped fs-extra to 10.0.0
+- bumped husky to 7.0.4
+- bumped inquirer to 8.2.0
+- bumped jsdoc-to-markdown to 7.1.0
+- bumped lint-staged to 12.1.2
+- bumped mocha to 9.1.3
+- bumped mustache to 4.2.0
+- bumped prettier to 2.5.1
+- bumped semver to 7.3.5
+- bumped simple-git to 2.48.0
+- bumped yargs to 17.3.0
+- [#146](https://github.com/Accenture/sfmc-devtools/issues/146) remove AccountUser retrieve as a default retrieve option
+
+---
+
+## [3.0.3](https://github.com/Accenture/sfmc-devtools/compare/v3.0.2...v3.0.3) - 2021-08-11
+
+**Bugfixes:**
+
+- [#100](https://github.com/Accenture/sfmc-devtools/issues/100) Handle ECONNRESET errors across various types (incl. Data Extensions)
+- [#102](https://github.com/Accenture/sfmc-devtools/issues/102) block deployment attempt for synchronized Data Extensions with proper error message
+- [#104](https://github.com/Accenture/sfmc-devtools/issues/104) block deployment of shared data extensions on child BUs (existing solution broke somewhere down the line)
+
+**Chores:**
+
+- [#107](https://github.com/Accenture/sfmc-devtools/issues/107) rewrite folder to use generic update/create to help with ECONNRESET issue
+- [#108](https://github.com/Accenture/sfmc-devtools/issues/108) return full API error messages for create & update via SOAP
+- [#110](https://github.com/Accenture/sfmc-devtools/issues/110) improve error message for missing dependencies
+- bumped jsdoc-to-markdown to 7.0.1
+- bumped eslint-plugin-mocha to 9.0.0
+- bumped eslint-plugin-prettier to 3.4.0
+- bumped eslint-config-prettier to 8.3.0
+- bumped eslint to 7.32.0
+- enhanced Pull Request Template with note on `npm run docs`
+
+---
+
+## [3.0.2](https://github.com/Accenture/sfmc-devtools/compare/v3.0.1...v3.0.2) - 2021-08-03
+
+**Bugfixes:**
+
+- [#26](https://github.com/Accenture/sfmc-devtools/issues/26) retrieving asset subtypes via r ... asset-xyz actually saves result to disk
+- [#45](https://github.com/Accenture/sfmc-devtools/issues/45) connection errors for automations fixed
+- [#46](https://github.com/Accenture/sfmc-devtools/issues/46) (temp fix) campaigns break entire retrieve - disabled for now
+- [#48](https://github.com/Accenture/sfmc-devtools/issues/48) connection errors for dataExtensions and other types are now handled gracefully
+- [#49](https://github.com/Accenture/sfmc-devtools/issues/49) connection errors for asset subtypes no longer restart downloading all subtypes
+- [#51](https://github.com/Accenture/sfmc-devtools/issues/51) retrieving asset subtypes now always uses the default list of subtypes
+- [#52](https://github.com/Accenture/sfmc-devtools/issues/52) no more endless retries in case of connection errors
+
+---
+
+## [3.0.1](https://github.com/Accenture/sfmc-devtools/compare/v3.0.0...v3.0.1) - 2021-04-11
 
 **Bugfixes:**