Merge pull request #1783 from input-output-hk/dlachaume/1754/lint-markdown-js-files-in-repo

Standardize code formatting in repository

Author: dlachaume

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,15 +1,17 @@
 ---
 name: Bug report
 about: You might have found a bug and decide to report it
-title: ''
-labels: 'bug :bug:'
-assignees: ''
+title: ""
+labels: "bug :bug:"
+assignees: ""
 ---
 
 ## Context & versions
+
 <!-- Explain your setup and what versions have been used. -->
 
 ## Steps to reproduce
+
 <!--
   1. Prepared x
   2. Started y
@@ -19,7 +21,9 @@ assignees: ''
 -->
 
 ## Actual behavior
+
 <!-- A description of the (reproducible) outcome. -->
 
 ## Expected behavior
-<!-- A description of what you expect to happen instead. -->
+
+<!-- A description of what you expect to happen instead. -->

.github/ISSUE_TEMPLATE/config.yaml

@@ -10,4 +10,4 @@ contact_links:
 
   - name: All issues
     url: https://github.com/input-output-hk/mithril/issues
-    about: Check whether your issue is not already covered here.
+    about: Check whether your issue is not already covered here.

.github/ISSUE_TEMPLATE/feature_idea.md

@@ -1,14 +1,15 @@
 ---
 name: Feature idea
 about: Idea or request for some feature on the Mithril roadmap
-title: ''
-labels: ':thought_balloon: idea'
-assignees: ''
-
+title: ""
+labels: ":thought_balloon: idea"
+assignees: ""
 ---
 
 ## Why
+
 <!-- Explain why you (or the user) need/want this (e.g. problem, challenge, pain, benefit) -->
 
 ## What
-<!-- Explain what this is roughly about (e.g. description of a new API endpoint or message format). -->
+
+<!-- Explain what this is roughly about (e.g. description of a new API endpoint or message format). -->

.github/pull_request_template.md

@@ -1,5 +1,7 @@
 ## Content
+
 <!-- Explain the reason for this change, if a feature is added, a bug is fixed, ... -->
+
 This PR includes...
 
 ## Pre-submit checklist
@@ -21,8 +23,11 @@ This PR includes...
   - [ ] Add dev blog post (if relevant)
 
 ## Comments
+
 <!-- Some optional comments about the PR, such as how to run a command, or warnings about usage, .... -->
 
 ## Issue(s)
+
 <!-- The issue(s) this PR relates to or closes -->
+
 Relates to #YYY or Closes #YYY

.github/workflows/actions/build-upload-mithril-artifact/action.yml

@@ -21,7 +21,7 @@ runs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: '3.x'
+        python-version: "3.x"
 
     - name: Add commit short sha to Cargo.tomls version
       shell: ${{ runner.os == 'Windows' && 'pwsh' || 'bash' }}

.github/workflows/actions/prepare-distribution/action.yml

@@ -1,7 +1,7 @@
 name: prepare-distribution
 description: |
   Package, add crates table, sign artifacts
-  
+
   The artifacts for all supported environments must have been downloaded
   in "package-{EnvName}-x64" subfolders before calling this action.
 inputs:
@@ -88,7 +88,7 @@ runs:
       shell: bash
       run: |
         cat >> ./release-notes-addon.txt << EOF
