mcdev 5.0.1 → 5.1.0

package/.coverage-comment-template.svelte

@@ -1,178 +1,194 @@
 <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 '';
+    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;
     }
 
-    const roundedPercent = `${Number(percent.toFixed(2))}%`;
-
-    if (percent >= 0) {
-      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;
+        }
     }
 
-    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}/`;
     }
-  }
-
-  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>
+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>
+    <thead>
+        <th>Type</th>
         {#if has_base_data}
-          <td>
-            {#if Number.isFinite(percent.base)}
-              <img src="{getCoverageLevelImage(percent.base)}" alt="">&nbsp;{percent.base}%
-            {:else}
-              -
-            {/if}
-          </td>
+            <th>Base</th>
         {/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>
+        <th>This PR</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}
+        {#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>
+</table>
+
+<details>
+    <summary>Details (changed 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

@@ -84,6 +84,7 @@
                 }
             }
         ],
+        "jsdoc/tag-lines": ["warn", "any", { "startLines": 1 }],
         "spaced-comment": ["warn", "always", { "block": { "exceptions": ["*"], "balanced": true } }]
     },
     "overrides": [

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.1.0
+              - 5.0.2
               - 5.0.1
               - 5.0.0
               - 4.3.4

package/.github/dependabot.yml

@@ -12,3 +12,11 @@ updates:
       target-branch: 'develop'
       labels:
           - 'dependencies'
+    - package-ecosystem: 'github-actions'
+      directory: '/'
+      schedule:
+          interval: 'weekly'
+      target-branch: 'main'
+      labels:
+          - 'dependencies'
+          - 'github-action'

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

@@ -1,8 +1,12 @@
-name: Update coverage comment
+name: Update coverage comment # base-update.yml
 on:
     pull_request:
         types: [edited]
 
+permissions:
+    # allow dependabot to execute this workflow
+    pull-requests: write
+
 jobs:
     hello_world_job:
         runs-on: ubuntu-latest
@@ -48,7 +52,7 @@ jobs:
                   files: 'base-artifacts/coverage-summary.json, artifacts/coverage-summary.json'
 
             - name: Update Coverage comment
-              uses: sidx1024/report-nyc-coverage-github-action@v1.2.6
+              uses: sidx1024/report-nyc-coverage-github-action@v1.2.7
               if: steps.check_files.outputs.files_exists == 'true'
               # Only runs if all of the files exists
               with:

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

@@ -1,24 +1,25 @@
-name: Test coverage for develop branch
+name: Test coverage for develop branch # default-branch.yml
 
 on:
     push:
         branches:
             - develop
 
+permissions:
+    # allow dependabot to execute this workflow
+    pull-requests: write
+
 jobs:
     hello_world_job:
         runs-on: ubuntu-latest
-        name: Test and report
+        name: Test and upload coverage
         steps:
             - name: Checkout
               uses: actions/checkout@v3
               with:
-                  ref: ${{ github.event.pull_request.head.sha }}
+                  ref: ${{ github.event.ref }}
                   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

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

@@ -1,24 +1,25 @@
-name: Test coverage for main branch
+name: Test coverage for main branch # default-branch.yml
 
 on:
     push:
         branches:
             - main
 
+permissions:
+    # allow dependabot to execute this workflow
+    pull-requests: write
+
 jobs:
     hello_world_job:
         runs-on: ubuntu-latest
-        name: Test and report
+        name: Test and upload coverage
         steps:
             - name: Checkout
               uses: actions/checkout@v3
               with:
-                  ref: ${{ github.event.pull_request.head.sha }}
+                  ref: ${{ github.event.ref }}
                   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

package/.github/workflows/coverage.yml

@@ -1,6 +1,11 @@
 on: [pull_request]
 
-name: Test coverage report
+name: Test coverage report # main.yml
+
+permissions:
+    # allow dependabot to execute this workflow
+    pull-requests: write
+
 jobs:
     hello_world_job:
         runs-on: ubuntu-latest
@@ -69,7 +74,7 @@ jobs:
                   files: 'base-artifacts/coverage-summary.json'
 
             - name: Report coverage
-              uses: sidx1024/report-nyc-coverage-github-action@v1.2.6
+              uses: sidx1024/report-nyc-coverage-github-action@v1.2.7
               id: report
               with:
                   coverage_file: 'artifacts/test-coverage-output/coverage-summary.json'

package/.husky/commit-msg

@@ -2,7 +2,7 @@
 . "$(dirname "$0")/_/husky.sh"
 INPUT_FILE=$1
 START_LINE=`head -n1 $INPUT_FILE`
-PATTERN="^(#[[:digit:]]|Merge)"
+PATTERN="^(#[[:digit:]]|Merge|Revert)"
 
 if ! [[ "$START_LINE" =~ $PATTERN ]] ; then
   echo "Bad commit message, see example: \"#431 commit message\", you provided: \"$START_LINE\""

package/.husky/post-checkout

@@ -1,5 +1,37 @@
 #!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# ### git commit message template ###
 git config commit.template .git/templatemessage
-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"
+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}' || true`
+if [ -z "$TICKETID" ]
+then
+  TICKETID="0"
+fi
+TEMPLATE="#$TICKETID: "
+echo "[POST_CHECKOUT] Setting template commit to '$TEMPLATE'"
+# wrap $TEMPLATE in quotes or else it is trimmed automatically
+echo "$TEMPLATE" > ".git/templatemessage"
+
+
+# ### run npm install ###
+echo "[POST-CHECKOUT] 📦 Checking for changes to dependencies"
+# define how to split strings into array elements
+IFS=$'\n'
+# $1 is the new HEAD pointer
+NEWHEAD=$1
+# $2 is the previous HEAD pointer
+OLDHEAD=$2
+# extract all paths to package-lock.json files
+PACKAGE_LOCK_REGEX="(^package-lock\.json)"
+PACKAGES=$(git diff --name-only $NEWHEAD $OLDHEAD | grep -E $PACKAGE_LOCK_REGEX || true)
+
+if [[ ${PACKAGES[@]} ]]; then
+  for package in $PACKAGES; do
+    echo "📦 $package was changed."
+  done
+  echo "📦 Running npm install to update your dependencies..."
+  npm install
+else
+  echo "📦 All packages up-to-date. No need to run npm install."
+fi

package/.husky/post-merge

@@ -0,0 +1,21 @@
+#!/bin/sh
+# ### run npm install ###
+. "$(dirname "$0")/_/husky.sh"
+
+
+echo "[POST-MERGE] 📦 Checking for changes to dependencies"
+
+IFS=$'\n'
+# extract all paths to package-lock.json files 
+PACKAGE_LOCK_REGEX="(^package-lock\.json)"
+PACKAGES=$(git diff --name-only HEAD^1 HEAD | grep -E $PACKAGE_LOCK_REGEX || true)
+
+if [[ ${PACKAGES[@]} ]]; then
+  for package in $PACKAGES; do
+    echo "📦 $package was changed."
+  done
+  echo "📦 Running npm install to update your dependencies..."
+  npm install
+else
+  echo "📦 All packages up-to-date. No need to run npm install."
+fi

package/.husky/pre-commit

@@ -1,5 +1,6 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
+
 npm run docs
 git update-index --add docs/dist/documentation.md
 npx --no lint-staged