mcdev 4.3.4 → 5.0.1

package/.coverage-comment-template.md

@@ -0,0 +1,20 @@
+## Coverage Report
+
+Commit: [{{short_commit_sha}}]({{commit_link}})
+Base: [{{base_ref}}@{{base_short_commit_sha}}]({{base_commit_link}})
+
+| Type                      | Base                                       | This PR                                                                            |
+| ------------------------- | ------------------------------------------ | ---------------------------------------------------------------------------------- |
+| Total Statements Coverage | {{base_total_statements_coverage_percent}} | {{total_statements_coverage_percent}} ({{total_statements_coverage_percent_diff}}) |
+| Total Branches Coverage   | {{base_total_branches_coverage_percent}}   | {{total_branches_coverage_percent}} ({{total_branches_coverage_percent_diff}})     |
+| Total Functions Coverage  | {{base_total_functions_coverage_percent}}  | {{total_functions_coverage_percent}} ({{total_functions_coverage_percent_diff}})   |
+| Total Lines Coverage      | {{base_total_lines_coverage_percent}}      | {{total_lines_coverage_percent}} ({{total_lines_coverage_percent_diff}})           |
+
+<details>
+<summary>Details (changed files)</summary>
+{{changed_files_coverage_table}}
+</details>
+<details>
+<summary>Details (all files)</summary>
+{{files_coverage_table}}
+</details>

package/.coverage-comment-template.svelte