-        
+
         ## Linux Requirements
         The Linux binaries target \`glibc\`: to run them or install the \`.deb\` packages you must have \`glibc\` version \`2.31+\` installed.
         Compatible systems include, but are not limited to, \`Ubuntu 20.04+\` or \`Debian 11+\` (Bullseye)).
@@ -99,7 +99,7 @@ runs:
       shell: bash
       run: |
         cat >> ./release-notes-addon.txt << EOF
-        
+
         ## Fetch the latest version of the \`unstable\` tag
         The \`unstable\` tag is updated with a new commit id when a new \`unstable\` release is published.
         To fetch the latest version of the unstable tag, execute the command:

.github/workflows/actions/publish-crate-package/action.yml

@@ -27,7 +27,7 @@ runs:
         LOCAL_VERSION=$(cargo metadata --quiet --no-deps | jq -r '.packages[] | select(.name=="${{ inputs.package}}") | .version')
         echo "Latest crate.io version: $LATEST_REMOTE_VERSION"
         echo "Local version: $LOCAL_VERSION"
-        
+
         if [ "$LOCAL_VERSION" != "$LATEST_REMOTE_VERSION" ]; then 
           echo "Local version is newer than remote version: we will publish to crates.io"
           echo "should_deploy=true" >> $GITHUB_OUTPUT
@@ -47,7 +47,7 @@ runs:
       shell: bash
       run: |
         echo "Cargo publish '${{ inputs.package }}' package (dry run)"
-        cargo publish -p ${{ inputs.package }} --dry-run --no-verify --allow-dirty ${{ inputs.publish_args }} 
+        cargo publish -p ${{ inputs.package }} --dry-run --no-verify --allow-dirty ${{ inputs.publish_args }}
 
     - name: Cargo package list
       shell: bash

.github/workflows/actions/publish-npm-package/action.yml

@@ -19,103 +19,103 @@ inputs:
     description: npm package access.
     required: false
     default: "public"
-  api_token: 
+  api_token:
     description: npm API token.
     required: false
 
 runs:
   using: "composite"
   steps:
-  - name: Check npm latest version
-    id: check_version
-    shell: bash
-    run: |
-      echo "Check crate latest published version for '${{ inputs.package}}' package"
+    - name: Check npm latest version
+      id: check_version
+      shell: bash
+      run: |
+        echo "Check crate latest published version for '${{ inputs.package}}' package"
 
-      if [ "${{ inputs.tag }}" != "latest" -a "${{ inputs.tag }}" != "next" ]; then
-        echo "Tag '${{ inputs.tag }}' is not valid. It should be one of 'latest' or 'next'"
-        exit 1
-      fi
+        if [ "${{ inputs.tag }}" != "latest" -a "${{ inputs.tag }}" != "next" ]; then
+          echo "Tag '${{ inputs.tag }}' is not valid. It should be one of 'latest' or 'next'"
+          exit 1
+        fi
 
-      LOCAL_VERSION=$(cargo metadata --quiet --no-deps | jq -r '.packages[] | select(.name=="${{ inputs.package}}") | .version')
-      NEXT_REMOTE_VERSION=$(npm view @${{ inputs.scope }}/${{ inputs.package }} dist-tags.next 2> /dev/null || true)
-      LATEST_REMOTE_VERSION=$(npm view @${{ inputs.scope }}/${{ inputs.package }} dist-tags.latest 2> /dev/null || true)
+        LOCAL_VERSION=$(cargo metadata --quiet --no-deps | jq -r '.packages[] | select(.name=="${{ inputs.package}}") | .version')
+        NEXT_REMOTE_VERSION=$(npm view @${{ inputs.scope }}/${{ inputs.package }} dist-tags.next 2> /dev/null || true)
+        LATEST_REMOTE_VERSION=$(npm view @${{ inputs.scope }}/${{ inputs.package }} dist-tags.latest 2> /dev/null || true)
 
-      echo "Latest crate.io version: '$LATEST_REMOTE_VERSION'"
-      echo "Next crate.io version: '$NEXT_REMOTE_VERSION'"
-      echo "Local version: '$LOCAL_VERSION'"
+        echo "Latest crate.io version: '$LATEST_REMOTE_VERSION'"
+        echo "Next crate.io version: '$NEXT_REMOTE_VERSION'"
+        echo "Local version: '$LOCAL_VERSION'"
 
-      if [ "${{ inputs.tag }}" == "latest" ]; then
-        if [ "$LOCAL_VERSION" == "$LATEST_REMOTE_VERSION" ]; then
-          echo "Local version and remote version are the same: no need to publish to npm registry"
-          DEPLOY_MODE='none'
-        elif [ "$LOCAL_VERSION" == "$NEXT_REMOTE_VERSION" ]; then
-          DEPLOY_MODE='promote'
-        else
-          DEPLOY_MODE='publish'
+        if [ "${{ inputs.tag }}" == "latest" ]; then
+          if [ "$LOCAL_VERSION" == "$LATEST_REMOTE_VERSION" ]; then
+            echo "Local version and remote version are the same: no need to publish to npm registry"
+            DEPLOY_MODE='none'
+          elif [ "$LOCAL_VERSION" == "$NEXT_REMOTE_VERSION" ]; then
+            DEPLOY_MODE='promote'
+          else
+            DEPLOY_MODE='publish'
+          fi
+        else # input.tag == 'next'
+          if [ "$LOCAL_VERSION" == "$LATEST_REMOTE_VERSION" ]; then
+            # A latest already published: no need to tag with next
+            echo "Local version and remote version are the same: no need to publish to npm registry"
+            DEPLOY_MODE='none'
+          elif [ "$LOCAL_VERSION" == "$NEXT_REMOTE_VERSION" ]; then
+            echo "Local version and remote version are the same: no need to publish to npm registry"
+            DEPLOY_MODE='none'
+          else
+            DEPLOY_MODE='publish'
+          fi
         fi
-      else # input.tag == 'next'
-        if [ "$LOCAL_VERSION" == "$LATEST_REMOTE_VERSION" ]; then
-          # A latest already published: no need to tag with next
-          echo "Local version and remote version are the same: no need to publish to npm registry"
-          DEPLOY_MODE='none'
-        elif [ "$LOCAL_VERSION" == "$NEXT_REMOTE_VERSION" ]; then
-          echo "Local version and remote version are the same: no need to publish to npm registry"
-          DEPLOY_MODE='none'
-        else
-          DEPLOY_MODE='publish'
-        fi
-      fi
 
-      echo "Deploy mode: '$DEPLOY_MODE'"
-      echo "Dry run: '${{ inputs.dry_run }}'"
-      echo "deploy_mode=$DEPLOY_MODE" >> $GITHUB_OUTPUT
-      echo "package_version=$LOCAL_VERSION" >> $GITHUB_OUTPUT
+        echo "Deploy mode: '$DEPLOY_MODE'"
+        echo "Dry run: '${{ inputs.dry_run }}'"
+        echo "deploy_mode=$DEPLOY_MODE" >> $GITHUB_OUTPUT
+        echo "package_version=$LOCAL_VERSION" >> $GITHUB_OUTPUT
 
-  - name: Build package
-    shell: bash
-    run: |
-      echo "Build '@${{ inputs.scope }}/${{ inputs.package }}' package"
-      cp ./LICENSE ./mithril-client-wasm/
-      cp -f ./mithril-client-wasm/npm/README.md ./mithril-client-wasm/
-      wasm-pack build ${{ inputs.package }} --release --target web --out-dir ./pkg --scope ${{ inputs.scope }} --out-name index
+    - name: Build package
+      shell: bash
+      run: |
+        echo "Build '@${{ inputs.scope }}/${{ inputs.package }}' package"
+        cp ./LICENSE ./mithril-client-wasm/
+        cp -f ./mithril-client-wasm/npm/README.md ./mithril-client-wasm/
+        wasm-pack build ${{ inputs.package }} --release --target web --out-dir ./pkg --scope ${{ inputs.scope }} --out-name index
 
-  - name: List package
-    shell: bash
-    run: |
-      echo "List '@${{ inputs.scope }}/${{ inputs.package }}' package"
-      ls -al ${{ inputs.package }}/pkg
+    - name: List package
+      shell: bash
+      run: |
+        echo "List '@${{ inputs.scope }}/${{ inputs.package }}' package"
+        ls -al ${{ inputs.package }}/pkg
 
-  - name: Publish package new version
-    if: steps.check_version.outputs.deploy_mode == 'publish'
-    shell: bash
-    env:
-      NPM_TOKEN: ${{ inputs.api_token }}
-    run: |
-      echo "Publish '@${{ inputs.scope }}/${{ inputs.package }}' package"
-      npm set "//registry.npmjs.org/:_authToken=${NPM_TOKEN}"
-      if [ -z "${NPM_TOKEN}" -a "${{ inputs.dry_run }}" == "true" ]; then
-        echo "Warning: An NPM access token is required for authentication and has not been provided."
-      else
-        npm whoami
-      fi
-      cd ${{ inputs.package }}/pkg
-      if [ "${{ inputs.dry_run }}" == "false" ]; then
-        dry_run_option=""
-      else
-        dry_run_option="--dry-run"
-      fi
-      npm publish --tag ${{ inputs.tag }} --access ${{ inputs.access }} $dry_run_option
+    - name: Publish package new version
+      if: steps.check_version.outputs.deploy_mode == 'publish'
+      shell: bash
+      env:
+        NPM_TOKEN: ${{ inputs.api_token }}
+      run: |
+        echo "Publish '@${{ inputs.scope }}/${{ inputs.package }}' package"
+        npm set "//registry.npmjs.org/:_authToken=${NPM_TOKEN}"
+        if [ -z "${NPM_TOKEN}" -a "${{ inputs.dry_run }}" == "true" ]; then
+          echo "Warning: An NPM access token is required for authentication and has not been provided."
+        else
+          npm whoami
+        fi
+        cd ${{ inputs.package }}/pkg
+        if [ "${{ inputs.dry_run }}" == "false" ]; then
+          dry_run_option=""
+        else
+          dry_run_option="--dry-run"
+        fi
+        npm publish --tag ${{ inputs.tag }} --access ${{ inputs.access }} $dry_run_option
 
-  - name: Promote package distribution tag to 'latest'
-    if: inputs.dry_run == 'false' && steps.check_version.outputs.deploy_mode == 'promote'
-    shell: bash
-    env:
-      NPM_TOKEN: ${{ inputs.api_token }}
-    run: |
-      echo "Publish '@${{ inputs.scope }}/${{ inputs.package }}' package"
-      npm set "//registry.npmjs.org/:_authToken=${NPM_TOKEN}"
-      npm whoami
-      cd ${{ inputs.package }}/pkg
-      npm dist-tag add @${{ inputs.scope }}/${{ inputs.package }}@${{ steps.check_version.outputs.package_version }} latest
-      npm dist-tag rm @${{ inputs.scope }}/${{ inputs.package }}@${{ steps.check_version.outputs.package_version }} next
+    - name: Promote package distribution tag to 'latest'
+      if: inputs.dry_run == 'false' && steps.check_version.outputs.deploy_mode == 'promote'
+      shell: bash
+      env:
+        NPM_TOKEN: ${{ inputs.api_token }}
+      run: |
+        echo "Publish '@${{ inputs.scope }}/${{ inputs.package }}' package"
+        npm set "//registry.npmjs.org/:_authToken=${NPM_TOKEN}"
+        npm whoami
+        cd ${{ inputs.package }}/pkg
+        npm dist-tag add @${{ inputs.scope }}/${{ inputs.package }}@${{ steps.check_version.outputs.package_version }} latest
+        npm dist-tag rm @${{ inputs.scope }}/${{ inputs.package }}@${{ steps.check_version.outputs.package_version }} next

.github/workflows/actions/toolchain-and-cache/action.yml

@@ -4,11 +4,11 @@ inputs:
   cache-version:
     description: Version of the current cache
     required: false
-    default: ''
+    default: ""
   cargo-tools:
     description: Space seperated list of cargo tools to install
     required: false
-    default: ''
+    default: ""
   github-token:
     description: GitHub token to use for installing cargo tools
     required: true

.github/workflows/aggregator-stress-test.yml

@@ -70,8 +70,8 @@ jobs:
 
       - name: Run the aggregator stress test
         run: |
-            ./bin/load-aggregator ${{ steps.prepare.outputs.debug_level }} \
-            --cardano-cli-path ./mithril-test-lab/mithril-end-to-end/script/mock-cardano-cli \
-            --aggregator-dir ./bin \
-            --num-signers=${{ inputs.num_signers }} \
-            --num-clients=${{ inputs.num_clients }}
+          ./bin/load-aggregator ${{ steps.prepare.outputs.debug_level }} \
+          --cardano-cli-path ./mithril-test-lab/mithril-end-to-end/script/mock-cardano-cli \
+          --aggregator-dir ./bin \
+          --num-signers=${{ inputs.num_signers }} \
+          --num-clients=${{ inputs.num_clients }}