use PAT if available else fall back to workflow token

we don't need to run these on PR close or when we apply labels, for example

.circleci/config.yml

@@ -1,69 +1,5 @@
 version: 2
 
-main_steps: &main_steps
-  steps:
-    - checkout
-
-    - run:
-        name: Install dependencies
-        command: |
-          npm ci
-        environment:
-          # https://docs.cypress.io/guides/getting-started/installing-cypress.html#Skipping-installation
-          # We don't need to install the Cypress binary in jobs that aren't actually running Cypress.
-          CYPRESS_INSTALL_BINARY: 0
-
-    - run:
-        name: Linter
-        when: always
-        command: npm run lint
-
-    - run:
-        name: Core tests
-        when: always
-        environment:
-          mocha_reporter: mocha-junit-reporter
-          MOCHA_FILE: junit/core/results.xml
-        command: npm run test:core
-
-    - run:
-        name: Entrypoint tests
-        when: always
-        environment:
-          mocha_reporter: mocha-junit-reporter
-          MOCHA_FILE: junit/entrypoint/results.xml
-        command: npm run test:entrypoint
-
-    - store_test_results:
-        path: junit
-
-    - run:
-        name: 'Prettier check (quick fix: `npm run prettier`)'
-        when: always
-        command: npm run prettier:check
-
-integration_steps: &integration_steps
-  steps:
-    - checkout
-
-    - run:
-        name: Install dependencies
-        command: |
-          npm ci
-        environment:
-          CYPRESS_INSTALL_BINARY: 0
-
-    - run:
-        name: Integration tests
-        when: always
-        environment:
-          mocha_reporter: mocha-junit-reporter
-          MOCHA_FILE: junit/integration/results.xml
-        command: npm run test:integration
-
-    - store_test_results:
-        path: junit
-
 services_steps: &services_steps
   steps:
     - checkout
@@ -89,83 +25,7 @@ services_steps: &services_steps
     - store_test_results:
         path: junit
 
-package_steps: &package_steps
-  steps:
-    - checkout
-
-    - run:
-        name: Install node and npm
-        command: |
-          set +e
-          export NVM_DIR="/opt/circleci/.nvm"
-          [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
-          nvm install v14
-          nvm use v14
-          npm install -g npm
-
-    # Run the package tests on each currently supported node version. See:
-    # https://github.com/badges/shields/blob/master/badge-maker/README.md#node-version-support
-    # https://nodejs.org/en/about/releases/
-
-    - run:
-        environment:
-          mocha_reporter: mocha-junit-reporter
-          MOCHA_FILE: junit/badge-maker/v12/results.xml
-          NODE_VERSION: v12
-          CYPRESS_INSTALL_BINARY: 0
-          NPM_CONFIG_ENGINE_STRICT: 'false'
-        name: Run package tests on Node 12
-        command: scripts/run_package_tests.sh
-
-    - run:
-        environment:
-          mocha_reporter: mocha-junit-reporter
-          MOCHA_FILE: junit/badge-maker/v14/results.xml
-          NODE_VERSION: v14
-          CYPRESS_INSTALL_BINARY: 0
-          NPM_CONFIG_ENGINE_STRICT: 'false'
-        name: Run package tests on Node 14
-        command: scripts/run_package_tests.sh
-
-    - run:
-        environment:
-          mocha_reporter: mocha-junit-reporter
-          MOCHA_FILE: junit/badge-maker/v16/results.xml
-          NODE_VERSION: v16
-          CYPRESS_INSTALL_BINARY: 0
-        name: Run package tests on Node 16
-        command: scripts/run_package_tests.sh
-
-    - store_test_results:
-        path: junit
-
 jobs:
-  main:
-    docker:
-      - image: cimg/node:16.15
-
-    <<: *main_steps
-
-  main@node-17:
-    docker:
-      - image: cimg/node:17.9
-
-    <<: *main_steps
-
-  integration:
-    docker:
-      - image: cimg/node:16.15
-      - image: redis
-
-    <<: *integration_steps
-
-  integration@node-17:
-    docker:
-      - image: cimg/node:17.9
-      - image: redis
-
-    <<: *integration_steps
-
   danger:
     docker:
       - image: cimg/node:16.15
@@ -224,12 +84,6 @@ jobs:
           when: always
           command: npm run build
 
-  package:
-    machine:
-      image: 'ubuntu-2004:202111-02'
-
-    <<: *package_steps
-
   services:
     docker:
       - image: cimg/node:16.15
@@ -239,6 +93,8 @@ jobs:
   services@node-17:
     docker:
       - image: cimg/node:17.9
+    environment:
+      NPM_CONFIG_ENGINE_STRICT: 'false'
 
     <<: *services_steps
 
@@ -291,26 +147,10 @@ workflows:
 
   on-commit:
     jobs:
-      - main:
-          filters:
-            branches:
-              ignore: gh-pages
-      - main@node-17:
-          filters:
-            branches:
-              ignore: gh-pages
-      - integration@node-17:
-          filters:
-            branches:
-              ignore: gh-pages
       - frontend:
           filters:
             branches:
               ignore: gh-pages
-      - package:
-          filters:
-            branches:
-              ignore: gh-pages
       - services:
           filters:
             branches:
@@ -340,12 +180,6 @@ workflows:
   #         filters:
   #           branches:
   #             ignore: gh-pages
-  #     - main:
-  #         requires:
-  #           - npm-install
-  #     - main@node-latest:
-  #         requires:
-  #           - npm-install
   #     - frontend:
   #         requires:
   #           - npm-install

.eslintrc.yml

@@ -144,6 +144,8 @@ rules:
   func-style: ['error', 'declaration', { 'allowArrowFunctions': true }]
   new-cap: ['error', { 'capIsNew': true }]
   import/order: ['error', { 'newlines-between': 'never' }]
+  quotes:
+    ['error', 'single', { 'avoidEscape': true, 'allowTemplateLiterals': false }]
 
   # Account for destructuring responses from upstream services,
   # many of which do not follow camelcase

.github/ISSUE_TEMPLATE/3_Badge_request.md

@@ -21,7 +21,7 @@ A clear and concise description of the new badge.
 Where can we get the data from?
 
 - Is there a public API?
-- Does the API requires an API key?
+- Does the API require an API key?
 - Link to the API documentation.
 -->
 

.github/actions/close-bot/index.js

@@ -27,7 +27,7 @@ async function run() {
           state: 'closed',
         })
 