@@ -0,0 +1,178 @@
+<script>
+  export let total_statements_coverage_percent_raw;
+  export let total_branches_coverage_percent_raw;
+  export let total_functions_coverage_percent_raw;
+  export let total_lines_coverage_percent_raw;
+
+  export let base_total_statements_coverage_percent_raw;
+  export let base_total_branches_coverage_percent_raw;
+  export let base_total_functions_coverage_percent_raw;
+  export let base_total_lines_coverage_percent_raw;
+
+  export let commit_sha;
+  export let short_commit_sha;
+  export let commit_link;
+
+  export let base_commit_sha;
+  export let base_short_commit_sha;
+  export let base_commit_link;
+  export let base_ref;
+
+  export let changed_files_coverage_data;
+
+  const has_base_data = base_total_branches_coverage_percent_raw !== '?';
+  const summary_list = [
+    {
+      type: 'Total Statements Coverage',
+      percent: {
+        total: total_statements_coverage_percent_raw,
+        base: has_base_data ? base_total_statements_coverage_percent_raw: null,
+        diff: has_base_data ? (total_statements_coverage_percent_raw - base_total_statements_coverage_percent_raw) : null,
+      }
+    },
+    {
+      type: 'Total Branches Coverage',
+      percent: {
+        total: total_branches_coverage_percent_raw,
+        base: has_base_data ? base_total_branches_coverage_percent_raw: null,
+        diff: has_base_data ? (total_branches_coverage_percent_raw - base_total_branches_coverage_percent_raw) : null,
+      }
+    },
+    {
+      type: 'Total Functions Coverage',
+      percent: {
+        total: total_functions_coverage_percent_raw,
+        base: has_base_data ? base_total_functions_coverage_percent_raw: null,
+        diff: has_base_data ? (total_functions_coverage_percent_raw - base_total_functions_coverage_percent_raw) : null,
+      }
+    },
+    {
+      type: 'Total Lines Coverage',
+      percent: {
+        total: total_lines_coverage_percent_raw,
+        base: has_base_data ? base_total_lines_coverage_percent_raw: null,
+        diff: has_base_data ? (total_lines_coverage_percent_raw - base_total_lines_coverage_percent_raw) : null,
+      }
+    }];
+
+  const LETTER_LABEL = {
+    S: 'Statements',
+    B: 'Branches',
+    F: 'Functions',
+    L: 'Lines',
+  };
+
+  const COVERAGE_LEVEL_IMAGE = {
+    low: 'https://user-images.githubusercontent.com/11299391/159445221-fe3dc085-8c56-4e03-9642-219784c88fe7.svg',
+    medium:
+      'https://user-images.githubusercontent.com/11299391/159445212-f135c6d7-f354-4e8c-9a9f-28bb3ff1b7b5.svg',
+    high: 'https://user-images.githubusercontent.com/11299391/159445220-d88b3624-0814-4664-80c8-09f0f2b8e68b.svg',
+  };
+
+  function formatPercentDiff(percent) {
+    if (!Number.isFinite(percent)) {
+      return '';
+    }
+
+    const roundedPercent = `${Number(percent.toFixed(2))}%`;
+
+    if (percent >= 0) {
+      return '+' + roundedPercent;
+    }
+
+    return roundedPercent;
+  }
+
+  function getCoverageLevelImage(percent) {
+    // https://github.com/istanbuljs/istanbuljs/blob/c1559005b3bb318da01f505740adb0e782aaf14e/packages/istanbul-lib-report/lib/watermarks.js
+    if (percent >= 80) {
+      return COVERAGE_LEVEL_IMAGE.high;
+    } else if (percent >= 50) {
+      return COVERAGE_LEVEL_IMAGE.medium;
+    } else {
+      return COVERAGE_LEVEL_IMAGE.low;
+    }
+  }
+
+  function getFilePrefix() {
+    return `../blob/${commit_sha}/`;
+  }
+</script>
+
+<h2>Coverage Report</h2>
+
+Commit: <a href="{commit_link}">{short_commit_sha}</a><br>
+Base: <a href="{base_commit_link}">{base_ref}@{base_short_commit_sha}</a><br><br>
+
+<table>
+  <thead>
+    <th>Type</th>
+      {#if has_base_data}
+        <th>Base</th>
+      {/if}
+    <th>This PR</th>
+  </thead>
+  <tbody>
+    {#each summary_list as {type, percent}}
+      <tr>
+        <td>{type}</td>
+        {#if has_base_data}
+          <td>
+            {#if Number.isFinite(percent.base)}
+              <img src="{getCoverageLevelImage(percent.base)}" alt="">&nbsp;{percent.base}%
+            {:else}
+              -
+            {/if}
+          </td>
+        {/if}
+        <td>
+          {#if Number.isFinite(percent.total)}
+            <img src="{getCoverageLevelImage(percent.total)}" alt="">&nbsp;{percent.total}%
+            {#if has_base_data}
+              &nbsp;({formatPercentDiff(percent.diff)})
+            {/if}
+          {:else}
+            -
+          {/if}
+        </td>
+      </tr>
+    {/each}
+  </tbody>
+</table>
+
+<details>
+  <summary>Details (changed testable files):</summary><br>
+  <table>
+    <thead>
+      <th>File</th>
+      <th>Statements</th>
+      <th>Branches</th>
+      <th>Functions</th>
+      <th>Lines</th>
+    </thead>
+    <tbody>
+      {#each changed_files_coverage_data as [file, data]}
+        {@const percents = [
+          data.statements.pct,
+          data.branches.pct,
+          data.functions.pct,
+          data.lines.pct
+        ]}
+        <tr>
+          <td>
+            <a href="{getFilePrefix()}{file}">{file}</a>
+          </td>
+          {#each percents as percent}
+            <td>
+              {#if Number.isFinite(percent)}
+                <img src="{getCoverageLevelImage(percent)}" alt="">&nbsp;{percent}%
+              {:else}
+                -
+              {/if}
+            </td>
+          {/each}
+        </tr>
+      {/each}
+    </tbody>
+  </table>
+</details>

package/.eslintrc.json

@@ -42,6 +42,7 @@
         }
     },
     "rules": {
+        "logical-assignment-operators": ["error", "always"],
         "unicorn/better-regex": "off",
         "unicorn/catch-error-name": [
             "error",
@@ -65,6 +66,7 @@
         "unicorn/prefer-array-some": "off",
         "unicorn/prefer-set-has": "off",
         "unicorn/prefer-spread": "off",
+        "unicorn/prefer-string-replace-all": "error",
         "unicorn/unicorn/no-lonely-if": "off",
         "arrow-body-style": ["error", "as-needed"],
         "curly": "error",

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:
+              - 5.0.1
+              - 5.0.0
               - 4.3.4
               - 4.3.3
               - 4.3.2

package/.github/workflows/code-test.yml

@@ -0,0 +1,36 @@
+# Custom tests for mcdev
+#
+name: 'Code Testing'
+
+on:
+    push:
+        branches: [main, develop, hotfix]
+    pull_request:
+        # The branches below must be a subset of the branches above
+        branches: [main, develop, hotfix]
+
+jobs:
+    testAndCoverage:
+        name: lint & test
+        runs-on: ubuntu-latest
+        permissions:
+            actions: read
+            contents: read
+            security-events: write
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v3
+
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 16
+                  registry-url: https://registry.npmjs.org/
+
+            - run: npm ci --ignore-scripts
+
+            - run: npm run lint
+
+            # Assuming code passes, run tests
+            - name: Run mcdev-tests
+              run: npm run test

package/.github/workflows/coverage-base-update.yml

@@ -0,0 +1,57 @@
+name: Update coverage comment
+on:
+    pull_request:
+        types: [edited]
+
+jobs:
+    hello_world_job:
+        runs-on: ubuntu-latest
+        name: Test and report
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+              with:
+                  ref: ${{ github.event.pull_request.head.sha }}
+                  fetch-depth: 1000
+
+            - name: Prepare for Report Coverage (without nyc run)
+              run: |
+                  npm i svelte-to-html@1.0.9
+                  git fetch origin ${{ github.event.pull_request.base.ref }} --depth=1000
+
+            - name: Download artifact for base branch
+              uses: dawidd6/action-download-artifact@v2
+              continue-on-error: true
+              with:
+                  workflow: ${{ github.event.pull_request.base.ref == 'main' && 'coverage-main-branch.yml' || github.event.pull_request.base.ref == 'develop' && 'coverage-develop-branch.yml' || 'coverage.yml' }}
+                  workflow_conclusion: success
+                  commit: ${{github.event.pull_request.base.sha}}
+                  name: 'test-coverage-output'
+                  path: base-artifacts
+                  search_artifacts: true
+
+            - name: Download artifact for to be merged branch
+              uses: dawidd6/action-download-artifact@v2
+              continue-on-error: true
+              with:
+                  workflow: 'coverage.yml'
+                  workflow_conclusion: success
+                  commit: ${{github.event.pull_request.head.sha}}
+                  name: 'test-coverage-output'
+                  path: artifacts
+                  search_artifacts: true
+
+            - name: Check file existence
+              id: check_files
+              uses: andstor/file-existence-action@v2
+              with:
+                  files: 'base-artifacts/coverage-summary.json, artifacts/coverage-summary.json'
+
+            - name: Update Coverage comment
+              uses: sidx1024/report-nyc-coverage-github-action@v1.2.6
+              if: steps.check_files.outputs.files_exists == 'true'
+              # Only runs if all of the files exists
+              with:
+                  coverage_file: 'artifacts/coverage-summary.json'
+                  base_coverage_file: 'base-artifacts/coverage-summary.json'
+                  comment_template_file: '.coverage-comment-template.svelte'

package/.github/workflows/coverage-develop-branch.yml

@@ -0,0 +1,41 @@
+name: Test coverage for develop branch
+
+on:
+    push:
+        branches:
+            - develop
+
+jobs:
+    hello_world_job:
+        runs-on: ubuntu-latest
+        name: Test and report
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+              with:
+                  ref: ${{ github.event.pull_request.head.sha }}
+                  fetch-depth: 1000
+
+            - name: Fetch base
+              run: git fetch origin ${{ github.event.pull_request.base.ref }} --depth=1000
+
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 16
+
+            - run: npm ci --ignore-scripts
+
+            - run: npm run lint
+
+            - name: Run mcdev-tests with coverage
+              run: npm run coverage
+
+            - name: Prepare for Report Coverage (mini)
+              run: |
+                  npx nyc report --reporter json-summary --exclude-after-remap false
+
+            - name: Upload coverage artifact
+              uses: actions/upload-artifact@v3
+              with:
+                  name: test-coverage-output
+                  path: coverage

package/.github/workflows/coverage-main-branch.yml

@@ -0,0 +1,41 @@
+name: Test coverage for main branch
+
+on:
+    push:
+        branches:
+            - main
+
+jobs:
+    hello_world_job:
+        runs-on: ubuntu-latest
+        name: Test and report
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+              with:
+                  ref: ${{ github.event.pull_request.head.sha }}
+                  fetch-depth: 1000
+
+            - name: Fetch base
+              run: git fetch origin ${{ github.event.pull_request.base.ref }} --depth=1000
+
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 16
+
+            - run: npm ci --ignore-scripts
+
+            - run: npm run lint
+
+            - name: Run mcdev-tests with coverage
+              run: npm run coverage
+
+            - name: Prepare for Report Coverage (mini)
+              run: |
+                  npx nyc report --reporter json-summary --exclude-after-remap false
+
+            - name: Upload coverage artifact
+              uses: actions/upload-artifact@v3
+              with:
+                  name: test-coverage-output
+                  path: coverage

package/.github/workflows/coverage.yml

@@ -0,0 +1,77 @@
+on: [pull_request]
+
+name: Test coverage report
+jobs:
+    hello_world_job:
+        runs-on: ubuntu-latest
+        name: Test and report
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+              with:
+                  ref: ${{ github.event.pull_request.head.sha }}
+                  fetch-depth: 1000
+
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 16
+
+            - run: npm ci --ignore-scripts
+
+            - run: npm run lint
+
+            - name: Run mcdev-tests with coverage
+              run: npm run coverage
+
+            - name: Prepare for Report Coverage
+              run: |
+                  npx nyc report --reporter json-summary --exclude-after-remap false
+                  npm i svelte-to-html@1.0.9
+                  git fetch origin ${{ github.event.pull_request.base.ref }} --depth=1000
+
+            - name: Upload coverage artifact
+              uses: actions/upload-artifact@v3
+              with:
+                  name: test-coverage-output
+                  path: coverage
+
+            - name: Download coverage artifact
+              uses: actions/download-artifact@v3
+              with:
+                  path: artifacts
+
+            - name: Get Run ID
+              id: get_run_id
+              run: |
+                  echo "name=run_id::$(\
+                    gh run list \
+                      --workflow "${{ github.event.pull_request.base.ref == 'main' && 'coverage-main-branch.yml' || github.event.pull_request.base.ref == 'develop' && 'coverage-develop-branch.yml' || 'coverage.yml' }}" \
+                      --json conclusion,headSha,status,databaseId \
+                      --jq ".[] | select( .conclusion == \"success\" and .headSha == \"${{github.event.pull_request.base.sha}}\") | .databaseId" \
+                  )" >> $GITHUB_OUTPUT
+              env:
+                  GITHUB_TOKEN: ${{ github.token }}
+
+            - name: Download artifact for base branch if available, previous
+              uses: dawidd6/action-download-artifact@v2
+              continue-on-error: true
+              with:
+                  workflow: ${{ github.event.pull_request.base.ref == 'main' && 'coverage-main-branch.yml' || github.event.pull_request.base.ref == 'develop' && 'coverage-develop-branch.yml' || 'coverage.yml' }}
+                  run_id: ${{steps.get_run_id.outputs.run_id}}
+                  name: 'test-coverage-output'
+                  path: base-artifacts
+                  search_artifacts: true
+
+            - name: Check file existence
+              id: check_files
+              uses: andstor/file-existence-action@v2
+              with:
+                  files: 'base-artifacts/coverage-summary.json'
+
+            - name: Report coverage
+              uses: sidx1024/report-nyc-coverage-github-action@v1.2.6
+              id: report
+              with:
+                  coverage_file: 'artifacts/test-coverage-output/coverage-summary.json'
+                  base_coverage_file: ${{steps.check_files.outputs.files_exists == 'true' && 'base-artifacts/coverage-summary.json' || ''}}
+                  comment_template_file: '.coverage-comment-template.svelte'

package/.husky/post-checkout

@@ -1,5 +1,5 @@
 #!/bin/sh
 git config commit.template .git/templatemessage
-TICKETID=`git rev-parse --abbrev-ref HEAD | LC_ALL=en_US.utf8 grep -oP '(?<=[feature|bugfix|task]\/)\d{2,5}'`
+TICKETID=`git rev-parse --abbrev-ref HEAD | LC_ALL=en_US.utf8 grep -oP '((feature|bug|bugfix|fix|hotfix|task|chore)\/)\K\d{1,7}'`
 echo "[POST_CHECKOUT] Setting template commit to $TICKETID"
 echo "#$TICKETID: " > ".git/templatemessage"

package/.prettierrc

@@ -27,7 +27,7 @@
             "options": {
                 "formatter": "sql-formatter",
                 "language": "tsql",
-                "uppercase": true
+                "keywordCase": "upper"
             }
         }
     ]

package/.vscode/extensions.json

@@ -5,7 +5,6 @@
     // List of extensions which should be recommended for users of this workspace.
     "recommendations": [
         // collaboration
-        "gruntfuggly.todo-tree",
         "aaron-bond.better-comments",
         "github.vscode-pull-request-github",
 
@@ -15,11 +14,8 @@
         // Formatting & colors
         "editorconfig.editorconfig",
         "esbenp.prettier-vscode",
-        "sergey-agadzhanov.ampscript",
 
         // Markdown / Readme.md
-        "yzhang.markdown-all-in-one",
-        "davidanson.vscode-markdownlint",
         "joernberkefeld.markdown-preview-bitbucket-innersource"
     ]
 }

package/README.md

@@ -47,7 +47,7 @@ Find info on the latest releases with a detailed changelog in the [GitHub Releas
 
 If you want to enhance Accenture SFMC DevTools you are welcome to fork the repo and create a pull request. Please understand that we will have to conduct a code review before accepting your changes.
 
-More details on how to best do that are described in our [wiki](https://github.com/Accenture/sfmc-devtools/wiki/9.-Contribute).
+More details on how to best do that are described in our [wiki](https://github.com/Accenture/sfmc-devtools/wiki/10.-Contribute).
 
 ## Main Contacts
 

package/boilerplate/config.json

@@ -69,7 +69,7 @@
         }
     },
     "metaDataTypes": {
-        "documentOnRetrieve": ["accountUser", "automation", "dataExtension", "role"],
+        "documentOnRetrieve": ["user", "automation", "dataExtension", "role"],
         "retrieve": []
     }
 }

package/boilerplate/files/.prettierrc

@@ -17,7 +17,7 @@
             "options": {
                 "formatter": "sql-formatter",
                 "language": "tsql",
-                "uppercase": true
+                "keywordCase": "upper"
             }
         }
     ]

package/boilerplate/files/.vscode/extensions.json

@@ -14,7 +14,7 @@
         // Formatting & colors
         "editorconfig.editorconfig",
         "esbenp.prettier-vscode",
-        "sergey-agadzhanov.ampscript",
+        "xnerd.ampscript-language",
         "FiB.beautyAmp",
 
         // Markdown / Readme.md

package/boilerplate/forcedUpdates.json

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