-        core.debug(`Done.`)
+        core.debug('Done.')
       }
     }
   } catch (error) {

.github/actions/close-bot/package-lock.json

@@ -9,22 +9,23 @@
       "version": "0.0.0",
       "license": "CC0",
       "dependencies": {
-        "@actions/core": "^1.8.2",
-        "@actions/github": "^5.0.3"
+        "@actions/core": "^1.10.0",
+        "@actions/github": "^5.1.1"
       }
     },
     "node_modules/@actions/core": {
-      "version": "1.8.2",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.8.2.tgz",
-      "integrity": "sha512-FXcBL7nyik8K5ODeCKlxi+vts7torOkoDAKfeh61EAkAy1HAvwn9uVzZBY0f15YcQTcZZ2/iSGBFHEuioZWfDA==",
+      "version": "1.10.0",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.0.tgz",
+      "integrity": "sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==",
       "dependencies": {
-        "@actions/http-client": "^2.0.1"
+        "@actions/http-client": "^2.0.1",
+        "uuid": "^8.3.2"
       }
     },
     "node_modules/@actions/github": {
-      "version": "5.0.3",
-      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.0.3.tgz",
-      "integrity": "sha512-myjA/pdLQfhUGLtRZC/J4L1RXOG4o6aYdiEq+zr5wVVKljzbFld+xv10k1FX6IkIJtNxbAq44BdwSNpQ015P0A==",
+      "version": "5.1.1",
+      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.1.1.tgz",
+      "integrity": "sha512-Nk59rMDoJaV+mHCOJPXuvB1zIbomlKS0dmSIqPGxd0enAXBnOfn4VWF+CGtRCwXZG9Epa54tZA7VIRlJDS8A6g==",
       "dependencies": {
         "@actions/http-client": "^2.0.1",
         "@octokit/core": "^3.6.0",
@@ -204,6 +205,14 @@
       "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-6.0.0.tgz",
       "integrity": "sha512-isyNax3wXoKaulPDZWHQqbmIx1k2tb9fb3GGDBRxCscfYV2Ch7WxPArBsFEG8s/safwXTT7H4QGhaIkTp9447w=="
     },
+    "node_modules/uuid": {
+      "version": "8.3.2",
+      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
+      "bin": {
+        "uuid": "dist/bin/uuid"
+      }
+    },
     "node_modules/webidl-conversions": {
       "version": "3.0.1",
       "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
@@ -226,17 +235,18 @@
   },
   "dependencies": {
     "@actions/core": {
-      "version": "1.8.2",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.8.2.tgz",
-      "integrity": "sha512-FXcBL7nyik8K5ODeCKlxi+vts7torOkoDAKfeh61EAkAy1HAvwn9uVzZBY0f15YcQTcZZ2/iSGBFHEuioZWfDA==",
+      "version": "1.10.0",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.0.tgz",
+      "integrity": "sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==",
       "requires": {
-        "@actions/http-client": "^2.0.1"
+        "@actions/http-client": "^2.0.1",
+        "uuid": "^8.3.2"
       }
     },
     "@actions/github": {
-      "version": "5.0.3",
-      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.0.3.tgz",
-      "integrity": "sha512-myjA/pdLQfhUGLtRZC/J4L1RXOG4o6aYdiEq+zr5wVVKljzbFld+xv10k1FX6IkIJtNxbAq44BdwSNpQ015P0A==",
+      "version": "5.1.1",
+      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.1.1.tgz",
+      "integrity": "sha512-Nk59rMDoJaV+mHCOJPXuvB1zIbomlKS0dmSIqPGxd0enAXBnOfn4VWF+CGtRCwXZG9Epa54tZA7VIRlJDS8A6g==",
       "requires": {
         "@actions/http-client": "^2.0.1",
         "@octokit/core": "^3.6.0",
@@ -393,6 +403,11 @@
       "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-6.0.0.tgz",
       "integrity": "sha512-isyNax3wXoKaulPDZWHQqbmIx1k2tb9fb3GGDBRxCscfYV2Ch7WxPArBsFEG8s/safwXTT7H4QGhaIkTp9447w=="
     },
+    "uuid": {
+      "version": "8.3.2",
+      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="
+    },
     "webidl-conversions": {
       "version": "3.0.1",
       "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",

.github/actions/close-bot/package.json

@@ -10,7 +10,7 @@
   "author": "chris48s",
   "license": "CC0",
   "dependencies": {
-    "@actions/core": "^1.8.2",
-    "@actions/github": "^5.0.3"
+    "@actions/core": "^1.10.0",
+    "@actions/github": "^5.1.1"
   }
 }

.github/actions/core-tests/action.yml

@@ -0,0 +1,21 @@
+name: 'Core tests'
+description: 'Run core and entrypoint tests'
+runs:
+  using: 'composite'
+  steps:
+    - name: Core tests
+      if: always()
+      run: npm run test:core -- --reporter json --reporter-option 'output=reports/core.json'
+      shell: bash
+
+    - name: Entrypoint tests
+      if: always()
+      run: npm run test:entrypoint -- --reporter json --reporter-option 'output=reports/entrypoint.json'
+      shell: bash
+
+    - name: Write Markdown Summary
+      if: always()
+      run: |
+        node scripts/mocha2md.js Core reports/core.json >> $GITHUB_STEP_SUMMARY
+        node scripts/mocha2md.js Entrypoint reports/entrypoint.json >> $GITHUB_STEP_SUMMARY
+      shell: bash

.github/actions/integration-tests/action.yml

@@ -0,0 +1,20 @@
+name: 'Integration tests'
+description: 'Run integration tests'
+inputs:
+  github-token:
+    description: 'The GITHUB_TOKEN secret'
+    required: true
+runs:
+  using: 'composite'
+  steps:
+    - name: Integration Tests
+      if: always()
+      run: npm run test:integration -- --reporter json --reporter-option 'output=reports/integration-tests.json'
+      env:
+        GH_TOKEN: '${{ inputs.github-token }}'
+      shell: bash
+
+    - name: Write Markdown Summary
+      if: always()
+      run: node scripts/mocha2md.js Integration reports/integration-tests.json >> $GITHUB_STEP_SUMMARY
+      shell: bash

.github/actions/package-tests/action.yml

@@ -0,0 +1,26 @@
+name: 'Package tests'
+description: 'Run package tests and check types'
+runs:
+  using: 'composite'
+  steps:
+    - name: Tests
+      if: always()
+      run: npm run test:package -- --reporter json --reporter-option 'output=reports/package-tests.json'
+      shell: bash
+
+    - name: Type Checks
+      if: always()
+      run: |
+        set -o pipefail
+        npm run check-types:package 2>&1 | tee reports/package-types.txt
+      shell: bash
+
+    - name: Write Markdown Summary
+      if: always()
+      run: |
+        node scripts/mocha2md.js 'Package Tests' reports/package-tests.json >> $GITHUB_STEP_SUMMARY
+        echo '# Package Types' >> $GITHUB_STEP_SUMMARY
+        echo '```' >> $GITHUB_STEP_SUMMARY
+        cat reports/package-types.txt >> $GITHUB_STEP_SUMMARY
+        echo '```' >> $GITHUB_STEP_SUMMARY
+      shell: bash

.github/actions/setup/action.yml

@@ -0,0 +1,25 @@
+name: 'Set up project'
+description: 'Set up project'
+inputs:
+  node-version:
+    description: 'Version Spec of the version to use. Examples: 12.x, 10.15.1, >=10.15.0.'
+    required: true
+  cypress:
+    description: 'Install Cypress binary: 0 or 1'
+    # https://docs.cypress.io/guides/getting-started/installing-cypress.html#Skipping-installation
+    # We don't need to install the Cypress binary in jobs that aren't actually running Cypress.
+    required: false
+    default: 0
+runs:
+  using: 'composite'
+  steps:
+    - name: Install Node JS ${{ inputs.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ inputs.node-version }}
+
+    - name: Install dependencies
+      env:
+        CYPRESS_INSTALL_BINARY: ${{ inputs.cypress }}
+      run: npm ci
+      shell: bash

.github/workflows/auto-close.yml

@@ -1,11 +1,13 @@
 name: Auto close
-on: pull_request_target
+on:
+  pull_request_target:
+    types: [opened]
 
 permissions:
   pull-requests: write
 
 jobs:
-  build:
+  auto-close:
     runs-on: ubuntu-latest
     if: github.actor == 'dependabot[bot]'
     steps:

.github/workflows/build-docker-image.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
 
 jobs:
-  build:
+  build-docker-image:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

.github/workflows/deploy-docs.yml

@@ -8,7 +8,7 @@ permissions:
   contents: write
 
 jobs:
-  build-and-deploy:
+  deploy-docs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

.github/workflows/draft-release.yml

@@ -10,7 +10,7 @@ permissions:
   contents: write
 
 jobs:
-  build:
+  draft-release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

.github/workflows/enforce-dependency-review.yml

@@ -1,11 +1,13 @@
 name: 'Dependency Review'
-on: [pull_request]
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
 
 jobs:
-  dependency-review:
+  enforce-dependency-review:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
         uses: actions/checkout@v3
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v1
+        uses: actions/dependency-review-action@v2

.github/workflows/publish-docker-next.yml

@@ -5,7 +5,7 @@ on:
       - master
 
 jobs:
-  build:
+  publish-docker-next:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

.github/workflows/test-integration-17.yml

@@ -0,0 +1,47 @@
+name: Integration@node 17
+on:
+  pull_request:
+  push:
+    branches-ignore:
+      - 'gh-pages'
+      - 'dependabot/**'
+
+jobs:
+  test-integration-17:
+    runs-on: ubuntu-latest
+    env:
+      PAT_EXISTS: ${{ secrets.GH_PAT != '' }}
+
+    services:
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node-version: 17
+        env:
+          NPM_CONFIG_ENGINE_STRICT: 'false'
+
+      - name: Integration Tests (with PAT)
+        if: ${{ env.PAT_EXISTS == 'true' }}
+        uses: ./.github/actions/integration-tests
+        with:
+          github-token: '${{ secrets.GH_PAT }}'
+
+      - name: Integration Tests (with workflow token)
+        if: ${{ env.PAT_EXISTS == 'false' }}
+        uses: ./.github/actions/integration-tests
+        with:
+          github-token: '${{ secrets.GITHUB_TOKEN }}'

.github/workflows/test-integration.yml

@@ -0,0 +1,45 @@
+name: Integration
+on:
+  pull_request:
+  push:
+    branches-ignore:
+      - 'gh-pages'
+      - 'dependabot/**'
+
+jobs:
+  test-integration:
+    runs-on: ubuntu-latest
+    env:
+      PAT_EXISTS: ${{ secrets.GH_PAT != '' }}
+
+    services:
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node-version: 16
+
+      - name: Integration Tests (with PAT)
+        if: ${{ env.PAT_EXISTS == 'true' }}
+        uses: ./.github/actions/integration-tests
+        with:
+          github-token: '${{ secrets.GH_PAT }}'
+
+      - name: Integration Tests (with workflow token)
+        if: ${{ env.PAT_EXISTS == 'false' }}
+        uses: ./.github/actions/integration-tests
+        with:
+          github-token: '${{ secrets.GITHUB_TOKEN }}'

.github/workflows/test-lint.yml

@@ -0,0 +1,27 @@
+name: Lint
+on:
+  pull_request:
+  push:
+    branches-ignore:
+      - 'gh-pages'
+      - 'dependabot/**'
+
+jobs:
+  test-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node-version: 16
+
+      - name: ESLint
+        if: always()
+        run: npm run lint
+
+      - name: 'Prettier check (quick fix: `npm run prettier`)'
+        if: always()
+        run: npm run prettier:check

.github/workflows/test-main-17.yml

@@ -0,0 +1,24 @@
+name: Main@node 17
+on:
+  pull_request:
+  push:
+    branches-ignore:
+      - 'gh-pages'
+      - 'dependabot/**'
+
+jobs:
+  test-main-17:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node-version: 17
+        env:
+          NPM_CONFIG_ENGINE_STRICT: 'false'
+
+      - name: Core tests
+        uses: ./.github/actions/core-tests

.github/workflows/test-main.yml

@@ -0,0 +1,27 @@
+name: Main
+on:
+  pull_request:
+  push:
+    branches-ignore:
+      - 'gh-pages'
+      - 'dependabot/**'
+
+jobs:
+  test-main:
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'windows-latest']
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node-version: 16
+
+      - name: Core tests
+        uses: ./.github/actions/core-tests

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

@@ -0,0 +1,45 @@
+name: Package CLI
+on:
+  pull_request:
+  push:
+    branches-ignore:
+      - 'gh-pages'
+      - 'dependabot/**'
+
+# Smoke test (render a badge with the CLI) with only the package
+# dependencies installed.
+
+jobs:
+  test-package-cli:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - node: '14'
+            engine-strict: 'false'
+          - node: '16'
+            engine-strict: 'false'
+          - node: '18'
+            engine-strict: 'true'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Node JS ${{ inputs.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install dependencies
+        env:
+          CYPRESS_INSTALL_BINARY: 0
+          NPM_CONFIG_ENGINE_STRICT: ${{ matrix.engine-strict }}
+        run: |
+          cd badge-maker
+          npm install
+          npm link
+
+      - name: Render a badge with the CLI
+        run: |
+          cd badge-maker
+          badge cactus grown :green @flat

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

@@ -0,0 +1,33 @@
+name: Package Library
+on:
+  pull_request:
+  push:
+    branches-ignore:
+      - 'gh-pages'
+      - 'dependabot/**'
+
+jobs:
+  test-package-lib:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - node: '14'
+            engine-strict: 'false'
+          - node: '16'
+            engine-strict: 'true'
+          - node: '18'
+            engine-strict: 'false'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          node-version: ${{ matrix.node }}
+        env:
+          NPM_CONFIG_ENGINE_STRICT: ${{ matrix.engine-strict }}
+
+      - name: Package tests
+        uses: ./.github/actions/package-tests

CHANGELOG.md

@@ -4,6 +4,66 @@ Note: this changelog is for the shields.io server. The changelog for the badge-m
 
 ---
 
+## server-2022-10-08
+
+- deprecate [criterion] service [#8501](https://github.com/badges/shields/issues/8501)
+- fix formatRelativeDate error handling; run [date] [#8497](https://github.com/badges/shields/issues/8497)
+- allow/validate bitbucket_username / bitbucket_password in private config schema [#8472](https://github.com/badges/shields/issues/8472)
+- fix [pub] points badge test and example [#8498](https://github.com/badges/shields/issues/8498)
+- feat: add [GitlabLanguageCount] service [#8377](https://github.com/badges/shields/issues/8377)
+- [GitHubGistStars] add GitHub Gist Stars [#8471](https://github.com/badges/shields/issues/8471)
+- fix display/search of CII badge examples [#8473](https://github.com/badges/shields/issues/8473)
+- feat: add 2022 support to GitHub Hacktoberfest [#8468](https://github.com/badges/shields/issues/8468)
+- fix [GitLabCoverage] subgroup bug [#8401](https://github.com/badges/shields/issues/8401)
+- implement ruby gems-specific version sort/color functions [#8434](https://github.com/badges/shields/issues/8434)
+- Add `rc` to pre-release identifiers [#8435](https://github.com/badges/shields/issues/8435)
+- add [GitHub] Number of commits between branches/tags/commits [#8394](https://github.com/badges/shields/issues/8394)
+- add [Packagist] dependency version [#8371](https://github.com/badges/shields/issues/8371)
+- fix Docker build status invalid response data bug [#8392](https://github.com/badges/shields/issues/8392)
+- Dependency updates
+
+## server-2022-09-04
+
+- fix frontend compile for users running on Windows [#8350](https://github.com/badges/shields/issues/8350)
+- [DockerSize] Docker image size multi arch [#8290](https://github.com/badges/shields/issues/8290)
+- upgrade gatsby [#8334](https://github.com/badges/shields/issues/8334)
+- Custom domains for [JitPack] artifacts [#8333](https://github.com/badges/shields/issues/8333)
+- fix [dockerstars] service [#8316](https://github.com/badges/shields/issues/8316)
+- [BountySource] Fix: Broken Badge generation for decimal activity values [#8315](https://github.com/badges/shields/issues/8315)
+- feat: add [gitlabmergerequests] service [#8166](https://github.com/badges/shields/issues/8166)
+- Fix terminology for [ROS] version service [#8292](https://github.com/badges/shields/issues/8292)
+- feat: add [GitlabStars] service [#8209](https://github.com/badges/shields/issues/8209)
+- Fix invalid `rst` format when `alt` or `target` is present [#8275](https://github.com/badges/shields/issues/8275)
+- [GithubGistLastCommit] GitHub gist last commit [#8272](https://github.com/badges/shields/issues/8272)
+- [GitHub] GitHub file size for a specific branch [#8262](https://github.com/badges/shields/issues/8262)
+- Dependency updates
+
+## server-2022-08-01
+
+- [pypi] Add Framework Version Badges support [#8261](https://github.com/badges/shields/issues/8261)
+- feat: add [GitlabForks] server [#8208](https://github.com/badges/shields/issues/8208)
+- Update PyPI api according to https://warehouse.pypa.io/api-reference/json.html [#8251](https://github.com/badges/shields/issues/8251)
+- Add [galaxytoolshed] Activity [#8164](https://github.com/badges/shields/issues/8164)
+- [greasyfork] Add Greasy Fork rating badges [#8087](https://github.com/badges/shields/issues/8087)
+- refactor(deps): Replace moment with dayjs [#8192](https://github.com/badges/shields/issues/8192)
+- add spaces round pipe in [conda] badge [#8189](https://github.com/badges/shields/issues/8189)
+- Add [ROS] version service [#8169](https://github.com/badges/shields/issues/8169)
+- feat: add [gitlabissues] service [#8108](https://github.com/badges/shields/issues/8108)
+- Dependency updates
+
+## server-2022-07-03
+
+- Add [galaxytoolshed] services [#8114](https://github.com/badges/shields/issues/8114)
+- fix [gitlab] auth [#8145](https://github.com/badges/shields/issues/8145) [#8162](https://github.com/badges/shields/issues/8162)
+- increase cache length on AUR version badge, run [AUR] [#8110](https://github.com/badges/shields/issues/8110)
+- Use GraphQL to fix GitHub file count badges [github] [#8112](https://github.com/badges/shields/issues/8112)
+- feat: add [gitlab] contributors service [#8084](https://github.com/badges/shields/issues/8084)
+- [greasyfork] Add Greasy Fork service badges [#8080](https://github.com/badges/shields/issues/8080)
+- Add [gitlablicense] services [#8024](https://github.com/badges/shields/issues/8024)
+- [Spack] Package Manager: Update Domain [#8046](https://github.com/badges/shields/issues/8046)
+- switch [jitpack] to use latestOk endpoint [#8041](https://github.com/badges/shields/issues/8041)
+- Dependency updates
+
 ## server-2022-06-01
 
 - Update GitLab logo (2022) [#7984](https://github.com/badges/shields/issues/7984)

CONTRIBUTING.md

@@ -134,7 +134,7 @@ Prettier before a commit by default.
 When adding or changing a service [please write tests][service-tests], and ensure the [title of your Pull Requests follows the required conventions](#running-service-tests-in-pull-requests) to ensure your tests are executed.
 When changing other code, please add unit tests.
 
-To run the integration tests, you must have redis installed and in your PATH.
+To run the integration tests, you must have Redis installed and in your PATH.
 Use `brew install redis`, `yum install redis`, etc. The test runner will
 start the server automatically.
 

app.json

@@ -35,6 +35,16 @@
     "WEBLATE_API_KEY": {
       "description": "Configure the API key to be used for the Weblate service.",
       "required": false
+    },
+    "METRICS_INFLUX_ENABLED": {
+      "description": "Disable influx metrics",
+      "value": "false",
+      "required": false
+    },
+    "REQUIRE_CLOUDFLARE": {
+      "description": "Allow direct traffic",
+      "value": "false",
+      "required": false
     }
   },
   "formation": {

badge-maker/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 4.0.0 [WIP]
 
-- Drop compatibility with Node 10
+- Drop compatibility with Node < 14
 
 ## 3.3.1
 

badge-maker/package.json

@@ -26,7 +26,7 @@
     "badge": "lib/badge-cli.js"
   },
   "engines": {
-    "node": ">= 12",
+    "node": ">= 14",
     "npm": ">= 6"
   },
   "collective": {

core/base-service/loader.js

@@ -13,6 +13,13 @@ const serviceDir = path.join(
   'services'
 )
 
+function toUnixPath(path) {
+  // glob does not allow \ as a path separator
+  // see https://github.com/isaacs/node-glob/blob/main/changelog.md#80
+  // so we need to convert to use / for use with glob
+  return path.replace(/\\/g, '/')
+}
+
 class InvalidService extends Error {
   constructor(message) {
     super(message)
@@ -22,7 +29,9 @@ class InvalidService extends Error {
 
 async function loadServiceClasses(servicePaths) {
   if (!servicePaths) {
-    servicePaths = glob.sync(path.join(serviceDir, '**', '*.service.js'))
+    servicePaths = glob.sync(
+      toUnixPath(path.join(serviceDir, '**', '*.service.js'))
+    )
   }
 
   const serviceClasses = []
@@ -42,8 +51,8 @@ async function loadServiceClasses(servicePaths) {
       if (serviceClass && serviceClass.prototype instanceof BaseService) {
         // Decorate each service class with the directory that contains it.
         serviceClass.serviceFamily = servicePath
-          .replace(serviceDir, '')
-          .split(path.sep)[1]
+          .replace(toUnixPath(serviceDir), '')
+          .split('/')[1]
         serviceClass.validateDefinition()
         return serviceClasses.push(serviceClass)
       }

core/server/server.js

@@ -169,6 +169,8 @@ const privateConfigSchema = Joi.object({
   jenkins_pass: Joi.string(),
   jira_user: Joi.string(),
   jira_pass: Joi.string(),
+  bitbucket_username: Joi.string(),
+  bitbucket_password: Joi.string(),
   bitbucket_server_username: Joi.string(),
   bitbucket_server_password: Joi.string(),
   librariesio_tokens: Joi.arrayFromString().items(Joi.string()),

core/service-test-runner/infer-pull-request.js

@@ -59,7 +59,9 @@ function _inferPullRequestFromTravisEnv(env) {
 }
 
 function _inferPullRequestFromCircleEnv(env) {
-  return parseGithubPullRequestUrl(env.CI_PULL_REQUEST)
+  return parseGithubPullRequestUrl(
+    env.CI_PULL_REQUEST || env.CIRCLE_PULL_REQUEST
+  )
 }
 
 /**

cypress.config.js

@@ -0,0 +1,13 @@
+import { defineConfig } from 'cypress'
+
+export default defineConfig({
+  fixturesFolder: false,
+  env: {
+    backend_url: 'http://localhost:8080',
+  },
+  e2e: {
+    setupNodeEvents(on, config) {},
+    baseUrl: 'http://localhost:3000',
+    supportFile: false,
+  },
+})

cypress.json

@@ -1,9 +0,0 @@
-{
-  "baseUrl": "http://localhost:3000",
-  "fixturesFolder": false,
-  "pluginsFile": false,
-  "supportFile": false,
-  "env": {
-    "backend_url": "http://localhost:8080"
-  }
-}

cypress/e2e/main-page.cy.js

@@ -1,3 +1,7 @@
+import { registerCommand } from 'cypress-wait-for-stable-dom'
+
+registerCommand()
+
 describe('Main page', function () {
   const backendUrl = Cypress.env('backend_url')
   const SEARCH_INPUT = 'input[placeholder="search / project URL"]'
@@ -9,8 +13,13 @@ describe('Main page', function () {
       .should('have.attr', 'src', previewUrl)
   }
 
+  function visitAndWait(page) {
+    cy.visit(page)
+    cy.waitForStableDOM({ pollInterval: 1000, timeout: 10000 })
+  }
+
   it('Search for badges', function () {
-    cy.visit('/')
+    visitAndWait('/')
 
     cy.get(SEARCH_INPUT).type('pypi')
 
@@ -18,7 +27,7 @@ describe('Main page', function () {
   })
 
   it('Shows badge from category', function () {
-    cy.visit('/category/chat')
+    visitAndWait('/category/chat')
 
     expectBadgeExample(
       'Discourse status',
@@ -29,7 +38,7 @@ describe('Main page', function () {
 
   it('Suggest badges', function () {
     const badgeUrl = `${backendUrl}/github/issues/badges/shields`
-    cy.visit('/')
+    visitAndWait('/')
 
     cy.get(SEARCH_INPUT).type('https://github.com/badges/shields')
     cy.contains('Suggest badges').click()
@@ -39,7 +48,7 @@ describe('Main page', function () {
 
   it('Customization form is filled with suggested badge details', function () {
     const badgeUrl = `${backendUrl}/github/issues/badges/shields`
-    cy.visit('/')
+    visitAndWait('/')
     cy.get(SEARCH_INPUT).type('https://github.com/badges/shields')
     cy.contains('Suggest badges').click()
 
@@ -51,7 +60,7 @@ describe('Main page', function () {
 
   it('Customizate suggested badge', function () {
     const badgeUrl = `${backendUrl}/github/issues/badges/shields`
-    cy.visit('/')
+    visitAndWait('/')
     cy.get(SEARCH_INPUT).type('https://github.com/badges/shields')
     cy.contains('Suggest badges').click()
     cy.contains(badgeUrl).click()
@@ -62,7 +71,7 @@ describe('Main page', function () {
   })
 
   it('Do not duplicate example parameters', function () {
-    cy.visit('/category/funding')
+    visitAndWait('/category/funding')
 
     cy.contains('GitHub Sponsors').click()
     cy.get('[name="style"]').should($style => {

dangerfile.js

@@ -114,7 +114,7 @@ if (allFiles.length > 100) {
       if (diff.includes('authHelper') && !secretsDocs.modified) {
         warn(
           [
-            `:books: Remember to ensure any changes to \`config.private\` `,
+            ':books: Remember to ensure any changes to `config.private` ',
             `in \`${file}\` are reflected in the [server secrets documentation]`,
             '(https://github.com/badges/shields/blob/master/doc/server-secrets.md)',
           ].join('')

doc/badge-urls.md

@@ -3,6 +3,9 @@
 - The format of new badges should be of the form `/SERVICE/NOUN/PARAMETERS?QUERYSTRING` e.g:
   `/github/issues/:user/:repo`. The service is github, the
   badge is for issues, and the parameters are `:user/:repo`.
+- The `NOUN` part of the route is:
+  - singular if the badge message represents a single entity, such as the current status of a build (e.g: `/build`), or a more abstract or aggregate representation of the thing (e.g.: `/coverage`, `/quality`)
+  - plural if there are (or may) be many of the thing (e.g: `/dependencies`, `/stars`)
 - Parameters should always be part of the route if they are required to display a badge e.g: `:packageName`.
 - Common optional params like, `:branch` or `:tag` should also be passed as part of the route.
 - Query string parameters should be used when:

doc/code-walkthrough.md

@@ -58,7 +58,7 @@ The tests are also divided into several parts:
 [redis-token-persistence.integration]: https://github.com/badges/shields/blob/master/core/token-pooling/redis-token-persistence.integration.js
 [github-api-provider.integration]: https://github.com/badges/shields/blob/master/services/github/github-api-provider.integration.js
 
-Our goal is for the core code is to reach 100% coverage of the code in the
+Our goal is to reach 100% coverage of the code in the
 frontend, core, and service helper functions when the unit and functional
 tests are run.
 
@@ -95,7 +95,7 @@ test this kind of logic through unit tests (e.g. of `render()` and
     callback with the four parameters `( queryParams, match, end, ask )` which
     is created in a legacy helper function in
     [`legacy-request-handler.js`][legacy-request-handler]. This callback
-    delegates to a callback in `BaseService.register` with four different
+    delegates to a callback in `BaseService.register` with three different
     parameters `( queryParams, match, sendBadge )`, which
     then runs `BaseService.invoke`. `BaseService.invoke` instantiates the
     service and runs `BaseService#handle`.

doc/service-tests.md

@@ -67,7 +67,7 @@ t.create('Build status')
    - All badges on shields can be requested in a number of formats. As well as calling https://img.shields.io/wercker/build/wercker/go-wercker-api.svg to generate ![](https://img.shields.io/wercker/build/wercker/go-wercker-api.svg) we can also call https://img.shields.io/wercker/build/wercker/go-wercker-api.json to request the same content as JSON. When writing service tests, we request the badge in JSON format so it is easier to make assertions about the content.
    - We don't need to explicitly call `/wercker/build/wercker/go-wercker-api.json` here, only `/build/wercker/go-wercker-api.json`. When we create a tester object with `createServiceTester()` the URL base defined in our service class (in this case `/wercker`) is used as the base URL for any requests made by the tester object.
 3. `expectBadge()` is a helper function which accepts either a string literal, a [RegExp][] or a [Joi][] schema for the different fields.
-   Joi is a validation library that is build into IcedFrisby which you can use to
+   Joi is a validation library that is built into IcedFrisby which you can use to
    match based on a set of allowed strings, regexes, or specific values. You can
    refer to their [API reference][joi api].
 4. We expect `label` to be a string literal `"build"`.

frontend/lib/generate-image-markup.spec.ts

@@ -51,14 +51,14 @@ test(reStructuredText, () => {
     '.. image:: https://img.shields.io/badge'
   )
   given('https://img.shields.io/badge', undefined, 'Example').expect(
-    '.. image:: https://img.shields.io/badge   :alt: Example'
+    '.. image:: https://img.shields.io/badge\n   :alt: Example'
   )
   given(
     'https://img.shields.io/badge',
     'https://example.com/example',
     'Example'
   ).expect(
-    '.. image:: https://img.shields.io/badge   :alt: Example   :target: https://example.com/example'
+    '.. image:: https://img.shields.io/badge\n   :alt: Example\n   :target: https://example.com/example'
   )
 })
 

frontend/lib/generate-image-markup.ts

@@ -33,10 +33,10 @@ export function reStructuredText(
 ): string {
   let result = `.. image:: ${badgeUrl}`
   if (title) {
-    result += `   :alt: ${title}`
+    result += `\n   :alt: ${title}`
   }
   if (link) {
-    result += `   :target: ${link}`
+    result += `\n   :target: ${link}`
   }
   return result
 }

frontend/pages/endpoint.tsx

@@ -134,7 +134,7 @@ export default function EndpointPage(): JSX.Element {
         </p>
         <p>
           The endpoint badge is a better alternative than redirecting to the
-          static badge enpoint or generating SVG on your server:
+          static badge endpoint or generating SVG on your server:
         </p>
         <ol>
           <li>
@@ -142,7 +142,7 @@ export default function EndpointPage(): JSX.Element {
               Content and presentation are separate.
             </a>{' '}
             The service provider authors the badge, and Shields takes input from
-            the user to format it. As a service provider you author the badge
+            the user to format it. As a service provider, you author the badge
             but don't have to concern yourself with styling. You don't even have
             to pass the formatting options through to Shields.
           </li>
@@ -152,12 +152,12 @@ export default function EndpointPage(): JSX.Element {
           </li>
           <li>
             A JSON response is easy to implement; easier than an HTTP redirect.
-            It is trivial in almost any framework, and is more compatible with
+            It is trivial in almost any framework and is more compatible with
             hosting environments such as{' '}
             <a href="https://runkit.com/docs/endpoint">RunKit endpoints</a>.
           </li>
           <li>
-            As a service provider you can rely on the Shields CDN. There's no
+            As a service provider, you can rely on the Shields CDN. There's no
             need to study the HTTP headers. Adjusting cache behavior is as
             simple as setting a property in the JSON response.
           </li>
@@ -197,7 +197,7 @@ export default function EndpointPage(): JSX.Element {
         <dd>
           Default: <code>false</code>. <code>true</code> to treat this as an
           error badge. This prevents the user from overriding the color. In the
-          future it may affect cache behavior.
+          future, it may affect cache behavior.
         </dd>
         <dt>namedLogo</dt>
         <dd>

lib/load-simple-icons.js

@@ -1,4 +1,4 @@
-import originalSimpleIcons from 'simple-icons'
+import * as originalSimpleIcons from 'simple-icons/icons'
 import { svg2base64 } from './svg-helpers.js'
 
 function loadSimpleIcons() {
@@ -14,26 +14,29 @@ function loadSimpleIcons() {
   // https://github.com/badges/shields/issues/4273
   Object.keys(originalSimpleIcons).forEach(key => {
     const icon = originalSimpleIcons[key]
-    const title = icon.title.toLowerCase()
-    const legacyTitle = title.replace(/ /g, '-')
+    const { title, slug, hex } = icon
+
     icon.base64 = {
-      default: svg2base64(icon.svg.replace('<svg', `<svg fill="#${icon.hex}"`)),
-      light: svg2base64(icon.svg.replace('<svg', `<svg fill="whitesmoke"`)),
-      dark: svg2base64(icon.svg.replace('<svg', `<svg fill="#333"`)),
+      default: svg2base64(icon.svg.replace('<svg', `<svg fill="#${hex}"`)),
+      light: svg2base64(icon.svg.replace('<svg', '<svg fill="whitesmoke"')),
+      dark: svg2base64(icon.svg.replace('<svg', '<svg fill="#333"')),
     }
 
     // There are a few instances where multiple icons have the same title
     // (e.g. 'Hive'). If a by-title reference we generate for
     // backwards compatibility collides with a proper slug from Simple Icons
     // then do nothing, so that the proper slug will always map to the correct icon.
-    if (!(title in originalSimpleIcons)) {
-      simpleIcons[title] = icon
+    // Starting in v7, the exported object with the full icon set has updated the keys
+    // to include a lowercase `si` prefix, and utilizes proper case naming conventions.
+    if (!(`si${title}` in originalSimpleIcons)) {
+      simpleIcons[title.toLowerCase()] = icon
     }
-    if (!(legacyTitle in originalSimpleIcons)) {
-      simpleIcons[legacyTitle] = icon
+    const legacyTitle = title.replace(/ /g, '-')
+    if (!(`si${legacyTitle}` in originalSimpleIcons)) {
+      simpleIcons[legacyTitle.toLowerCase()] = icon
     }
 
-    simpleIcons[key] = icon
+    simpleIcons[slug] = icon
   })
   return simpleIcons
 }

lib/logos.spec.js

@@ -33,7 +33,7 @@ describe('Logo helpers', function () {
   test(prepareNamedLogo, () => {
     // NPM uses multiple colors so the color param should be ignored
     const npmLogo =
-      'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZD0iTTAgMGg0MHY0MEgwVjB6IiBmaWxsPSIjY2IwMDAwIi8+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTcgN2gyNnYyNmgtN1YxNGgtNnYxOUg3eiIvPjwvc3ZnPgo='
+      'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZD0iTTAgMGg0MHY0MEgwVjB6IiBmaWxsPSIjY2IwMDAwIi8+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTcgN2gyNnYyNmgtN1YxNGgtNnYxOUg3eiIvPjwvc3ZnPg=='
     given({ name: 'npm' }).expect(npmLogo)
     given({ name: 'npm', color: 'blue' }).expect(npmLogo)
 
@@ -115,7 +115,7 @@ describe('Logo helpers', function () {
       undefined
     )
     given('npm', {}).expect(
-      'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZD0iTTAgMGg0MHY0MEgwVjB6IiBmaWxsPSIjY2IwMDAwIi8+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTcgN2gyNnYyNmgtN1YxNGgtNnYxOUg3eiIvPjwvc3ZnPgo='
+      'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZD0iTTAgMGg0MHY0MEgwVjB6IiBmaWxsPSIjY2IwMDAwIi8+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTcgN2gyNnYyNmgtN1YxNGgtNnYxOUg3eiIvPjwvc3ZnPg=='
     )
   })
 })

lib/svg-helpers.js

@@ -1,5 +1,7 @@
 function svg2base64(svg) {
-  return `data:image/svg+xml;base64,${Buffer.from(svg).toString('base64')}`
+  return `data:image/svg+xml;base64,${Buffer.from(svg.trim()).toString(
+    'base64'
+  )}`
 }
 
 export { svg2base64 }

package.json

@@ -21,47 +21,48 @@
     "url": "https://github.com/badges/shields"
   },
   "dependencies": {
-    "@fontsource/lato": "^4.5.8",
-    "@fontsource/lekton": "^4.5.9",
+    "@fontsource/lato": "^4.5.10",
+    "@fontsource/lekton": "^4.5.11",
     "@renovate/pep440": "^1.0.0",
-    "@sentry/node": "^6.19.7",
+    "@renovatebot/ruby-semver": "^1.1.6",
+    "@sentry/node": "^7.15.0",
     "@shields_io/camp": "^18.1.1",
     "badge-maker": "file:badge-maker",
     "bytes": "^3.1.2",
-    "camelcase": "^6.3.0",
-    "chalk": "^5.0.1",
+    "camelcase": "^7.0.0",
+    "chalk": "^5.1.2",
     "check-node-version": "^4.2.1",
     "cloudflare-middleware": "^1.0.4",
-    "config": "^3.3.7",
+    "config": "^3.3.8",
     "cross-env": "^7.0.3",
+    "dayjs": "^1.11.5",
     "decamelize": "^3.2.0",
     "emojic": "^1.1.17",
     "escape-string-regexp": "^4.0.0",
-    "fast-xml-parser": "^4.0.7",
+    "fast-xml-parser": "^4.0.11",
     "glob": "^8.0.3",
     "global-agent": "^3.0.0",
-    "got": "^12.1.0",
+    "got": "^12.5.2",
     "graphql": "^15.6.1",
     "graphql-tag": "^2.12.6",
-    "ioredis": "5.0.5",
-    "joi": "17.6.0",
+    "ioredis": "5.2.3",
+    "joi": "17.6.3",
     "joi-extension-semver": "5.0.0",
     "js-yaml": "^4.1.0",
     "jsonpath": "~1.1.1",
     "lodash.countby": "^4.6.0",
     "lodash.groupby": "^4.6.0",
     "lodash.times": "^4.3.2",
-    "moment": "^2.29.3",
     "node-env-flag": "^0.1.0",
     "parse-link-header": "^2.0.0",
     "path-to-regexp": "^6.2.1",
     "pretty-bytes": "^6.0.0",
     "priorityqueuejs": "^2.0.0",
-    "prom-client": "^14.0.1",
-    "qs": "^6.10.3",
+    "prom-client": "^14.1.0",
+    "qs": "^6.11.0",
     "query-string": "^7.1.1",
-    "semver": "~7.3.7",
-    "simple-icons": "6.23.0",
+    "semver": "~7.3.8",
+    "simple-icons": "7.15.0",
     "webextension-store-meta": "^1.0.5",
     "xmldom": "~0.6.0",
     "xpath": "~0.0.32"
@@ -141,12 +142,12 @@
     ]
   },
   "devDependencies": {
-    "@babel/core": "^7.18.2",
+    "@babel/core": "^7.19.3",
     "@babel/polyfill": "^7.12.1",
-    "@babel/register": "7.17.7",
+    "@babel/register": "7.18.9",
     "@istanbuljs/schema": "^0.1.3",
     "@mapbox/react-click-to-select": "^2.2.1",
-    "@types/chai": "^4.3.1",
+    "@types/chai": "^4.3.3",
     "@types/lodash.debounce": "^4.0.7",
     "@types/lodash.groupby": "^4.6.7",
     "@types/mocha": "^9.1.1",
@@ -154,12 +155,12 @@
     "@types/react-helmet": "^6.1.5",
     "@types/react-modal": "^3.13.1",
     "@types/react-select": "^4.0.17",
-    "@types/styled-components": "5.1.25",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^5.15.0",
+    "@types/styled-components": "5.1.26",
+    "@typescript-eslint/eslint-plugin": "^5.40.0",
+    "@typescript-eslint/parser": "^5.30.7",
     "babel-plugin-inline-react-svg": "^2.0.1",
-    "babel-preset-gatsby": "^2.14.0",
-    "c8": "^7.11.3",
+    "babel-preset-gatsby": "^2.22.0",
+    "c8": "^7.12.0",
     "caller": "^1.1.0",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
@@ -167,9 +168,10 @@
     "chai-string": "^1.4.0",
     "child-process-promise": "^2.2.1",
     "clipboard-copy": "^4.0.1",
-    "concurrently": "^7.2.1",
-    "cypress": "^9.7.0",
-    "danger": "^11.0.7",
+    "concurrently": "^7.4.0",
+    "cypress": "^10.10.0",
+    "cypress-wait-for-stable-dom": "^0.0.4",
+    "danger": "^11.1.4",
     "danger-plugin-no-test-shortcuts": "^2.0.0",
     "deepmerge": "^4.2.2",
     "eslint": "^7.32.0",
@@ -180,44 +182,44 @@
     "eslint-plugin-chai-friendly": "^0.7.2",
     "eslint-plugin-cypress": "^2.12.1",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.3.2",
-    "eslint-plugin-mocha": "^10.0.5",
+    "eslint-plugin-jsdoc": "^39.3.6",
+    "eslint-plugin-mocha": "^10.1.0",
     "eslint-plugin-no-extension-in-require": "^0.2.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.2.0",
-    "eslint-plugin-react": "^7.30.0",
-    "eslint-plugin-react-hooks": "^4.5.0",
-    "eslint-plugin-sort-class-members": "^1.14.1",
+    "eslint-plugin-react": "^7.31.10",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-sort-class-members": "^1.15.2",
     "fetch-ponyfill": "^7.1.0",
     "form-data": "^4.0.0",
-    "gatsby": "4.6.2",
-    "gatsby-plugin-catch-links": "^4.11.0",
-    "gatsby-plugin-page-creator": "^4.7.0",
-    "gatsby-plugin-react-helmet": "^5.10.0",
+    "gatsby": "4.23.1",
+    "gatsby-plugin-catch-links": "^4.19.0",
+    "gatsby-plugin-page-creator": "^4.24.0",
+    "gatsby-plugin-react-helmet": "^5.22.0",
     "gatsby-plugin-remove-trailing-slashes": "^4.9.0",
-    "gatsby-plugin-styled-components": "^5.11.0",
-    "gatsby-plugin-typescript": "^4.11.1",
+    "gatsby-plugin-styled-components": "^5.24.0",
+    "gatsby-plugin-typescript": "^4.22.0",
     "humanize-string": "^2.1.0",
     "icedfrisby": "4.0.0",
     "icedfrisby-nock": "^2.1.0",
     "is-svg": "^4.3.2",
     "js-yaml-loader": "^1.2.2",
-    "jsdoc": "^3.6.10",
-    "lint-staged": "^12.4.2",
+    "jsdoc": "^3.6.11",
+    "lint-staged": "^13.0.3",
     "lodash.debounce": "^4.0.8",
     "lodash.difference": "^4.5.0",
-    "minimist": "^1.2.6",
+    "minimist": "^1.2.7",
     "mocha": "^9.2.2",
     "mocha-env-reporter": "^4.0.0",
-    "mocha-junit-reporter": "^2.0.2",
+    "mocha-junit-reporter": "^2.1.0",
     "mocha-yaml-loader": "^1.0.3",
-    "nock": "13.2.4",
+    "nock": "13.2.9",
     "node-mocks-http": "^1.11.0",
-    "nodemon": "^2.0.16",
+    "nodemon": "^2.0.20",
     "npm-run-all": "^4.1.5",
-    "open-cli": "^7.0.1",
-    "portfinder": "^1.0.28",
-    "prettier": "2.6.2",
+    "open-cli": "^7.1.0",
+    "portfinder": "^1.0.32",
+    "prettier": "2.7.1",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-error-overlay": "^6.0.11",
@@ -229,19 +231,19 @@
     "redis-server": "^1.2.2",
     "rimraf": "^3.0.2",
     "sazerac": "^2.0.0",
-    "simple-git-hooks": "^2.7.0",
-    "sinon": "^14.0.0",
+    "simple-git-hooks": "^2.8.0",
+    "sinon": "^14.0.1",
     "sinon-chai": "^3.7.0",
     "snap-shot-it": "^7.9.6",
     "start-server-and-test": "1.14.0",
-    "styled-components": "^5.3.5",
+    "styled-components": "^5.3.6",
     "ts-mocha": "^10.0.0",
-    "tsd": "^0.20.0",
-    "typescript": "^4.7.2",
+    "tsd": "^0.24.1",
+    "typescript": "^4.8.4",
     "url": "^0.11.0"
   },
   "engines": {
-    "node": ">=16.13.0",
+    "node": "^16.13.0",
     "npm": ">=8.0.0"
   },
   "type": "module",

scripts/capture-timings.js

@@ -29,7 +29,7 @@ async function captureTimings(warmupIterations) {
 function logResults({ times, iterations, warmupIterations }) {
   if (isNaN(iterations)) {
     console.log(
-      `No timings captured. Have you included console.time statements in the badge creation code path?`
+      'No timings captured. Have you included console.time statements in the badge creation code path?'
     )
   } else {
     const timedIterations = iterations - warmupIterations

scripts/mocha2md.js

@@ -0,0 +1,36 @@
+import fs from 'fs'
+
+let data
+let title
+
+try {
+  if (process.argv.length < 4) {
+    throw new Error()
+  }
+  title = process.argv[2]
+  data = JSON.parse(fs.readFileSync(process.argv[3]))
+} catch (e) {
+  process.stdout.write('failed to write summary\n')
+  process.exit(1)
+}
+
+process.stdout.write(`# ${title}\n\n`)
+
+if (data.stats.passes > 0) {
+  process.stdout.write(`✔ ${data.stats.passes} passed\n`)
+}
+if (data.stats.failures > 0) {
+  process.stdout.write(`✖ ${data.stats.failures} failed\n\n`)
+}
+
+if (data.stats.failures > 0) {
+  for (const test of data.tests) {
+    if (test.err && Object.keys(test.err).length > 0) {
+      process.stdout.write(`### ${test.title}\n\n`)
+      process.stdout.write(`${test.fullTitle}\n\n`)
+      process.stdout.write('```\n')
+      process.stdout.write(`${test.err.stack}\n`)
+      process.stdout.write('```\n\n')
+    }
+  }
+}

scripts/run_package_tests.sh

@@ -1,34 +0,0 @@
-#!/bin/bash
-
-# https://discuss.circleci.com/t/switch-nodejs-version-on-machine-executor-solved/26675/3
-
-# Start off less strict to work around various nvm errors.
-set -e
-export NVM_DIR="/opt/circleci/.nvm"
-[ -s "$NVM_DIR/nvm.sh" ] && source "$NVM_DIR/nvm.sh"
-nvm install $NODE_VERSION
-nvm use $NODE_VERSION
-
-# Stricter.
-set -euo pipefail
-node --version
-
-# Install the shields.io dependencies.
-npm ci
-
-# Run the package tests.
-npm run test:package
-npm run check-types:package
-
-# Delete the full shields.io dependency tree
-rm -rf node_modules/
-
-
-# Run a smoke test (render a badge with the CLI) with only the package
-# dependencies installed.
-cd badge-maker
-
-npm install # install only the package dependencies for this test
-npm link
-badge cactus grown :green @flat
-rm package-lock.json && rm -rf node_modules/ # clean up package dependencies

services/aur/aur.service.js

@@ -108,9 +108,7 @@ class AurVotes extends BaseAurService {
 
 class AurVersion extends BaseAurService {
   static category = 'version'
-
   static route = { base: 'aur/version', pattern: ':packageName' }
-
   static examples = [
     {
       title: 'AUR version',
@@ -119,6 +117,8 @@ class AurVersion extends BaseAurService {
     },
   ]
 
+  static _cacheLength = 3600
+
   static render({ version, outOfDate }) {
     const color = outOfDate === null ? 'blue' : 'orange'
     return { message: addv(version), color }

services/azure-devops/azure-devops-tests.tester.js

@@ -8,7 +8,7 @@ import { createServiceTester } from '../tester.js'
 export const t = await createServiceTester()
 
 t.create('unknown build definition')
-  .get(`/swellaby/opensource/99999999.json`)
+  .get('/swellaby/opensource/99999999.json')
   .expectBadge({ label: 'tests', message: 'build pipeline not found' })
 
 t.create('404 latest build error response')
@@ -51,7 +51,7 @@ t.create('no test result summary response')
   })
 
 t.create('no build response')
-  .get(`/swellaby/opensource/174.json`)
+  .get('/swellaby/opensource/174.json')
   .expectBadge({ label: 'tests', message: 'build pipeline not found' })
 
 t.create('no tests in test result summary response')

services/bitbucket/bitbucket-pull-request.service.js

@@ -27,7 +27,7 @@ function pullRequestClassGenerator(raw) {
     static category = 'issue-tracking'
     static route = {
       base: `bitbucket/${routePrefix}`,
-      pattern: `:user/:repo`,
+      pattern: ':user/:repo',
       queryParamSchema,
     }
 

services/bitbucket/bitbucket-pull-request.tester.js

@@ -20,7 +20,7 @@ t.create('pr-raw (not found)')
 
 t.create('pr-raw (private repo)')
   .get('/pr-raw/chris48s/example-private-repo.json')
-  .expectBadge({ label: 'pull requests', message: 'private repo' })
+  .expectBadge({ label: 'pull requests', message: 'not found' })
 
 t.create('pr (valid)').get('/pr/atlassian/python-bitbucket.json').expectBadge({
   label: 'pull requests',
@@ -33,7 +33,7 @@ t.create('pr (not found)')
 
 t.create('pr (private repo)')
   .get('/pr/chris48s/example-private-repo.json')
-  .expectBadge({ label: 'pull requests', message: 'private repo' })
+  .expectBadge({ label: 'pull requests', message: 'not found' })
 
 t.create('pr (server)')
   .get('/pr/project/repo.json?server=https://bitbucket.mydomain.net')

services/bountysource/bountysource.service.js

@@ -1,9 +1,8 @@
 import Joi from 'joi'
-import { nonNegativeInteger } from '../validators.js'
 import { metric } from '../text-formatters.js'
 import { BaseJsonService } from '../index.js'
 
-const schema = Joi.object({ activity_total: nonNegativeInteger })
+const schema = Joi.object({ activity_total: Joi.number().required() })
 
 export default class Bountysource extends BaseJsonService {
   static category = 'funding'

services/bower/bower-version.tester.js

@@ -1,5 +1,7 @@
-import Joi from 'joi'
-import { isVPlusDottedVersionAtLeastOne } from '../test-validators.js'
+import {
+  isVPlusDottedVersionAtLeastOne,
+  isVPlusDottedVersionNClausesWithOptionalSuffix,
+} from '../test-validators.js'
 import { ServiceTester } from '../tester.js'
 export const t = new ServiceTester({
   id: 'BowerVersion',
@@ -7,21 +9,17 @@ export const t = new ServiceTester({
   pathPrefix: '/bower',
 })
 
-const isBowerPrereleaseVersion = Joi.string().regex(
-  /^v\d+(\.\d+)?(\.\d+)?(-?[.\w\d])+?$/
-)
-
-t.create('version').timeout(10000).get('/v/bootstrap.json').expectBadge({
+t.create('version').timeout(10000).get('/v/angular.json').expectBadge({
   label: 'bower',
   message: isVPlusDottedVersionAtLeastOne,
 })
 
-t.create('pre version') // e.g. bower|v0.2.5-alpha-rc-pre
+t.create('pre version')
   .timeout(10000)
-  .get('/v/bootstrap.json?include_prereleases')
+  .get('/v/angular.json?include_prereleases')
   .expectBadge({
     label: 'bower',
-    message: isBowerPrereleaseVersion,
+    message: isVPlusDottedVersionNClausesWithOptionalSuffix,
   })
 
 t.create('Version for Invalid Package')

services/build-status.js

@@ -60,7 +60,7 @@ const allStatuses = greenStatuses
  * Joi schema for validating Build Status.
  * Checks if the build status is present in the list of allowed build status.
  *
- * @type {object}
+ * @type {Joi}
  */
 const isBuildStatus = Joi.equal(...allStatuses)
 

services/cii-best-practices/cii-best-practices.service.js

@@ -35,7 +35,7 @@ export default class CIIBestPracticesService extends BaseJsonService {
     pattern: ':metric(level|percentage|summary)/:projectId',
   }
 
-  static exampless = [
+  static examples = [
     {
       title: 'CII Best Practices Level',
       pattern: 'level/:projectId',

services/cii-best-practices/cii-best-practices.tester.js

@@ -3,32 +3,32 @@ import { createServiceTester } from '../tester.js'
 export const t = await createServiceTester()
 
 t.create('level known project')
-  .get(`/level/1.json`)
+  .get('/level/1.json')
   .expectBadge({
     label: 'cii',
     message: withRegex(/in progress|passing|silver|gold/),
   })
 
 t.create('percentage known project')
-  .get(`/percentage/29.json`)
+  .get('/percentage/29.json')
   .expectBadge({
     label: 'cii',
     message: withRegex(/([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-9][0-9]|300)%/),
   })
 
 t.create('summary known project')
-  .get(`/summary/33.json`)
+  .get('/summary/33.json')
   .expectBadge({
     label: 'cii',
     message: withRegex(/(in progress [0-9]|[1-9][0-9]%)|passing|silver|gold/),
   })
 
 t.create('unknown project')
-  .get(`/level/abc.json`)
+  .get('/level/abc.json')
   .expectBadge({ label: 'cii', message: 'project not found' })
 
 t.create('level: gold project')
-  .get(`/level/1.json`)
+  .get('/level/1.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/1/badge.json')
@@ -43,7 +43,7 @@ t.create('level: gold project')
   })
 
 t.create('level: silver project')
-  .get(`/level/34.json`)
+  .get('/level/34.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/34/badge.json')
@@ -58,7 +58,7 @@ t.create('level: silver project')
   })
 
 t.create('level: passing project')
-  .get(`/level/29.json`)
+  .get('/level/29.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/29/badge.json')
@@ -73,7 +73,7 @@ t.create('level: passing project')
   })
 
 t.create('level: in progress project')
-  .get(`/level/33.json`)
+  .get('/level/33.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/33/badge.json')
@@ -88,7 +88,7 @@ t.create('level: in progress project')
   })
 
 t.create('percentage: gold project')
-  .get(`/percentage/1.json`)
+  .get('/percentage/1.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/1/badge.json')
@@ -103,7 +103,7 @@ t.create('percentage: gold project')
   })
 
 t.create('percentage: silver project')
-  .get(`/percentage/34.json`)
+  .get('/percentage/34.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/34/badge.json')
@@ -118,7 +118,7 @@ t.create('percentage: silver project')
   })
 
 t.create('percentage: passing project')
-  .get(`/percentage/29.json`)
+  .get('/percentage/29.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/29/badge.json')
@@ -133,7 +133,7 @@ t.create('percentage: passing project')
   })
 
 t.create('percentage: in progress project')
-  .get(`/percentage/33.json`)
+  .get('/percentage/33.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/33/badge.json')
@@ -148,7 +148,7 @@ t.create('percentage: in progress project')
   })
 
 t.create('summary: gold project')
-  .get(`/summary/1.json`)
+  .get('/summary/1.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/1/badge.json')
@@ -163,7 +163,7 @@ t.create('summary: gold project')
   })
 
 t.create('summary: silver project')
-  .get(`/summary/34.json`)
+  .get('/summary/34.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/34/badge.json')
@@ -178,7 +178,7 @@ t.create('summary: silver project')
   })
 
 t.create('summary: passing project')
-  .get(`/summary/29.json`)
+  .get('/summary/29.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/29/badge.json')
@@ -193,7 +193,7 @@ t.create('summary: passing project')
   })
 
 t.create('summary: in progress project')
-  .get(`/summary/33.json`)
+  .get('/summary/33.json')
   .intercept(nock =>
     nock('https://bestpractices.coreinfrastructure.org/projects')
       .get('/33/badge.json')

services/codecov/codecov.tester.js

@@ -60,7 +60,7 @@ t.create('handles unauthorized private repository')
   .intercept(nock =>
     nock('https://codecov.io')
       .get('/github/codecov/private-example-python/graph/badge.svg')
-      .reply(200, `<g><text x="105.5" y="14">unknown</text></g>`, {
+      .reply(200, '<g><text x="105.5" y="14">unknown</text></g>', {
         'Content-Type': 'image/svg+xml',
       })
   )
@@ -110,7 +110,7 @@ t.create('gets coverage for private repository')
       .get(
         '/gh/codecov/private-example-python/graph/badge.svg?token=a1b2c3d4e5'
       )
-      .reply(200, `<g><text x="105.5" y="14">100%</text></g>`, {
+      .reply(200, '<g><text x="105.5" y="14">100%</text></g>', {
         'Content-Type': 'image/svg+xml',
       })
   )

services/color-formatters.js

@@ -5,7 +5,7 @@
  * @module
  */
 
-import moment from 'moment'
+import dayjs from 'dayjs'
 import pep440 from '@renovate/pep440'
 
 /**
@@ -23,7 +23,7 @@ function version(version) {
   if (first === 'v') {
     first = version[1]
   }
-  if (first === '0' || /alpha|beta|snapshot|dev|pre/i.test(version)) {
+  if (first === '0' || /alpha|beta|snapshot|dev|pre|rc/i.test(version)) {
     return 'orange'
   } else {
     return 'blue'
@@ -182,7 +182,7 @@ function colorScale(steps, colors, reversed) {
  */
 function age(date) {
   const colorByAge = colorScale([7, 30, 180, 365, 730], undefined, true)
-  const daysElapsed = moment().diff(moment(date), 'days')
+  const daysElapsed = dayjs().diff(dayjs(date), 'days')
   return colorByAge(daysElapsed)
 }
 

services/color-formatters.spec.js

@@ -88,6 +88,7 @@ describe('Color formatters', function () {
       given('6.0-SNAPSHOT'),
       given('1.0.1-dev'),
       given('2.1.6-prerelease'),
+      given('2.1.6-RC1'),
     ]).expect('orange')
 
     expect(() => version(null)).to.throw(

services/conda/conda-version.service.js

@@ -31,7 +31,7 @@ export default class CondaVersion extends BaseCondaService {
 
   static render({ variant, channel, version }) {
     return {
-      label: variant === 'vn' ? channel : `conda|${channel}`,
+      label: variant === 'vn' ? channel : `conda | ${channel}`,
       message: versionText(version),
       color: versionColor(version),
     }

services/conda/conda-version.tester.js

@@ -3,7 +3,7 @@ import { createServiceTester } from '../tester.js'
 export const t = await createServiceTester()
 
 t.create('version').get('/v/conda-forge/zlib.json').expectBadge({
-  label: 'conda|conda-forge',
+  label: 'conda | conda-forge',
   message: isVPlusTripleDottedVersion,
 })
 

services/criterion/criterion.service.js

@@ -1,66 +1,11 @@
-import Joi from 'joi'
-import { BaseJsonService } from '../index.js'
-import {
-  IMPROVED_STATUS,
-  NOT_FOUND_STATUS,
-  REGRESSED_STATUS,
-  NO_CHANGE_STATUS,
-} from './constants.js'
+import { deprecatedService } from '../index.js'
 
-const schema = Joi.string()
-  .allow(IMPROVED_STATUS, REGRESSED_STATUS, NO_CHANGE_STATUS)
-  .required()
-
-/**
- * Criterion Badge Service
- *
- * Support and Contact:
- * - https://github.com/chmoder/api.criterion.dev
- *
- * API Documentation:
- * - https://app.swaggerhub.com/apis-docs/chmoder/Criterion.dev
- */
-export default class Criterion extends BaseJsonService {
-  static category = 'analysis'
-  static route = { base: 'criterion', pattern: ':user/:repo' }
-
-  static examples = [
-    {
-      title: 'Criterion',
-      namedParams: {
-        user: 'chmoder',
-        repo: 'data_vault',
-      },
-      staticPreview: this.render({ status: IMPROVED_STATUS }),
-    },
-  ]
-
-  static defaultBadgeData = { label: 'criterion' }
-
-  static render({ status }) {
-    let statusColor = 'lightgrey'
-
-    if (status === IMPROVED_STATUS) {
-      statusColor = 'brightgreen'
-    } else if (status === NO_CHANGE_STATUS) {
-      statusColor = 'green'
-    } else if (statusColor === REGRESSED_STATUS) {
-      statusColor = 'red'
-    }
-
-    return {
-      message: `${status}`,
-      color: statusColor,
-    }
-  }
-
-  async handle({ user, repo }) {
-    const status = await this._requestJson({
-      url: `https://api.criterion.dev/v1/${user}/${repo}/status`,
-      errorMessages: { 404: NOT_FOUND_STATUS },
-      schema,
-    })
-
-    return this.constructor.render({ status })
-  }
-}
+export default deprecatedService({
+  category: 'analysis',
+  route: {
+    base: 'criterion',
+    pattern: ':various*',
+  },
+  label: 'criterion',
+  dateAdded: new Date('2022-10-07'),
+})

services/criterion/criterion.tester.js

@@ -1,21 +1,11 @@
-import Joi from 'joi'
-import { createServiceTester } from '../tester.js'
-import {
-  IMPROVED_STATUS,
-  REGRESSED_STATUS,
-  NO_CHANGE_STATUS,
-  NOT_FOUND_STATUS,
-} from './constants.js'
-export const t = await createServiceTester()
+import { ServiceTester } from '../tester.js'
 
-const isStatus = Joi.string()
-  .allow(IMPROVED_STATUS, REGRESSED_STATUS, NOT_FOUND_STATUS, NO_CHANGE_STATUS)
-  .required()
+export const t = new ServiceTester({
+  id: 'criterion',
+  title: 'Criterion',
+  pathPrefix: '/criterion',
+})
 
-t.create('Criterion (valid repo)')
+t.create('Criterion')
   .get('/chmoder/credit_card.json')
-  .expectBadge({ label: 'criterion', message: isStatus })
-
-t.create('Criterion (not found)')
-  .get('/chmoder/not-a-repo.json')
-  .expectBadge({ label: 'criterion', message: NOT_FOUND_STATUS })
+  .expectBadge({ label: 'criterion', message: 'no longer available' })

services/discord/discord.spec.js

@@ -14,12 +14,12 @@ describe('Discord', function () {
       },
     }
 
-    const scope = nock(`https://discord.com`, {
+    const scope = nock('https://discord.com', {
       // This ensures that the expected credential is actually being sent with the HTTP request.
       // Without this the request wouldn't match and the test would fail.
-      reqheaders: { Authorization: `Bot password` },
+      reqheaders: { Authorization: 'Bot password' },
     })
-      .get(`/api/v6/guilds/12345/widget.json`)
+      .get('/api/v6/guilds/12345/widget.json')
       .reply(200, {
         presence_count: 125,
       })

services/discourse/discourse.service.js

@@ -72,7 +72,7 @@ class DiscourseStatus extends DiscourseBase {
   static route = this.buildRoute('status')
   static examples = [
     {
-      title: `Discourse status`,
+      title: 'Discourse status',
       namedParams: {},
       queryParams: {
         server: 'https://meta.discourse.org',

services/docker/docker-cloud-automated.service.js

@@ -28,6 +28,12 @@ export default class DockerCloudAutomatedBuild extends BaseJsonService {
 
   async handle({ user, repo }) {
     const data = await fetchBuild(this, { user, repo })
+
+    if (data.objects.length === 0) {
+      return this.constructor.render({
+        buildSettings: [],
+      })
+    }
     return this.constructor.render({
       buildSettings: data.objects[0].build_settings,
     })

services/docker/docker-cloud-automated.tester.js

@@ -5,13 +5,29 @@ export const t = await createServiceTester()
 
 const isAutomatedBuildStatus = Joi.string().valid('automated', 'manual')
 
-t.create('docker cloud automated build (valid, user)')
-  .get('/jrottenberg/ffmpeg.json')
+t.create('docker cloud automated build (valid user)')
+  .get('/pavics/magpie.json')
   .expectBadge({
     label: 'docker build',
     message: isAutomatedBuildStatus,
   })
 
+t.create('docker cloud automated build status (invalid, nonexisting user)')
+  .get('/pavicsssss/magpie.json')
+  .expectBadge({
+    label: 'docker build',
+    message: 'manual',
+  })
+
+t.create(
+  "docker cloud build status (valid user, but the 'objects' array from the response is empty)"
+)
+  .get('/pavics/weaver.json')
+  .expectBadge({
+    label: 'docker build',
+    message: 'manual',
+  })
+
 t.create('docker cloud automated build (not found)')
   .get('/badges/not-a-real-repo.json')
   .intercept(nock =>

services/docker/docker-cloud-build.service.js

@@ -1,4 +1,4 @@
-import { BaseJsonService } from '../index.js'
+import { BaseJsonService, NotFound } from '../index.js'
 import { dockerBlue, buildDockerUrl } from './docker-helpers.js'
 import { fetchBuild } from './docker-cloud-common-fetch.js'
 
@@ -31,6 +31,12 @@ export default class DockerCloudBuild extends BaseJsonService {
 
   async handle({ user, repo }) {
     const data = await fetchBuild(this, { user, repo })
+
+    if (data.objects.length === 0) {
+      throw new NotFound({
+        prettyMessage: 'automated builds not set up',
+      })
+    }
     return this.constructor.render({ state: data.objects[0].state })
   }
 }

services/docker/docker-cloud-build.tester.js

@@ -3,13 +3,29 @@ import { createServiceTester } from '../tester.js'
 import { dockerBlue } from './docker-helpers.js'
 export const t = await createServiceTester()
 
-t.create('docker cloud build status (valid, user)')
-  .get('/jrottenberg/ffmpeg.json')
+t.create('docker cloud build status (valid user)')
+  .get('/pavics/magpie.json')
   .expectBadge({
     label: 'docker build',
     message: isBuildStatus,
   })
 
+t.create('docker cloud build status (invalid, nonexisting user)')
+  .get('/pavicsssss/magpie.json')
+  .expectBadge({
+    label: 'docker build',
+    message: 'automated builds not set up',
+  })
+
+t.create(
+  "docker cloud build status (valid user, but the 'objects' array from the response is empty)"
+)
+  .get('/pavics/weaver.json')
+  .expectBadge({
+    label: 'docker build',
+    message: 'automated builds not set up',
+  })
+
 t.create('docker cloud build status (not found)')
   .get('/badges/not-a-real-repo.json')
   .intercept(nock =>

services/docker/docker-cloud-common-fetch.js

@@ -6,7 +6,7 @@ const cloudBuildSchema = Joi.object({
       Joi.object({
         state: Joi.string(),
         build_settings: Joi.array(),
-      }).required()
+      })
     )
     .required(),
 }).required()
@@ -14,7 +14,7 @@ const cloudBuildSchema = Joi.object({
 async function fetchBuild(serviceInstance, { user, repo }) {
   return serviceInstance._requestJson({
     schema: cloudBuildSchema,
-    url: `https://cloud.docker.com/api/build/v1/source`,
+    url: 'https://cloud.docker.com/api/build/v1/source',
     options: { searchParams: { image: `${user}/${repo}` } },
     errorMessages: { 404: 'repo not found' },
   })

services/docker/docker-fixtures.js

@@ -1,71 +1,36 @@
 const sizeDataNoTagSemVerSort = [
-  { name: 'master', full_size: 13449470 },
-  { name: 'feature-smtps-support', full_size: 13449638 },
-  { name: 'latest', full_size: 13448411 },
-  { name: '4', full_size: 13448411 },
-  { name: '4.3', full_size: 13448411 },
-  { name: '4.3.0', full_size: 13448411 },
-  { name: '4.2', full_size: 13443674 },
-  { name: '4.2.0', full_size: 13443674 },
-  { name: '4.1', full_size: 19244435 },
-  { name: '4.1.0', full_size: 19244435 },
-  { name: 'v4.0.0-alpha2', full_size: 10933605 },
-  { name: 'v4.0.0-alpha1', full_size: 10933644 },
-  { name: '4.0.0', full_size: 11512227 },
-  { name: '4.0', full_size: 11512227 },
-  { name: 'v2.1.9', full_size: 29739490 },
-  { name: 'v2.1.10', full_size: 29739842 },
-  { name: 'v3.0.0', full_size: 32882980 },
-  { name: 'v3.0.1', full_size: 32880923 },
-  { name: 'v3.1.0', full_size: 32441549 },
-  { name: 'v3.1.1', full_size: 32441767 },
-  { name: 'v3.1.2', full_size: 32442741 },
-  { name: 'v3.1.3', full_size: 32442629 },
-  { name: 'v3.1.4', full_size: 32478607 },
-  { name: 'v3.2.0', full_size: 33489914 },
-  { name: 'v3.3.0', full_size: 33628545 },
-  { name: 'v3.3.1', full_size: 33629018 },
-  { name: 'v3.3.3', full_size: 33628988 },
-  { name: 'v3.3.4', full_size: 33629019 },
-  { name: 'v3.3.6', full_size: 33628753 },
-  { name: 'v3.3.7', full_size: 33629556 },
-  { name: 'v3.3.8', full_size: 33644261 },
-  { name: 'v3.3.9', full_size: 33644175 },
-  { name: 'v3.3.10', full_size: 33644406 },
-  { name: 'v3.3.11', full_size: 33644430 },
-  { name: 'v3.3.12', full_size: 33644703 },
-  { name: 'v3.3.13', full_size: 33644377 },
-  { name: 'v3.3.15', full_size: 33644581 },
-  { name: 'v3.3.16', full_size: 33644663 },
-  { name: 'v3.3.17', full_size: 33644228 },
-  { name: 'v3.3.18', full_size: 33644466 },
-  { name: 'v3.3.19', full_size: 33644724 },
-  { name: 'v3.4.0', full_size: 34918552 },
-  { name: 'v3.4.2', full_size: 33605129 },
-  { name: 'v3.5.0', full_size: 33582915 },
-  { name: 'v3.6.0', full_size: 34789944 },
-  { name: 'develop', full_size: 38129308 },
-  { name: 'v3.7.0', full_size: 38179583 },
-  { name: 'v3.7.1', full_size: 38614944 },
-  { name: 'v3.8.0', full_size: 42962384 },
-  { name: 'v3.8.1', full_size: 40000713 },
-  { name: 'v3.8.2', full_size: 40000567 },
-  { name: 'v3.8.3', full_size: 40040963 },
-  { name: 'v3.9.0', full_size: 40044357 },
-  { name: 'v3.9.1', full_size: 40048123 },
-  { name: 'v3.9.2', full_size: 40047663 },
-  { name: 'v3.9.3', full_size: 40048204 },
-  { name: 'v3.9.4', full_size: 40049571 },
-  { name: 'v3.9.5', full_size: 40049695 },
-  { name: 'v3.10.0', full_size: 39940736 },
-  { name: 'v3.11.0', full_size: 39928170 },
-  { name: 'v3.12.0', full_size: 39966770 },
-  { name: 'v3.13.0', full_size: 38556045 },
-  { name: 'v3.14.0', full_size: 38574008 },
-  { name: 'v3.15.0', full_size: 38578507 },
-  { name: 'v3.16.0', full_size: 38852598 },
-  { name: 'v3.16.1', full_size: 38851702 },
-  { name: 'v3.16.2', full_size: 38969822 },
+  {
+    full_size: 300000000,
+    name: 'v4.0.0-alpha2',
+    images: [
+      { architecture: 'amd64', size: 219939484 },
+      { architecture: 'arm64', size: 200000000 },
+    ],
+  },
+  {
+    full_size: 400000000,
+    name: 'v4.2.4',
+    images: [
+      { architecture: 'amd64', size: 220000000 },
+      { architecture: 'arm64', size: 210000000 },
+    ],
+  },
+  {
+    full_size: 100000000,
+    name: 'v3.9.7',
+    images: [
+      { architecture: 'amd64', size: 120000000 },
+      { architecture: 'arm64', size: 110000000 },
+    ],
+  },
+  {
+    full_size: 500000000,
+    name: 'latest',
+    images: [
+      { architecture: 'amd64', size: 560000000 },
+      { architecture: 'arm64', size: 460000000 },
+    ],
+  },
 ]
 const versionDataNoTagDateSort = {
   count: 4,

services/docker/docker-helpers.js

@@ -1,7 +1,28 @@
+import Joi from 'joi'
 // see https://github.com/badges/shields/pull/1690
 import { NotFound } from '../index.js'
 const dockerBlue = '066da5'
 
+// Valid architecture values: https://golang.org/doc/install/source#environment (GOARCH)
+const archSchema = Joi.alternatives(
+  Joi.string().valid(
+    'amd64',
+    'arm',
+    'arm64',
+    's390x',
+    '386',
+    'ppc64',
+    'ppc64le',
+    'wasm',
+    'mips',
+    'mipsle',
+    'mips64',
+    'mips64le',
+    'riscv64'
+  ),
+  Joi.number().valid(386).cast('string')
+)
+
 function buildDockerUrl(badgeName, includeTagRoute) {
   if (includeTagRoute) {
     return {
@@ -55,6 +76,7 @@ function getDigestSemVerMatches({ data, digest }) {
 }
 
 export {
+  archSchema,
   dockerBlue,
   buildDockerUrl,
   getDockerHubUser,

services/docker/docker-size.service.js

@@ -4,6 +4,7 @@ import { nonNegativeInteger } from '../validators.js'
 import { latest } from '../version.js'
 import { BaseJsonService, NotFound } from '../index.js'
 import {
+  archSchema,
   buildDockerUrl,
   getDockerHubUser,
   getMultiPageData,
@@ -12,6 +13,12 @@ import {
 const buildSchema = Joi.object({
   name: Joi.string().required(),
   full_size: nonNegativeInteger.required(),
+  images: Joi.array().items(
+    Joi.object({
+      size: nonNegativeInteger.required(),
+      architecture: Joi.string().required(),
+    })
+  ),
 }).required()
 
 const pagedSchema = Joi.object({
@@ -20,14 +27,37 @@ const pagedSchema = Joi.object({
     Joi.object({
       name: Joi.string().required(),
       full_size: nonNegativeInteger.required(),
+      images: Joi.array().items(
+        Joi.object({
+          size: nonNegativeInteger.required(),
+          architecture: Joi.string().required(),
+        })
+      ),
     })
   ),
 }).required()
 
 const queryParamSchema = Joi.object({
   sort: Joi.string().valid('date', 'semver').default('date'),
+  arch: archSchema,
 }).required()
 
+// If user provided the arch parameter,
+// check if any of the returned images has an architecture matching the arch parameter provided.
+// If yes, return the size of the image with this arch.
+// If not, throw the `NotFound` error.
+// For details see: https://github.com/badges/shields/issues/8238
+function getImageSizeForArch(images, arch) {
+  const imgWithArch = Object.values(images).find(
+    img => img.architecture === arch
+  )
+
+  if (!imgWithArch) {
+    throw new NotFound({ prettyMessage: 'architecture not found' })
+  }
+  return imgWithArch.size
+}
+
 export default class DockerSize extends BaseJsonService {
   static category = 'size'
   static route = { ...buildDockerUrl('image-size', true), queryParamSchema }
@@ -46,6 +76,14 @@ export default class DockerSize extends BaseJsonService {
       queryParams: { sort: 'semver' },
       staticPreview: this.render({ size: 136000000 }),
     },
+    {
+      title:
+        'Docker Image Size with architecture (latest by date/latest semver)',
+      pattern: ':user/:repo',
+      namedParams: { user: 'library', repo: 'mysql' },
+      queryParams: { sort: 'date', arch: 'amd64' },
+      staticPreview: this.render({ size: 146000000 }),
+    },
     {
       title: 'Docker Image Size (tag)',
       pattern: ':user/:repo/:tag',
@@ -73,30 +111,83 @@ export default class DockerSize extends BaseJsonService {
     })
   }
 
-  transform({ tag, sort, data }) {
-    if (!tag && sort === 'date') {
-      if (data.count === 0) {
-        throw new NotFound({ prettyMessage: 'repository not found' })
+  getSizeFromImageByLatestDate(data, arch) {
+    if (data.count === 0) {
+      throw new NotFound({ prettyMessage: 'repository not found' })
+    } else {
+      const latestEntry = data.results[0]
+
+      if (arch) {
+        return { size: getImageSizeForArch(latestEntry.images, arch) }
       } else {
-        return { size: data.results[0].full_size }
+        return { size: latestEntry.full_size }
       }
-    } else if (!tag && sort === 'semver') {
-      const [matches, versions] = data.reduce(
-        ([m, v], d) => {
-          m[d.name] = d.full_size
-          v.push(d.name)
-          return [m, v]
-        },
-        [{}, []]
-      )
-      const version = latest(versions)
+    }
+  }
+
+  getSizeFromImageByLatestSemver(data, arch) {
+    // If no tag is specified, and sorting is by semver, first filter out the entry containing the latest semver from the response with Docker images.
+    // If no architecture is supplied by the user, return `full_size` from this entry.
+    // If the architecture is supplied by the user, check if any of the returned images for this entry has an architecture matching the arch parameter supplied by the user.
+    // If yes, return the size of the image with this arch.
+    // If not, throw the `NotFound` error.
+
+    const [matches, versions, images] = data.reduce(
+      ([m, v, i], d) => {
+        m[d.name] = d.full_size
+        v.push(d.name)
+        i[d.name] = d.images
+        return [m, v, i]
+      },
+      [{}, [], {}]
+    )
+
+    const version = latest(versions)
+
+    let sizeOfImgWithArch
+
+    if (arch) {
+      Object.keys(images).forEach(ver => {
+        if (ver === version) {
+          sizeOfImgWithArch = getImageSizeForArch(images[ver], arch)
+          return { size: sizeOfImgWithArch }
+        }
+      })
+
+      if (sizeOfImgWithArch) {
+        return { size: sizeOfImgWithArch }
+      } else {
+        throw new NotFound({ prettyMessage: 'architecture not found' })
+      }
+    } else {
       return { size: matches[version] }
+    }
+  }
+
+  getSizeFromTag(data, arch) {
+    // If the tag is specified, and the architecture is supplied by the user,
+    // check if any of the returned images has an architecture matching the arch parameter supplied by the user.
+    // If yes, return the size of the image with this arch.
+    // If no, throw the `NotFound` error.
+    // If no architecture is supplied by the user, return the value of the `full_size` from the response (the image with the `latest` tag).
+    if (arch) {
+      return { size: getImageSizeForArch(data.images, arch) }
     } else {
       return { size: data.full_size }
     }
   }
 
-  async handle({ user, repo, tag }, { sort }) {
+  transform({ tag, sort, data, arch }) {
+    if (!tag && sort === 'date') {
+      return this.getSizeFromImageByLatestDate(data, arch)
+    } else if (!tag && sort === 'semver') {
+      return this.getSizeFromImageByLatestSemver(data, arch)
+    } else {
+      return this.getSizeFromTag(data, arch)
+    }
+  }
+
+  async handle({ user, repo, tag }, { sort, arch }) {
     let data
 
     if (!tag && sort === 'date') {
@@ -111,7 +202,7 @@ export default class DockerSize extends BaseJsonService {
       data = await this.fetch({ user, repo, tag })
     }
 
-    const { size } = await this.transform({ tag, sort, data })
+    const { size } = await this.transform({ tag, sort, data, arch })
     return this.constructor.render({ size })
   }
 }

services/docker/docker-size.spec.js

@@ -3,40 +3,99 @@ import DockerSize from './docker-size.service.js'
 import { sizeDataNoTagSemVerSort } from './docker-fixtures.js'
 
 describe('DockerSize', function () {
-  test(DockerSize.prototype.transform, () => {
-    given({
-      tag: '',
-      sort: 'date',
-      data: { results: [{ name: 'next', full_size: 219939484 }] },
-    }).expect({
+  test(DockerSize.prototype.getSizeFromImageByLatestDate, () => {
+    given(
+      {
+        count: 0,
+        results: [],
+      },
+      'amd64'
+    ).expectError('Not Found: repository not found')
+    given(
+      {
+        count: 1,
+        results: [
+          {
+            full_size: 300000000,
+            name: 'next',
+            images: [{ architecture: 'amd64', size: 219939484 }],
+          },
+        ],
+      },
+      'amd64'
+    ).expect({
       size: 219939484,
     })
     given({
-      tag: '',
-      sort: 'date',
-      data: {
+      count: 1,
+      results: [
+        {
+          full_size: 300000000,
+          name: 'next',
+          images: [
+            { architecture: 'amd64', size: 219939484 },
+            { architecture: 'arm64', size: 200000000 },
+          ],
+        },
+      ],
+    }).expect({
+      size: 300000000,
+    })
+    given(
+      {
+        count: 1,
         results: [
-          { name: 'latest', full_size: 74661264 },
-          { name: 'arm64v8-latest', full_size: 76310416 },
-          { name: 'arm32v7-latest', full_size: 68001970 },
-          { name: 'amd64-latest', full_size: 74661264 },
+          {
+            full_size: 300000000,
+            name: 'next',
+            images: [
+              { architecture: 'amd64', size: 219939484 },
+              { architecture: 'arm64', size: 200000000 },
+            ],
+          },
         ],
       },
-    }).expect({
-      size: 74661264,
+      'arm64777'
+    ).expectError('Not Found: architecture not found')
+  })
+
+  test(DockerSize.prototype.getSizeFromTag, () => {
+    given(
+      {
+        full_size: 300000000,
+        name: 'next',
+        images: [{ architecture: 'amd64', size: 219939484 }],
+      },
+      'amd64'
+    ).expect({
+      size: 219939484,
     })
     given({
-      tag: '',
-      sort: 'semver',
-      data: sizeDataNoTagSemVerSort,
+      full_size: 300000000,
+      name: 'next',
+      images: [{ architecture: 'amd64', size: 219939484 }],
     }).expect({
-      size: 13448411,
+      size: 300000000,
     })
-    given({
-      tag: 'latest',
-      data: { name: 'latest', full_size: 13448411 },
-    }).expect({
-      size: 13448411,
+    given(
+      {
+        full_size: 300000000,
+        name: 'next',
+        images: [{ architecture: 'amd64', size: 219939484 }],
+      },
+      'arm64777'
+    ).expectError('Not Found: architecture not found')
+  })
+
+  test(DockerSize.prototype.getSizeFromImageByLatestSemver, () => {
+    given(sizeDataNoTagSemVerSort, 'amd64').expect({
+      size: 220000000,
     })
+    given(sizeDataNoTagSemVerSort).expect({
+      size: 400000000,
+    })
+    given(sizeDataNoTagSemVerSort, 'nonexistentArch').expectError(
+      'Not Found: architecture not found'
+    )
   })
 })

services/docker/docker-size.tester.js

@@ -9,6 +9,13 @@ t.create('docker image size (valid, library)')
     message: isFileSize,
   })
 
+t.create('docker image size (valid, library, arch parameter )')
+  .get('/_/mysql.json?arch=amd64')
+  .expectBadge({
+    label: 'image size',
+    message: isFileSize,
+  })
+
 t.create('docker image size (valid, library with tag)')
   .get('/_/alpine/latest.json')
   .expectBadge({
@@ -41,5 +48,19 @@ t.create('docker image size (invalid, unknown repository)')
   .get('/_/not-a-real-repo.json')
   .expectBadge({
     label: 'image size',
-    message: 'repository not found',
+    message: 'repository or tag not found',
+  })
+
+t.create('docker image size (invalid, wrong sorting method)')
+  .get('/jrottenberg/ffmpeg/3.2-alpine.json?sort=daterrr')
+  .expectBadge({
+    label: 'image size',
+    message: 'invalid query parameter: sort',
+  })
+
+t.create('docker image size (invalid, nonexisting arch)')
+  .get('/jrottenberg/ffmpeg/3.2-alpine.json?arch=nonexistingArch')
+  .expectBadge({
+    label: 'image size',
+    message: 'invalid query parameter: arch',
   })

services/docker/docker-stars.service.js

@@ -1,13 +1,18 @@
+import Joi from 'joi'
 import { metric } from '../text-formatters.js'
 import { nonNegativeInteger } from '../validators.js'
-import { BaseService } from '../index.js'
+import { BaseJsonService } from '../index.js'
 import {
   dockerBlue,
   buildDockerUrl,
   getDockerHubUser,
 } from './docker-helpers.js'
 
-export default class DockerStars extends BaseService {
+const schema = Joi.object({
+  star_count: nonNegativeInteger.required(),
+}).required()
+
+export default class DockerStars extends BaseJsonService {
   static category = 'rating'
   static route = buildDockerUrl('stars')
   static examples = [
@@ -31,18 +36,17 @@ export default class DockerStars extends BaseService {
   }
 
   async fetch({ user, repo }) {
-    const url = `https://hub.docker.com/v2/repositories/${getDockerHubUser(
-      user
-    )}/${repo}/stars/count/`
-    const { buffer } = await this._request({
-      url,
+    return this._requestJson({
+      schema,
+      url: `https://hub.docker.com/v2/repositories/${getDockerHubUser(
+        user
+      )}/${repo}/`,
       errorMessages: { 404: 'repo not found' },
     })
-    return this.constructor._validate(buffer, nonNegativeInteger)
   }
 
   async handle({ user, repo }) {
-    const stars = await this.fetch({ user, repo })
-    return this.constructor.render({ stars })
+    const { star_count } = await this.fetch({ user, repo })
+    return this.constructor.render({ stars: star_count })
   }
 }

services/docker/docker-version.service.js

@@ -3,6 +3,7 @@ import { nonNegativeInteger } from '../validators.js'
 import { latest, renderVersionBadge } from '../version.js'
 import { BaseJsonService, NotFound, InvalidResponse } from '../index.js'
 import {
+  archSchema,
   buildDockerUrl,
   getDockerHubUser,
   getMultiPageData,
@@ -26,23 +27,7 @@ const buildSchema = Joi.object({
 
 const queryParamSchema = Joi.object({
   sort: Joi.string().valid('date', 'semver').default('date'),
-  arch: Joi.string()
-    // Valid architecture values: https://golang.org/doc/install/source#environment (GOARCH)
-    .valid(
-      'amd64',
-      'arm',
-      'arm64',
-      's390x',
-      '386',
-      'ppc64',
-      'ppc64le',
-      'wasm',
-      'mips',
-      'mipsle',
-      'mips64',
-      'mips64le'
-    )
-    .default('amd64'),
+  arch: archSchema.default('amd64'),
 }).required()
 
 export default class DockerVersion extends BaseJsonService {

services/docker/docker-version.tester.js

@@ -39,5 +39,5 @@ t.create('docker version (invalid, unknown repository)')
   .get('/_/not-a-real-repo.json')
   .expectBadge({
     label: 'version',
-    message: 'repository not found',
+    message: 'repository or tag not found',
   })

services/drone/drone-build.spec.js

@@ -10,7 +10,7 @@ describe('DroneBuild', function () {
     const token = 'abc123'
 
     const scope = nock('https://cloud.drone.io', {
-      reqheaders: { Authorization: `Bearer abc123` },
+      reqheaders: { Authorization: 'Bearer abc123' },
     })
       .get(/.*/)
       .reply(200, { status: 'passing' })

services/dynamic-common.js

@@ -1,22 +1,54 @@
+/**
+ * Common functions and utilities for tasks related to dynamic badges.
+ *
+ * @module
+ */
+
 import Joi from 'joi'
 import toArray from '../core/base-service/to-array.js'
 import validate from '../core/base-service/validate.js'
 import { InvalidResponse } from './index.js'
 
+/**
+ * Map of error codes and their corresponding error messages.
+ *
+ * @type {object}
+ */
 const errorMessages = {
   404: 'resource not found',
 }
 
+/**
+ * Joi schema for validating individual value.
+ * Checks if the individual value is of type string or number.
+ *
+ * @type {Joi}
+ */
 const individualValueSchema = Joi.alternatives()
   .try(Joi.string(), Joi.number())
   .required()
 
+/**
+ * Joi schema for validating compound value.
+ * Checks if the compound value is of type individualValueSchema, array of individualValueSchema or empty array.
+ *
+ * @type {Joi}
+ */
 const compoundValueSchema = Joi.alternatives().try(
   individualValueSchema,
   Joi.array().items(individualValueSchema).required(),
   Joi.array().length(0)
 )
 
+/**
+ * Look up the value in the data object by key and validate the value against compoundValueSchema.
+ *
+ * @param {object} attrs Refer to individual attributes
+ * @param {object} attrs.data Object containing the data for validation
+ * @param {string} attrs.key Key to retrieve the data from object for validation
+ * @throws {InvalidResponse|Error} Error if Joi validation fails due to invalid or no schema
+ * @returns {object} Value if Joi validation is success
+ */
 function transformAndValidate({ data, key }) {
   return validate(
     {
@@ -30,6 +62,20 @@ function transformAndValidate({ data, key }) {
   )
 }
 
+/**
+ * Handles rendering concerns of dynamic badges.
+ * Determines the label of the badge according to the tag and defaultLabel.
+ * Determines the message of the badge according to the prefix, suffix and value.
+ * Sets the color of the badge to blue.
+ *
+ * @param {object} attrs Refer to individual attributes
+ * @param {string} attrs.defaultLabel default badge label
+ * @param {string} [attrs.tag] If provided then this value will be appended to the badge label, e.g. `foobar@v1.23`
+ * @param {any} attrs.value Value or array of value to be used for the badge message
+ * @param {string} [attrs.prefix] If provided then the badge message will use this value as a prefix
+ * @param {string} [attrs.suffix] If provided then the badge message will use this value as a suffix
+ * @returns {object} Badge with label, message and color properties
+ */
 function renderDynamicBadge({
   defaultLabel,
   tag,

services/endpoint-common.js

@@ -1,3 +1,9 @@
+/**
+ * Common functions and utilities for tasks related to endpoint badges.
+ *
+ * @module
+ */
+
 import Joi from 'joi'
 import validate from '../core/base-service/validate.js'
 import { InvalidResponse } from './index.js'
@@ -14,6 +20,11 @@ const optionalNumberWhenAnyLogoPresent = Joi.alternatives()
   .conditional('namedLogo', { is: Joi.string().required(), then: Joi.number() })
   .conditional('logoSvg', { is: Joi.string().required(), then: Joi.number() })
 
+/**
+ * Joi schema for validating endpoint.
+ *
+ * @type {Joi}
+ */
 const endpointSchema = Joi.object({
   schemaVersion: 1,
   label: Joi.string().allow('').required(),
@@ -33,9 +44,18 @@ const endpointSchema = Joi.object({
   .oxor('namedLogo', 'logoSvg')
   .required()
 
-// Strictly validate according to the endpoint schema. This rejects unknown /
-// invalid keys. Optionally it prints those keys in the message in order to
-// provide detailed feedback.
+/**
+ * Strictly validate the data according to the endpoint schema.
+ * This rejects unknown/invalid keys.
+ * Optionally it prints those keys in the message to provide detailed feedback.
+ *
+ * @param {object} data Object containing the data for validation
+ * @param {object} attrs Refer to individual attributes
+ * @param {string} [attrs.prettyErrorMessage] If provided then error message is set to this value
+ * @param {boolean} [attrs.includeKeys] If true then includes error details in error message, defaults to false
+ * @throws {InvalidResponse|Error} Error if Joi validation fails due to invalid or no schema
+ * @returns {object} Value if Joi validation is success
+ */
 function validateEndpointData(
   data,
   { prettyErrorMessage = 'invalid response data', includeKeys = false } = {}
@@ -56,6 +76,17 @@ function validateEndpointData(
 
 const anySchema = Joi.any()
 
+/**
+ * Fetches data from the endpoint and validates the data.
+ *
+ * @param {object} serviceInstance Instance of Endpoint class
+ * @param {object} attrs Refer to individual attributes
+ * @param {string} attrs.url Endpoint URL
+ * @param {object} attrs.errorMessages Object containing error messages for different error codes
+ * @param {string} attrs.validationPrettyErrorMessage If provided then the error message is set to this value
+ * @param {boolean} attrs.includeKeys If true then includes error details in error message
+ * @returns {object} Data fetched from endpoint
+ */
 async function fetchEndpointData(
   serviceInstance,
   { url, errorMessages, validationPrettyErrorMessage, includeKeys }

services/freecodecamp/freecodecamp-points.service.js

@@ -4,9 +4,10 @@ import { BaseJsonService, InvalidResponse, NotFound } from '../index.js'
 
 /**
  * Validates that the schema response is what we're expecting.
- * The username pattern should match the freeCodeCamp repository.
+ * The username pattern should match the requirements in the freeCodeCamp
+ * repository.
  *
- * @see https://github.com/freeCodeCamp/freeCodeCamp/blob/main/utils/validate.js#L14
+ * @see https://github.com/freeCodeCamp/freeCodeCamp/blob/main/utils/validate.js
  */
 const schema = Joi.object({
   entities: Joi.object({
@@ -46,7 +47,7 @@ export default class FreeCodeCampPoints extends BaseJsonService {
   async fetch({ username }) {
     return this._requestJson({
       schema,
-      url: `https://api.freecodecamp.org/api/users/get-public-profile`,
+      url: 'https://api.freecodecamp.org/api/users/get-public-profile',
       options: {
         searchParams: {
           username,

services/galaxytoolshed/galaxytoolshed-activity.service.js

@@ -0,0 +1,41 @@
+import { formatDate } from '../text-formatters.js'
+import BaseGalaxyToolshedService from './galaxytoolshed-base.js'
+
+export default class GalaxyToolshedCreatedDate extends BaseGalaxyToolshedService {
+  static category = 'activity'
+  static route = {
+    base: 'galaxytoolshed/created-date',
+    pattern: ':repository/:owner',
+  }
+
+  static examples = [
+    {
+      title: 'Galaxy Toolshed (created date)',
+      namedParams: {
+        repository: 'sra_tools',
+        owner: 'iuc',
+      },
+      staticPreview: this.render({
+        date: this.render({ date: '2022-01-01' }),
+      }),
+    },
+  ]
+
+  static defaultBadgeData = {
+    label: 'created date',
+    color: 'blue',
+  }
+
+  static render({ date }) {
+    return { message: formatDate(date) }
+  }
+
+  async handle({ repository, owner }) {
+    const response = await this.fetchLastOrderedInstallableRevisionsSchema({
+      repository,
+      owner,
+    })
+    const { create_time: date } = response[0]
+    return this.constructor.render({ date })
+  }
+}

services/galaxytoolshed/galaxytoolshed-activity.tester.js

@@ -0,0 +1,23 @@
+import { isFormattedDate } from '../test-validators.js'
+import { createServiceTester } from '../tester.js'
+
+export const t = await createServiceTester()
+
+t.create('Created Date')
+  .get('/sra_tools/iuc.json')
+  .expectBadge({ label: 'created date', message: isFormattedDate })
+
+t.create('Created Date - repository not found')
+  .get('/sra_tool/iuc.json')
+  .expectBadge({ label: 'created date', message: 'not found' })
+
+t.create('Created Date - owner not found')
+  .get('/sra_tools/iu.json')
+  .expectBadge({ label: 'created date', message: 'not found' })
+
+t.create('Created Date - changesetRevision not found')
+  .get('/bioqc/badilla.json')
+  .expectBadge({
+    label: 'created date',
+    message: 'changesetRevision not found',
+  })

services/galaxytoolshed/galaxytoolshed-base.js

@@ -0,0 +1,55 @@
+import Joi from 'joi'
+import { nonNegativeInteger } from '../validators.js'
+import { NotFound, BaseJsonService } from '../index.js'
+
+const orderedInstallableRevisionsSchema = Joi.array()
+  .items(Joi.string())
+  .required()
+
+const repositoryRevisionInstallInfoSchema = Joi.array()
+  .ordered(
+    Joi.object({
+      create_time: Joi.date().required(),
+      times_downloaded: nonNegativeInteger,
+    }).required()
+  )
+  .items(Joi.any())
+
+export default class BaseGalaxyToolshedService extends BaseJsonService {
+  static defaultBadgeData = { label: 'galaxytoolshed' }
+  static baseUrl = 'https://toolshed.g2.bx.psu.edu'
+
+  async fetchOrderedInstallableRevisionsSchema({ repository, owner }) {
+    return this._requestJson({
+      schema: orderedInstallableRevisionsSchema,
+      url: `${this.constructor.baseUrl}/api/repositories/get_ordered_installable_revisions?name=${repository}&owner=${owner}`,
+    })
+  }
+
+  async fetchRepositoryRevisionInstallInfoSchema({
+    repository,
+    owner,
+    changesetRevision,
+  }) {
+    return this._requestJson({
+      schema: repositoryRevisionInstallInfoSchema,
+      url: `${this.constructor.baseUrl}/api/repositories/get_repository_revision_install_info?name=${repository}&owner=${owner}&changeset_revision=${changesetRevision}`,
+    })
+  }
+
+  async fetchLastOrderedInstallableRevisionsSchema({ repository, owner }) {
+    const changesetRevisions =
+      await this.fetchOrderedInstallableRevisionsSchema({
+        repository,
+        owner,
+      })
+    if (!Array.isArray(changesetRevisions) || !changesetRevisions.length) {
+      throw new NotFound({ prettyMessage: 'changesetRevision not found' })
+    }
+    return this.fetchRepositoryRevisionInstallInfoSchema({
+      repository,
+      owner,
+      changesetRevision: changesetRevisions[0],
+    })
+  }
+}

services/galaxytoolshed/galaxytoolshed-downloads.service.js

@@ -0,0 +1,34 @@
+import { renderDownloadsBadge } from '../downloads.js'
+import BaseGalaxyToolshedService from './galaxytoolshed-base.js'
+
+export default class GalaxyToolshedDownloads extends BaseGalaxyToolshedService {
+  static category = 'downloads'
+  static route = {
+    base: 'galaxytoolshed/downloads',
+    pattern: ':repository/:owner',
+  }
+
+  static examples = [
+    {
+      title: 'Galaxy Toolshed - Downloads',
+      namedParams: {
+        repository: 'sra_tools',
+        owner: 'iuc',
+      },
+      staticPreview: renderDownloadsBadge({ downloads: 10000 }),
+    },
+  ]
+
+  static defaultBadgeData = {
+    label: 'downloads',
+  }
+
+  async handle({ repository, owner }) {
+    const response = await this.fetchLastOrderedInstallableRevisionsSchema({
+      repository,
+      owner,
+    })
+    const { times_downloaded: downloads } = response[0]
+    return renderDownloadsBadge({ downloads })
+  }
+}

services/galaxytoolshed/galaxytoolshed-downloads.tester.js

@@ -0,0 +1,28 @@
+import { isMetric } from '../test-validators.js'
+import { createServiceTester } from '../tester.js'
+
+export const t = await createServiceTester()
+
+t.create('downloads - raw').get('/sra_tools/iuc.json').expectBadge({
+  label: 'downloads',
+  message: isMetric,
+})
+
+t.create('downloads - repository not found')
+  .get('/sra_tool/iuc.json')
+  .expectBadge({
+    label: 'downloads',
+    message: 'not found',
+  })
+
+t.create('downloads - owner not found').get('/sra_tools/iu.json').expectBadge({
+  label: 'downloads',
+  message: 'not found',
+})
+
+t.create('downloads - changesetRevision not found')
+  .get('/bioqc/badilla.json')
+  .expectBadge({
+    label: 'downloads',
+    message: 'changesetRevision not found',
+  })

services/gem/gem-helpers.js

@@ -0,0 +1,25 @@
+import { valid, maxSatisfying, prerelease } from '@renovatebot/ruby-semver'
+
+function latest(versions) {
+  // latest Ruby Gems version, including pre-releases
+  return maxSatisfying(versions, '>0')
+}
+
+function versionColor(version) {
+  if (!valid(version)) {
+    return 'lightgrey'
+  }
+
+  version = `${version}`
+  let first = version[0]
+  if (first === 'v') {
+    first = version[1]
+  }
+
+  if (first === '0' || prerelease(version)) {
+    return 'orange'
+  }
+  return 'blue'
+}
+
+export { latest, versionColor }

services/gem/gem-helpers.spec.js

@@ -0,0 +1,17 @@
+import { test, given } from 'sazerac'
+import { latest, versionColor } from './gem-helpers.js'
+
+describe('Gem helpers', function () {
+  test(latest, () => {
+    given(['2.0.0', '2.0.0.beta1']).expect('2.0.0')
+    given(['2.0.0.beta1', '1.9.0']).expect('2.0.0.beta1')
+    given(['0.0.1', '0.0.2']).expect('0.0.2')
+  })
+
+  test(versionColor, () => {
+    given('1.9.0').expect('blue')
+    given('2.0.0.beta1').expect('orange')
+    given('0.0.1').expect('orange')
+    given('v1').expect('lightgrey')
+  })
+})

services/gem/gem-rank.tester.js

@@ -1,12 +1,7 @@
-import Joi from 'joi'
 import { createServiceTester } from '../tester.js'
+import { isOrdinalNumber, isOrdinalNumberDaily } from '../test-validators.js'
 export const t = await createServiceTester()
 
-const isOrdinalNumber = Joi.string().regex(/^[1-9][0-9]+(ᵗʰ|ˢᵗ|ⁿᵈ|ʳᵈ)$/)
-const isOrdinalNumberDaily = Joi.string().regex(
-  /^[1-9][0-9]*(ᵗʰ|ˢᵗ|ⁿᵈ|ʳᵈ) daily$/
-)
-
 t.create('total rank (valid)').get('/rt/rspec-puppet-facts.json').expectBadge({
   label: 'rank',
   message: isOrdinalNumber,

services/gem/gem-version.service.js

@@ -1,6 +1,7 @@
 import Joi from 'joi'
-import { renderVersionBadge, latest } from '../version.js'
+import { renderVersionBadge } from '../version.js'
 import { BaseJsonService } from '../index.js'
+import { latest, versionColor } from './gem-helpers.js'
 
 const schema = Joi.object({
   // In most cases `version` will be a SemVer but the registry doesn't
@@ -45,7 +46,7 @@ export default class GemVersion extends BaseJsonService {
   static defaultBadgeData = { label: 'gem' }
 
   static render({ version }) {
-    return renderVersionBadge({ version })
+    return renderVersionBadge({ version, versionFormatter: versionColor })
   }
 
   async fetch({ gem }) {

services/github/github-auth-service.js

@@ -40,7 +40,7 @@ class GithubAuthV4Service extends BaseGraphqlService {
   }
 
   async _requestGraphql(attrs) {
-    const url = `/graphql`
+    const url = '/graphql'
 
     /*
     The Github v4 API requires us to query the rateLimit object to return

services/github/github-commits-difference.service.js

@@ -0,0 +1,59 @@
+import Joi from 'joi'
+import { metric } from '../text-formatters.js'
+import { nonNegativeInteger } from '../validators.js'
+import { GithubAuthV3Service } from './github-auth-service.js'
+import { documentation, errorMessagesFor } from './github-helpers.js'
+
+const schema = Joi.object({ total_commits: nonNegativeInteger }).required()
+
+const queryParamSchema = Joi.object({
+  base: Joi.string().required(),
+  head: Joi.string().required(),
+}).required()
+
+export default class GithubCommitsDifference extends GithubAuthV3Service {
+  static category = 'activity'
+  static route = {
+    base: 'github/commits-difference',
+    pattern: ':user/:repo',
+    queryParamSchema,
+  }
+
+  static examples = [
+    {
+      title: 'GitHub commits difference between two branches/tags/commits',
+      namedParams: {
+        user: 'microsoft',
+        repo: 'vscode',
+      },
+      queryParams: {
+        base: '1.60.0',
+        head: '82f2db7',
+      },
+      staticPreview: this.render({
+        commitCount: 9227,
+      }),
+      documentation,
+    },
+  ]
+
+  static defaultBadgeData = { label: 'commits difference', namedLogo: 'github' }
+
+  static render({ commitCount }) {
+    return {
+      message: metric(commitCount),
+      color: 'blue',
+    }
+  }
+
+  async handle({ user, repo }, { base, head }) {
+    const notFoundMessage = 'could not establish commit difference between refs'
+    const { total_commits: commitCount } = await this._requestJson({
+      schema,
+      url: `/repos/${user}/${repo}/compare/${base}...${head}`,
+      errorMessages: errorMessagesFor(notFoundMessage),
+    })
+
+    return this.constructor.render({ commitCount })
+  }
+}

services/github/github-commits-difference.tester.js

@@ -0,0 +1,43 @@
+import { isMetric } from '../test-validators.js'
+import { createServiceTester } from '../tester.js'
+export const t = await createServiceTester()
+
+t.create('Commits difference - correct, between branches')
+  .get('/microsoft/vscode.json?base=standalone/0.1.x&head=release/1.21')
+  .expectBadge({
+    label: 'commits difference',
+    message: isMetric,
+    color: 'blue',
+  })
+
+t.create('Commits difference - correct, between tags')
+  .get('/microsoft/vscode.json?base=1.58.0&head=1.59.0')
+  .expectBadge({
+    label: 'commits difference',
+    message: isMetric,
+    color: 'blue',
+  })
+
+t.create('Commits difference - correct, between commits')
+  .get('/microsoft/vscode.json?base=3d82ef7&head=82f2db7')
+  .expectBadge({
+    label: 'commits difference',
+    message: isMetric,
+    color: 'blue',
+  })
+
+t.create('Commits difference - incorrect, between commits')
+  .get('/microsoft/vscode.json?base=fffffff&head=82f2db7')
+  .expectBadge({
+    label: 'commits difference',
+    message: 'could not establish commit difference between refs',
+    color: 'red',
+  })
+
+t.create('Commits difference - incorrect, missing head')
+  .get('/microsoft/vscode.json?base=fffffff')
+  .expectBadge({
+    label: 'commits difference',
+    message: 'invalid query parameter: head',
+    color: 'red',
+  })

services/github/github-deployments.service.js

@@ -7,7 +7,7 @@ import { documentation, transformErrors } from './github-helpers.js'
 const greenStates = ['SUCCESS']
 const redStates = ['ERROR', 'FAILURE']
 const blueStates = ['INACTIVE']
-const otherStates = ['IN_PROGRESS', 'QUEUED', 'PENDING', 'NO_STATUS']
+const otherStates = ['IN_PROGRESS', 'QUEUED', 'PENDING', 'NO_STATUS', 'WAITING']
 
 const stateToMessageMappings = {
   IN_PROGRESS: 'in progress',

services/github/github-deployments.spec.js

@@ -21,6 +21,12 @@ describe('GithubDeployments', function () {
       message: 'in progress',
       color: undefined,
     })
+    given({
+      state: 'WAITING',
+    }).expect({
+      message: 'waiting',
+      color: undefined,
+    })
     given({
       state: 'NO_STATUS',
     }).expect({

services/github/github-directory-file-count.service.js

@@ -1,11 +1,11 @@
-import path from 'path'
 import Joi from 'joi'
+import gql from 'graphql-tag'
 import { metric } from '../text-formatters.js'
 import { InvalidParameter } from '../index.js'
-import { ConditionalGithubAuthV3Service } from './github-auth-service.js'
+import { GithubAuthV4Service } from './github-auth-service.js'
 import {
   documentation as commonDocumentation,
-  errorMessagesFor,
+  transformErrors,
 } from './github-helpers.js'
 
 const documentation = `${commonDocumentation}
@@ -22,28 +22,29 @@ const documentation = `${commonDocumentation}
 </p>
 `
 
-const schema = Joi.alternatives(
-  /*
-   alternative empty object schema to provide a custom error message
-   in the event a file path is provided by the user instead of a directory
-  */
-  Joi.object({}).required(),
-  Joi.array()
-    .items(
-      Joi.object({
-        path: Joi.string().required(),
-        type: Joi.string().required(),
+const schema = Joi.object({
+  data: Joi.object({
+    repository: Joi.object({
+      object: Joi.object({
+        entries: Joi.array().items(
+          Joi.object({
+            type: Joi.string().required(),
+            extension: Joi.string().allow('').required(),
+          })
+        ),
       })
-    )
-    .required()
-)
+        .allow(null)
+        .required(),
+    }).required(),
+  }).required(),
+}).required()
 
 const queryParamSchema = Joi.object({
   type: Joi.any().valid('dir', 'file'),
   extension: Joi.string(),
 })
 
-export default class GithubDirectoryFileCount extends ConditionalGithubAuthV3Service {
+export default class GithubDirectoryFileCount extends GithubAuthV4Service {
   static category = 'size'
 
   static route = {
@@ -103,7 +104,7 @@ export default class GithubDirectoryFileCount extends ConditionalGithubAuthV3Ser
       title: 'GitHub repo file count (file extension)',
       pattern: ':user/:repo/:path',
       namedParams: { user: 'badges', repo: 'shields', path: 'services' },
-      queryParams: { extension: 'js' },
+      queryParams: { type: 'file', extension: 'js' },
       staticPreview: this.render({ count: 1 }),
       documentation,
     },
@@ -118,10 +119,25 @@ export default class GithubDirectoryFileCount extends ConditionalGithubAuthV3Ser
   }
 
   async fetch({ user, repo, path = '' }) {
-    return this._requestJson({
-      url: `/repos/${user}/${repo}/contents/${path}`,
+    const expression = `HEAD:${path}`
+    return this._requestGraphql({
+      query: gql`
+        query RepoFiles($user: String!, $repo: String!, $expression: String!) {
+          repository(owner: $user, name: $repo) {
+            object(expression: $expression) {
+              ... on Tree {
+                entries {
+                  type
+                  extension
+                }
+              }
+            }
+          }
+        }
+      `,
+      variables: { user, repo, expression },
       schema,
-      errorMessages: errorMessagesFor('repo or directory not found'),
+      transformErrors,
     })
   }
 
@@ -137,11 +153,12 @@ export default class GithubDirectoryFileCount extends ConditionalGithubAuthV3Ser
     }
 
     if (type) {
-      files = files.filter(file => file.type === type)
+      const objectType = type === 'dir' ? 'tree' : 'blob'
+      files = files.filter(file => file.type === objectType)
     }
 
     if (extension) {
-      files = files.filter(file => path.extname(file.path) === `.${extension}`)
+      files = files.filter(file => file.extension === `.${extension}`)
     }
 
     return {
@@ -150,7 +167,13 @@ export default class GithubDirectoryFileCount extends ConditionalGithubAuthV3Ser
   }
 
   async handle({ user, repo, path }, { type, extension }) {
-    const content = await this.fetch({ user, repo, path })
+    const json = await this.fetch({ user, repo, path })
+    if (json.data.repository.object === null) {
+      throw new InvalidParameter({
+        prettyMessage: 'directory not found',
+      })
+    }
+    const content = json.data.repository.object.entries
     const { count } = this.constructor.transform(content, { type, extension })
     return this.constructor.render({ count })
   }

services/github/github-directory-file-count.spec.js

@@ -5,12 +5,12 @@ import GithubDirectoryFileCount from './github-directory-file-count.service.js'
 
 describe('GithubDirectoryFileCount', function () {
   const contents = [
-    { path: 'a', type: 'dir' },
-    { path: 'b', type: 'dir' },
-    { path: 'c.js', type: 'file' },
-    { path: 'd.js', type: 'file' },
-    { path: 'e.txt', type: 'file' },
-    { path: 'f', type: 'submodule' },
+    { extension: '', type: 'tree' },
+    { extension: '', type: 'tree' },
+    { extension: '.js', type: 'blob' },
+    { extension: '.js', type: 'blob' },
+    { extension: '.txt', type: 'blob' },
+    { extension: '', type: 'commit' },
   ]
 
   test(GithubDirectoryFileCount.transform, () => {