makeBadge(): Throw an error with logo parameters that don't make sense

See comment:

https://github.com/badges/shields/pull/5754/files#r510414774

.circleci/config.yml

@@ -86,33 +86,6 @@ services_steps: &services_steps
     - store_test_results:
         path: junit
 
-run_package_tests: &run_package_tests
-  when: always
-  command: |
-    # https://discuss.circleci.com/t/switch-nodejs-version-on-machine-executor-solved/26675/3
-    set +e
-    export NVM_DIR="/opt/circleci/.nvm"
-    [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
-    nvm install $NODE_VERSION
-    nvm use $NODE_VERSION
-    node --version
-
-    # install the shields.io dependencies
-    npm ci
-
-    # run the package tests
-    npm run test:package
-    npm run check-types:package
-
-    # delete the sheilds.io dependencies
-    rm -rf node_modules/
-
-    # run a smoke test (render a badge with the CLI)
-    # with only the package dependencies installed
-    cd badge-maker
-    npm link
-    badge cactus grown :green @flat
-
 package_steps: &package_steps
   steps:
     - checkout
@@ -129,79 +102,68 @@ package_steps: &package_steps
 
     # 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:
-        <<: *run_package_tests
         environment:
           mocha_reporter: mocha-junit-reporter
           MOCHA_FILE: junit/badge-maker/v10/results.xml
           NODE_VERSION: v10
           CYPRESS_INSTALL_BINARY: 0
         name: Run package tests on Node 10
+        command: scripts/run_package_tests.sh
 
     - run:
-        <<: *run_package_tests
         environment:
           mocha_reporter: mocha-junit-reporter
           MOCHA_FILE: junit/badge-maker/v12/results.xml
           NODE_VERSION: v12
           CYPRESS_INSTALL_BINARY: 0
         name: Run package tests on Node 12
+        command: scripts/run_package_tests.sh
 
     - run:
-        <<: *run_package_tests
         environment:
           mocha_reporter: mocha-junit-reporter
           MOCHA_FILE: junit/badge-maker/v14/results.xml
           NODE_VERSION: v14
           CYPRESS_INSTALL_BINARY: 0
         name: Run package tests on Node 14
+        command: scripts/run_package_tests.sh
 
     - store_test_results:
         path: junit
 
 jobs:
-  npm-install:
-    docker:
-      - image: circleci/node:10
-    steps:
-      - checkout
-
-      - run:
-          name: Install dependencies
-          command: npm ci
-          environment:
-            CYPRESS_INSTALL_BINARY: 0
-
   main:
     docker:
-      - image: circleci/node:10
+      - image: circleci/node:12
 
     <<: *main_steps
 
-  main@node-12:
+  main@node-14:
     docker:
-      - image: circleci/node:12
+      - image: circleci/node:14
 
     <<: *main_steps
 
   integration:
     docker:
-      - image: circleci/node:10
+      - image: circleci/node:12
       - image: redis
 
     <<: *integration_steps
 
-  integration@node-12:
+  integration@node-14:
     docker:
-      - image: circleci/node:12
+      - image: circleci/node:14
       - image: redis
 
     <<: *integration_steps
 
   danger:
     docker:
-      - image: circleci/node:10
+      - image: circleci/node:12
     steps:
       - checkout
 
@@ -221,7 +183,7 @@ jobs:
 
   frontend:
     docker:
-      - image: circleci/node:10
+      - image: circleci/node:12
     steps:
       - checkout
 
@@ -262,13 +224,13 @@ jobs:
 
   services:
     docker:
-      - image: circleci/node:10
+      - image: circleci/node:12
 
     <<: *services_steps
 
-  services@node-12:
+  services@node-14:
     docker:
-      - image: circleci/node:12
+      - image: circleci/node:14
 
     <<: *services_steps
 
@@ -323,11 +285,11 @@ workflows:
           filters:
             branches:
               ignore: gh-pages
-      - main@node-12:
+      - main@node-14:
           filters:
             branches:
               ignore: gh-pages
-      - integration@node-12:
+      - integration@node-14:
           filters:
             branches:
               ignore: gh-pages
@@ -345,7 +307,7 @@ workflows:
               ignore:
                 - master
                 - gh-pages
-      - services@node-12:
+      - services@node-14:
           filters:
             branches:
               ignore:

.dependabot/config.yml

@@ -14,9 +14,6 @@ update_configs:
       - match:
           dependency_name: 'eslint*'
           update_type: 'semver:minor'
-      - match:
-          dependency_name: 'enzyme*'
-          update_type: 'semver:minor'
       - match:
           dependency_name: 'mocha*'
           update_type: 'semver:minor'

.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,4 @@
 contact_links:
-  - name: Support Question
+  - name: ❓ Support Question
     url: https://github.com/badges/shields/discussions
     about: Ask a question about Shields.io

.github/probot.js

@@ -1,10 +0,0 @@
-on('pull_request.closed')
-  .filter(context => context.payload.pull_request.merged)
-  .filter(
-    context =>
-      context.payload.pull_request.head.ref.slice(0, 11) !== 'dependabot/'
-  )
-  .filter(context => context.payload.pull_request.base.ref === 'master')
-  .comment(`This pull request was merged to [{{ pull_request.base.ref }}]({{ repository.html_url }}/tree/{{ pull_request.base.ref }}) branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our \`#ops\` channel on [Discord](https://discordapp.com/invite/HjJCwm5)!
-  
-After deployment, changes are copied to [gh-pages]({{ repository.html_url }}/tree/gh-pages) branch: ![](https://img.shields.io/github/commit-status/{{ repository.full_name }}/gh-pages/{{ pull_request.merge_commit_sha }}.svg?label=deploy%20status)`)

.github/workflows/add_deployment_status.yml

@@ -0,0 +1,28 @@
+name: Ddd deployment status
+
+on:
+  pull_request_target:
+    types: [closed]
+
+jobs:
+  add_deployment_status:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Create comment
+        if: ${{ github.event_name == 'pull_request_target'
+          && github.event.action == 'closed'
+          && github.event.pull_request.merged
+          && !startsWith(github.event.pull_request.head.ref, 'dependabot/')
+          && github.event.pull_request.base.ref == 'master' }}
+        #       From a security perspective it's good practice to reference the commit hash
+        #       https://github.com/peter-evans/create-pull-request/blob/master/docs/concepts-guidelines.md#security
+        uses: peter-evans/create-or-update-comment@41f3207a84f33bd70388036109082784d059dcaa
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          edit-mode: replace
+          body: |
+            This pull request was merged to [${{ github.event.pull_request.base.ref }}](${{ github.event.repository.html_url }}/tree/${{ github.event.pull_request.base.ref }}) branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our `#ops` channel on [Discord](https://discordapp.com/invite/HjJCwm5)!
+
+            After deployment, changes are copied to [gh-pages](${{ github.event.repository.html_url }}/tree/gh-pages) branch: ![](https://img.shields.io/github/commit-status/${{ github.event.repository.full_name }}/gh-pages/${{ github.event.pull_request.merge_commit_sha }}.svg?label=deploy%20status)

.github/workflows/auto-approve.yml

@@ -5,6 +5,6 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: chris48s/approve-bot@1.0.0
+      - uses: chris48s/approve-bot@2.0.1
         with:
           github-token: '${{ secrets.GITHUB_TOKEN }}'

.nycrc.json

@@ -10,6 +10,7 @@
     "**/*-test-helpers.js",
     "**/*-fixtures.js",
     "**/mocha-*.js",
+    "**/*.test-d.ts",
     "dangerfile.js",
     "gatsby-*.js",
     "core/service-test-runner",

.vscode/extensions.json

@@ -1,7 +1,3 @@
 {
-  "recommendations": [
-    "esbenp.prettier-vscode",
-    "EditorConfig.EditorConfig",
-    "dbaeumer.vscode-eslint"
-  ]
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
 }

CODE_OF_CONDUCT.md

@@ -0,0 +1,129 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+![](https://img.shields.io/badge/conduct-%40shields.io-blue) or directly to [@calebcartwright](https://github.com/calebcartwright) ![](https://img.shields.io/badge/caleb-%40shields.io-blue) or [@paulmelnikow](https://github.com/paulmelnikow) ![](https://img.shields.io/badge/paul-%40shields.io-blue)
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -98,11 +98,18 @@ There are three places to get help:
 ## Badge guidelines
 
 - Shields.io hosts integrations for services which are primarily
-  used by developers or which are widely used by developers
+  used by developers or which are widely used by developers.
 - The left-hand side of a badge should not advertise. It should be a lowercase _noun_
   succinctly describing the meaning of the right-hand side.
 - Except for badges using the `social` style, logos should be _turned off by
   default_.
+- Badges should not obtain data from undocumented or reverse-engineered API endpoints.
+- Badges should not obtain data by scraping web pages - these are likely to break frequently.
+  Whereas API publishers are incentivised to maintain a stable platform for their users,
+  authors of web pages have no such incentive.
+- Badges may require users to specify a token in the badge URL as long it is scoped only to
+  fetching information and doesn't expose any sensitive information. Generating a token with the
+  correct scope must be clearly documented.
 
 ## Badge URLs
 

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:10-alpine
+FROM node:12-alpine
 
 RUN mkdir -p /usr/src/app
 RUN mkdir /usr/src/app/private

README.md

@@ -70,10 +70,14 @@ This repo hosts:
 [Make your own badges!][custom badges]
 (Quick example: `https://img.shields.io/badge/left-right-f39f37`)
 
-Browse a [complete list of badges][shields.io].
-
 [custom badges]: http://shields.io/#your-badge
 
+### Quickstart
+
+Browse a [complete list of badges][shields.io] and locate a particular badge by using the search bar or by browsing the categories. Click on the badge to fill in required data elements for that badge type (like your username or repo) and optionally customize (label, colors etc.). And it's ready for use!
+
+Use the button at the bottom to copy your badge url or snippet, which can then be added to places like your GitHub readme files or other web pages.
+
 ## Contributing
 
 Shields is a community project. We invite your participation through issues
@@ -82,20 +86,24 @@ and pull requests! You can peruse the [contributing guidelines][contributing].
 When adding or changing a service [please add tests][service-tests].
 
 This project has quite a backlog of suggestions! If you're new to the project,
-maybe you'd like to open a pull request to address one of them:
-
-[![GitHub issues by-label](https://img.shields.io/github/issues/badges/shields/good%20first%20issue)](https://github.com/badges/shields/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+maybe you'd like to open a pull request to address one of them.
 
 You can read a [tutorial on how to add a badge][tutorial].
 
+[![GitHub issues by-label](https://img.shields.io/github/issues/badges/shields/good%20first%20issue)](https://github.com/badges/shields/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+[![Hacktoberfest 2020](https://img.shields.io/github/hacktoberfest/2020/badges/shields?label=hacktoberfest%202020)](https://github.com/badges/shields/issues?q=is%3Aopen+is%3Aissue+label%3Ahacktoberfest)
+
+Let's see if we can beat last year!
+[![Hacktoberfest 2019](https://img.shields.io/github/hacktoberfest/2019/badges/shields?label=hacktoberfest%202019)](https://github.com/badges/shields/issues?q=is%3Aopen+is%3Aissue+label%3Ahacktoberfest)
+
 [service-tests]: https://github.com/badges/shields/blob/master/doc/service-tests.md
 [tutorial]: doc/TUTORIAL.md
 [contributing]: CONTRIBUTING.md
 
 ## Development
 
-1. Install Node 8 or later. You can use the [package manager][] of your choice.
-   Tests need to pass in Node 8 and 10.
+1. Install Node 12 or later. You can use the [package manager][] of your choice.
+   Tests need to pass in Node 12 and 14.
 2. Clone this repository.
 3. Run `npm ci` to install the dependencies.
 4. Run `npm start` to start the badge server and the frontend dev server.
@@ -124,8 +132,8 @@ Please report any Gitpod bugs, questions, or suggestions in issue
 
 [Snapshot tests][] ensure we don't inadvertently make changes that affect the
 SVG or JSON output. When deliberately changing the output, run
-`SNAPSHOT_DRY=1 npm run test:js:server` to preview changes to the saved
-snapshots, and `SNAPSHOT_UPDATE=1 npm run test:js:server` to update them.
+`SNAPSHOT_DRY=1 npm run test:package` to preview changes to the saved
+snapshots, and `SNAPSHOT_UPDATE=1 npm run test:package` to update them.
 
 The server can be configured to use [Sentry][] ([configuration][sentry configuration]) and [Prometheus][] ([configuration][prometheus configuration]).
 
@@ -202,10 +210,10 @@ Alumni:
 
 ## Related projects
 
-- [badgerbadgerbadger gem][gem]
+- [poser PHP library][poser]
 - [pybadges python library][pybadges]
 
-[gem]: https://github.com/badges/badgerbadgerbadger
+[poser]: https://github.com/badges/poser
 [pybadges]: https://github.com/google/pybadges
 
 ## License

badge-maker/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.3.0
+
+- Readability improvements: a dark font color is automatically used when the badge's background is too light. For example: ![](https://img.shields.io/badge/hello-world-white)
+- Better CSS color compliance: thanks to a switch from _is-css-color_ to _[css-color-converter](https://www.npmjs.com/package/css-color-converter)_, you can use a wider range of color formats from the latest CSS specification, for example `rgb(0 255 0)`
+- Less dependencies: _badge-maker_ no longer depends on _camelcase_
+
 ## 3.2.0
 
 - Accessibility improvements: Help users of assistive technologies to read the badges when used inline

badge-maker/lib/badge-renderers.js

@@ -1,15 +1,25 @@
 'use strict'
 
 const anafanafo = require('anafanafo')
+const { brightness } = require('./color')
 
 const fontFamily = 'font-family="Verdana,Geneva,DejaVu Sans,sans-serif"'
 const socialFontFamily =
   'font-family="Helvetica Neue,Helvetica,Arial,sans-serif"'
+const brightnessThreshold = 0.69
 
 function capitalize(s) {
   return `${s.charAt(0).toUpperCase()}${s.slice(1)}`
 }
 
+function colorsForBackground(color) {
+  if (brightness(color) <= brightnessThreshold) {
+    return { textColor: '#fff', shadowColor: '#010101' }
+  } else {
+    return { textColor: '#333', shadowColor: '#ccc' }
+  }
+}
+
 function escapeXml(s) {
   if (s === undefined || typeof s !== 'string') {
     return undefined
@@ -24,19 +34,12 @@ function escapeXml(s) {
 }
 
 function roundUpToOdd(val) {
-  // Increase chances of pixel grid alignment.
   return val % 2 === 0 ? val + 1 : val
 }
 
-function preferredWidthOf(str) {
-  return roundUpToOdd((anafanafo(str) / 10) | 0)
-}
-
-function computeWidths({ label, message }) {
-  return {
-    labelWidth: preferredWidthOf(label),
-    messageWidth: preferredWidthOf(message),
-  }
+function preferredWidthOf(str, options) {
+  // Increase chances of pixel grid alignment.
+  return roundUpToOdd(anafanafo(str, options) | 0)
 }
 
 function createAccessibleText({ label, message }) {
@@ -74,22 +77,19 @@ function renderLogo({
   logoWidth = 14,
   logoPadding = 0,
 }) {
-  if (!logo) {
+  if (logo) {
+    const logoHeight = 14
+    const y = (badgeHeight - logoHeight) / 2
+    const x = horizPadding
     return {
-      hasLogo: false,
-      totalLogoWidth: 0,
-      renderedLogo: '',
+      hasLogo: true,
+      totalLogoWidth: logoWidth + logoPadding,
+      renderedLogo: `<image x="${x}" y="${y}" width="${logoWidth}" height="${logoHeight}" xlink:href="${escapeXml(
+        logo
+      )}"/>`,
     }
-  }
-  const logoHeight = 14
-  const y = (badgeHeight - logoHeight) / 2
-  const x = horizPadding
-  return {
-    hasLogo: true,
-    totalLogoWidth: logoWidth + logoPadding,
-    renderedLogo: `<image x="${x}" y="${y}" width="${logoWidth}" height="14" xlink:href="${escapeXml(
-      logo
-    )}"/>`,
+  } else {
+    return { hasLogo: false, totalLogoWidth: 0, renderedLogo: '' }
   }
 }
 
@@ -118,12 +118,13 @@ function renderText({
   height,
   verticalMargin = 0,
   shadow = false,
+  color,
 }) {
   if (!content.length) {
     return { renderedText: '', width: 0 }
   }
 
-  const textLength = preferredWidthOf(content)
+  const textLength = preferredWidthOf(content, { font: '11px Verdana' })
   const escapedContent = escapeXml(content)
 
   const shadowMargin = 150 + verticalMargin
@@ -133,10 +134,11 @@ function renderText({
   const x = 10 * (leftMargin + 0.5 * textLength + horizPadding)
 
   let renderedText = ''
+  const { textColor, shadowColor } = colorsForBackground(color)
   if (shadow) {
-    renderedText = `<text aria-hidden="true" x="${x}" y="${shadowMargin}" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="${outTextLength}">${escapedContent}</text>`
+    renderedText = `<text aria-hidden="true" x="${x}" y="${shadowMargin}" fill="${shadowColor}" fill-opacity=".3" transform="scale(.1)" textLength="${outTextLength}">${escapedContent}</text>`
   }
-  renderedText += `<text x="${x}" y="${textMargin}" transform="scale(.1)" fill="#fff" textLength="${outTextLength}">${escapedContent}</text>`
+  renderedText += `<text x="${x}" y="${textMargin}" transform="scale(.1)" fill="${textColor}" textLength="${outTextLength}">${escapedContent}</text>`
 
   return {
     renderedText: link
@@ -174,10 +176,6 @@ function renderBadge(
     </svg>`
 }
 
-function stripXmlWhitespace(xml) {
-  return xml.replace(/>\s+/g, '>').replace(/<\s+/g, '<').trim()
-}
-
 class Badge {
   static get fontFamily() {
     throw new Error('Not implemented')
@@ -234,6 +232,7 @@ class Badge {
       height: this.constructor.height,
       verticalMargin: this.constructor.verticalMargin,
       shadow: this.constructor.shadow,
+      color: labelColor,
     })
 
     const leftWidth = hasLabel
@@ -257,6 +256,7 @@ class Badge {
       height: this.constructor.height,
       verticalMargin: this.constructor.verticalMargin,
       shadow: this.constructor.shadow,
+      color,
     })
 
     let rightWidth = messageWidth + 2 * horizPadding
@@ -282,6 +282,10 @@ class Badge {
     this.renderedMessage = renderedMessage
   }
 
+  static render(params) {
+    return new this(params).render()
+  }
+
   render() {
     throw new Error('Not implemented')
   }
@@ -432,30 +436,6 @@ class FlatSquare extends Badge {
   }
 }
 
-function plastic(params) {
-  const badge = new Plastic(params)
-  if (params.minify) {
-    return stripXmlWhitespace(badge.render())
-  }
-  return badge.render()
-}
-
-function flat(params) {
-  const badge = new Flat(params)
-  if (params.minify) {
-    return stripXmlWhitespace(badge.render())
-  }
-  return badge.render()
-}
-
-function flatSquare(params) {
-  const badge = new FlatSquare(params)
-  if (params.minify) {
-    return stripXmlWhitespace(badge.render())
-  }
-  return badge.render()
-}
-
 function social({
   label,
   message,
@@ -465,7 +445,6 @@ function social({
   logoPadding,
   color = '#4c1',
   labelColor = '#555',
-  minify,
 }) {
   // Social label is styled with a leading capital. Convert to caps here so
   // width can be measured using the correct characters.
@@ -473,24 +452,23 @@ function social({
 
   const externalHeight = 20
   const internalHeight = 19
-  const horizPadding = 5
+  const labelHorizPadding = 5
+  const messageHorizPadding = 4
+  const horizGutter = 6
   const { totalLogoWidth, renderedLogo } = renderLogo({
     logo,
     badgeHeight: externalHeight,
-    horizPadding,
+    horizPadding: labelHorizPadding,
     logoWidth,
     logoPadding,
   })
   const hasMessage = message.length
 
-  let { labelWidth, messageWidth } = computeWidths({ label, message })
-  labelWidth += 10 + totalLogoWidth
-  messageWidth += 10
-  messageWidth -= 4
-
-  const labelTextX = ((labelWidth + totalLogoWidth) / 2) * 10
-  const labelTextLength = (labelWidth - (10 + totalLogoWidth)) * 10
-  const escapedLabel = escapeXml(label)
+  const font = 'bold 11px Helvetica'
+  const labelTextWidth = preferredWidthOf(label, { font })
+  const messageTextWidth = preferredWidthOf(message, { font })
+  const labelRectWidth = labelTextWidth + totalLogoWidth + 2 * labelHorizPadding
+  const messageRectWidth = messageTextWidth + 2 * messageHorizPadding
 
   let [leftLink, rightLink] = links
   leftLink = escapeXml(leftLink)
@@ -500,29 +478,35 @@ function social({
   const accessibleText = createAccessibleText({ label, message })
 
   function renderMessageBubble() {
-    const messageBubbleMainX = labelWidth + 6.5
-    const messageBubbleNotchX = labelWidth + 6
+    const messageBubbleMainX = labelRectWidth + horizGutter + 0.5
+    const messageBubbleNotchX = labelRectWidth + horizGutter
     return `
-      <rect x="${messageBubbleMainX}" y="0.5" width="${messageWidth}" height="${internalHeight}" rx="2" fill="#fafafa"/>
+      <rect x="${messageBubbleMainX}" y="0.5" width="${messageRectWidth}" height="${internalHeight}" rx="2" fill="#fafafa"/>
       <rect x="${messageBubbleNotchX}" y="7.5" width="0.5" height="5" stroke="#fafafa"/>
       <path d="M${messageBubbleMainX} 6.5 l-3 3v1 l3 3" stroke="d5d5d5" fill="#fafafa"/>
     `
   }
 
   function renderLabelText() {
-    const rect = `<rect id="llink" stroke="#d5d5d5" fill="url(#a)" x=".5" y=".5" width="${labelWidth}" height="${internalHeight}" rx="2" />`
+    const labelTextX =
+      10 * (totalLogoWidth + labelTextWidth / 2 + labelHorizPadding)
+    const labelTextLength = 10 * labelTextWidth
+    const escapedLabel = escapeXml(label)
+    const shouldWrapWithLink = hasLeftLink && !shouldWrapBodyWithLink({ links })
+
+    const rect = `<rect id="llink" stroke="#d5d5d5" fill="url(#a)" x=".5" y=".5" width="${labelRectWidth}" height="${internalHeight}" rx="2" />`
     const shadow = `<text aria-hidden="true" x="${labelTextX}" y="150" fill="#fff" transform="scale(.1)" textLength="${labelTextLength}">${escapedLabel}</text>`
     const text = `<text x="${labelTextX}" y="140" transform="scale(.1)" textLength="${labelTextLength}">${escapedLabel}</text>`
-    if (hasLeftLink && !shouldWrapBodyWithLink({ links })) {
-      return `
+
+    return shouldWrapWithLink
+      ? `
         <a target="_blank" xlink:href="${leftLink}">
           ${shadow}
           ${text}
           ${rect}
         </a>
       `
-    }
-    return `
+      : `
       ${rect}
       ${shadow}
       ${text}
@@ -530,34 +514,36 @@ function social({
   }
 
   function renderMessageText() {
-    const messageTextX = (labelWidth + messageWidth / 2 + 6) * 10
-    const messageTextLength = (messageWidth - 8) * 10
+    const messageTextX =
+      10 * (labelRectWidth + horizGutter + messageRectWidth / 2)
+    const messageTextLength = 10 * messageTextWidth
     const escapedMessage = escapeXml(message)
-    const rect = `<rect width="${messageWidth + 1}" x="${
-      labelWidth + 6
+
+    const rect = `<rect width="${messageRectWidth + 1}" x="${
+      labelRectWidth + horizGutter
     }" height="${internalHeight + 1}" fill="rgba(0,0,0,0)" />`
     const shadow = `<text aria-hidden="true" x="${messageTextX}" y="150" fill="#fff" transform="scale(.1)" textLength="${messageTextLength}">${escapedMessage}</text>`
     const text = `<text id="rlink" x="${messageTextX}" y="140" transform="scale(.1)" textLength="${messageTextLength}">${escapedMessage}</text>`
-    if (hasRightLink) {
-      return `
+
+    return hasRightLink
+      ? `
         <a target="_blank" xlink:href="${rightLink}">
           ${rect}
           ${shadow}
           ${text}
         </a>
       `
-    }
-    return `
+      : `
       ${shadow}
       ${text}
     `
   }
 
-  const badge = renderBadge(
+  return renderBadge(
     {
       links,
-      leftWidth: labelWidth + 1,
-      rightWidth: hasMessage ? messageWidth + 6 : 0,
+      leftWidth: labelRectWidth + 1,
+      rightWidth: hasMessage ? horizGutter + messageRectWidth : 0,
       accessibleText,
       height: externalHeight,
     },
@@ -572,7 +558,7 @@ function social({
       <stop offset="1" stop-opacity=".1"/>
     </linearGradient>
     <g stroke="#d5d5d5">
-      <rect stroke="none" fill="#fcfcfc" x="0.5" y="0.5" width="${labelWidth}" height="${internalHeight}" rx="2"/>
+      <rect stroke="none" fill="#fcfcfc" x="0.5" y="0.5" width="${labelRectWidth}" height="${internalHeight}" rx="2"/>
       ${hasMessage ? renderMessageBubble() : ''}
     </g>
     ${renderedLogo}
@@ -582,11 +568,6 @@ function social({
     </g>
     `
   )
-
-  if (minify) {
-    return stripXmlWhitespace(badge)
-  }
-  return badge
 }
 
 function forTheBadge({
@@ -598,14 +579,15 @@ function forTheBadge({
   logoPadding,
   color = '#4c1',
   labelColor,
-  minify,
 }) {
   // For the Badge is styled in all caps. Convert to caps here so widths can
   // be measured using the correct characters.
   label = label.toUpperCase()
   message = message.toUpperCase()
 
-  let { labelWidth, messageWidth } = computeWidths({ label, message })
+  let labelWidth = preferredWidthOf(label, { font: '10px Verdana' }) || 0
+  let messageWidth =
+    preferredWidthOf(message, { font: 'bold 10px Verdana' }) || 0
   const height = 28
   const hasLabel = label.length || labelColor
   if (labelColor == null) {
@@ -622,7 +604,9 @@ function forTheBadge({
 
   labelWidth += 10 + totalLogoWidth
   if (label.length) {
-    labelWidth += 10 + label.length * 1.5
+    // Add 10 px of padding, plus approximately 1 px of letter spacing per
+    // character.
+    labelWidth += 10 + 2 * label.length
   } else if (hasLogo) {
     if (hasLabel) {
       labelWidth += 7
@@ -633,8 +617,9 @@ function forTheBadge({
     labelWidth -= 11
   }
 
-  messageWidth += 10
-  messageWidth += 10 + message.length * 2
+  // Add 20 px of padding, plus approximately 1.5 px of letter spacing per
+  // character.
+  messageWidth += 20 + 1.5 * message.length
   const leftWidth = hasLogo && !hasLabel ? 0 : labelWidth
   const rightWidth =
     hasLogo && !hasLabel ? messageWidth + labelWidth : messageWidth
@@ -652,10 +637,13 @@ function forTheBadge({
   const accessibleText = createAccessibleText({ label, message })
 
   function renderLabelText() {
+    const { textColor } = colorsForBackground(labelColor)
     const labelTextX = ((labelWidth + totalLogoWidth) / 2) * 10
     const labelTextLength = (labelWidth - (24 + totalLogoWidth)) * 10
     const escapedLabel = escapeXml(label)
-    const text = `<text fill="#fff" x="${labelTextX}" y="175" transform="scale(.1)" textLength="${labelTextLength}">${escapedLabel}</text>`
+
+    const text = `<text fill="${textColor}" x="${labelTextX}" y="175" transform="scale(.1)" textLength="${labelTextLength}">${escapedLabel}</text>`
+
     if (hasLeftLink && !shouldWrapBodyWithLink({ links })) {
       return `
         <a target="_blank" xlink:href="${leftLink}">
@@ -663,17 +651,21 @@ function forTheBadge({
           ${text}
         </a>
       `
+    } else {
+      return text
     }
-    return text
   }
 
   function renderMessageText() {
-    const text = `<text fill="#fff" x="${
+    const { textColor } = colorsForBackground(color)
+
+    const text = `<text fill="${textColor}" x="${
       (labelWidth + messageWidth / 2) * 10
     }" y="175" font-weight="bold" transform="scale(.1)" textLength="${
       (messageWidth - 24) * 10
     }">
       ${escapeXml(message)}</text>`
+
     if (hasRightLink) {
       return `
         <a target="_blank" xlink:href="${rightLink}">
@@ -681,11 +673,12 @@ function forTheBadge({
           ${text}
         </a>
       `
+    } else {
+      return text
     }
-    return text
   }
 
-  const badge = renderBadge(
+  return renderBadge(
     {
       links,
       leftWidth,
@@ -704,11 +697,12 @@ function forTheBadge({
       ${renderMessageText()}
     </g>`
   )
-
-  if (minify) {
-    return stripXmlWhitespace(badge)
-  }
-  return badge
 }
 
-module.exports = { plastic, flat, flatSquare, social, forTheBadge }
+module.exports = {
+  plastic: params => Plastic.render(params),
+  flat: params => Flat.render(params),
+  'flat-square': params => FlatSquare.render(params),
+  social,
+  'for-the-badge': forTheBadge,
+}

badge-maker/lib/color.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const isCSSColor = require('is-css-color')
+const { fromString } = require('css-color-converter')
 
 // When updating these, be sure also to update the list in `badge-maker/README.md`.
 const namedColors = {
@@ -37,6 +37,10 @@ function isHexColor(s = '') {
   return hexColorRegex.test(s)
 }
 
+function isCSSColor(color) {
+  return typeof color === 'string' && fromString(color.trim())
+}
+
 function normalizeColor(color) {
   if (color === undefined) {
     return undefined
@@ -64,9 +68,21 @@ function toSvgColor(color) {
   }
 }
 
+function brightness(color) {
+  if (color) {
+    const cssColor = fromString(color)
+    if (cssColor) {
+      const rgb = cssColor.toRgbaArray()
+      return +((rgb[0] * 299 + rgb[1] * 587 + rgb[2] * 114) / 255000).toFixed(2)
+    }
+  }
+  return 0
+}
+
 module.exports = {
   namedColors,
   isHexColor,
   normalizeColor,
   toSvgColor,
+  brightness,
 }

badge-maker/lib/color.spec.js

@@ -1,7 +1,12 @@
 'use strict'
 
 const { test, given, forCases } = require('sazerac')
-const { isHexColor, normalizeColor, toSvgColor } = require('./color')
+const {
+  isHexColor,
+  normalizeColor,
+  toSvgColor,
+  brightness,
+} = require('./color')
 
 test(isHexColor, () => {
   forCases([given('f00bae'), given('4c1'), given('ABC123')]).expect(true)
@@ -23,15 +28,35 @@ test(normalizeColor, () => {
   given('4c1').expect('#4c1')
   given('f00f00').expect('#f00f00')
   given('ABC123').expect('#abc123')
+  given('#ccc').expect('#ccc')
+  given('#fffe').expect('#fffe')
+  given('#fffeffff').expect('#fffeffff')
   given('#ABC123').expect('#abc123')
   given('papayawhip').expect('papayawhip')
   given('purple').expect('purple')
+  given('  blue ').expect('  blue ')
+  given('rgb(100%, 200%, 222%)').expect('rgb(100%, 200%, 222%)')
+  given('rgb(122, 200, 222)').expect('rgb(122, 200, 222)')
+  given('rgb(122, 200, 222, 1)').expect('rgb(122, 200, 222, 1)')
+  given('rgba(100, 20, 111, 1)').expect('rgba(100, 20, 111, 1)')
+  given('hsl(122, 200%, 222%)').expect('hsl(122, 200%, 222%)')
+  given('hsla(122, 200%, 222%, 1)').expect('hsla(122, 200%, 222%, 1)')
   forCases([
+    given(),
     given(''),
     given('not-a-color'),
+    given('#ABCFGH'),
+    given('rgb(-100, 20, 111)'),
+    given('rgb(100%, 200, 222)'),
+    given('rgba(-100, 20, 111, 1.1)'),
+    given('hsl(122, 200, 222, 1)'),
+    given('hsl(122, 200, 222)'),
+    given('hsl(122, 200, 222%)'),
     given(undefined),
     given(null),
     given(true),
+    given(1),
+    given(Math),
     given([]),
     given({}),
     given(() => {}),
@@ -55,3 +80,12 @@ test(toSvgColor, () => {
   given('lightgray').expect('#9f9f9f')
   given('informational').expect('#007ec6')
 })
+
+test(brightness, () => {
+  given('white').expect(1)
+  given('black').expect(0)
+  given('#abc123').expect(0.66)
+  given('rgb(10, 5, 128)').expect(0.08)
+  given(undefined).expect(0)
+  given('not-a-color').expect(0)
+})

badge-maker/lib/index.js

@@ -51,14 +51,8 @@ function _clean(format) {
     }
   })
 
-  // convert "public" format to "internal" format
-  cleaned.text = [cleaned.label || '', cleaned.message]
-  delete cleaned.label
-  delete cleaned.message
-  if ('style' in cleaned) {
-    cleaned.template = cleaned.style
-    delete cleaned.style
-  }
+  // Legacy.
+  cleaned.label = cleaned.label || ''
 
   return cleaned
 }

badge-maker/lib/make-badge.js

@@ -1,17 +1,21 @@
 'use strict'
 
-const camelcase = require('camelcase')
 const { normalizeColor, toSvgColor } = require('./color')
 const badgeRenderers = require('./badge-renderers')
 
+function stripXmlWhitespace(xml) {
+  return xml.replace(/>\s+/g, '>').replace(/<\s+/g, '<').trim()
+}
+
 /*
 note: makeBadge() is fairly thinly wrapped so if we are making changes here
 it is likely this will impact on the package's public interface in index.js
 */
 module.exports = function makeBadge({
   format,
-  template = 'flat',
-  text,
+  style = 'flat',
+  label,
+  message,
   color,
   labelColor,
   logo,
@@ -19,13 +23,13 @@ module.exports = function makeBadge({
   logoWidth,
   links = ['', ''],
 }) {
+  if (!logo && (logoPosition !== undefined || logoWidth !== undefined)) {
+    throw Error('`logoPosition` and `logoWidth` require `logo`')
+  }
+
   // String coercion and whitespace removal.
-  text = text.map(value => `${value}`.trim())
-
-  const [label, message] = text
-
-  color = normalizeColor(color)
-  labelColor = normalizeColor(labelColor)
+  label = `${label}`.trim()
+  message = `${message}`.trim()
 
   // This ought to be the responsibility of the server, not `makeBadge`.
   if (format === 'json') {
@@ -33,32 +37,34 @@ module.exports = function makeBadge({
       label,
       message,
       logoWidth,
-      color,
-      labelColor,
+      // Only call normalizeColor for the JSON case: this is handled
+      // internally by toSvgColor in the SVG case.
+      color: normalizeColor(color),
+      labelColor: normalizeColor(labelColor),
       link: links,
       name: label,
       value: message,
     })
   }
 
-  const methodName = camelcase(template)
-  if (!(methodName in badgeRenderers)) {
-    throw new Error(`Unknown template: '${template}'`)
+  const render = badgeRenderers[style]
+  if (!render) {
+    throw new Error(`Unknown badge style: '${style}'`)
   }
-  const render = badgeRenderers[methodName]
 
   logoWidth = +logoWidth || (logo ? 14 : 0)
 
-  return render({
-    label,
-    message,
-    links,
-    logo,
-    logoPosition,
-    logoWidth,
-    logoPadding: logo && label.length ? 3 : 0,
-    color: toSvgColor(color),
-    labelColor: toSvgColor(labelColor),
-    minify: true,
-  })
+  return stripXmlWhitespace(
+    render({
+      label,
+      message,
+      links,
+      logo,
+      logoPosition,
+      logoWidth,
+      logoPadding: logo && label.length ? 3 : 0,
+      color: toSvgColor(color),
+      labelColor: toSvgColor(labelColor),
+    })
+  )
 }

badge-maker/lib/make-badge.spec.js

@@ -4,12 +4,18 @@ const { test, given, forCases } = require('sazerac')
 const { expect } = require('chai')
 const snapshot = require('snap-shot-it')
 const isSvg = require('is-svg')
+const prettier = require('prettier')
 const makeBadge = require('./make-badge')
 
+function expectBadgeToMatchSnapshot(format) {
+  snapshot(prettier.format(makeBadge(format), { parser: 'html' }))
+}
+
 function testColor(color = '', colorAttr = 'color') {
   return JSON.parse(
     makeBadge({
-      text: ['name', 'Bob'],
+      label: 'name',
+      message: 'Bob',
       [colorAttr]: color,
       format: 'json',
     })
@@ -34,10 +40,14 @@ describe('The badge generator', function () {
       ]).expect('#abc123')
       // valid rgb(a)
       given('rgb(0,128,255)').expect('rgb(0,128,255)')
+      given('rgb(220,128,255,0.5)').expect('rgb(220,128,255,0.5)')
+      given('rgba(0,0,255)').expect('rgba(0,0,255)')
       given('rgba(0,128,255,0)').expect('rgba(0,128,255,0)')
       // valid hsl(a)
       given('hsl(100, 56%, 10%)').expect('hsl(100, 56%, 10%)')
+      given('hsl(360,50%,50%,0.5)').expect('hsl(360,50%,50%,0.5)')
       given('hsla(25,20%,0%,0.1)').expect('hsla(25,20%,0%,0.1)')
+      given('hsla(0,50%,101%)').expect('hsla(0,50%,101%)')
       // CSS named color.
       given('papayawhip').expect('papayawhip')
       // Shields named color.
@@ -53,12 +63,6 @@ describe('The badge generator', function () {
         // invalid hex
         given('#123red'), // contains letter above F
         given('#red'), // contains letter above F
-        // invalid rgb(a)
-        given('rgb(220,128,255,0.5)'), // has alpha
-        given('rgba(0,0,255)'), // no alpha
-        // invalid hsl(a)
-        given('hsl(360,50%,50%,0.5)'), // has alpha
-        given('hsla(0,50%,101%)'), // no alpha
         // neither a css named color nor colorscheme
         given('notacolor'),
         given('bluish'),
@@ -77,23 +81,26 @@ describe('The badge generator', function () {
 
   describe('SVG', function () {
     it('should produce SVG', function () {
-      const svg = makeBadge({ text: ['cactus', 'grown'], format: 'svg' })
-      expect(svg)
+      expect(makeBadge({ label: 'cactus', message: 'grown', format: 'svg' }))
         .to.satisfy(isSvg)
         .and.to.include('cactus')
         .and.to.include('grown')
     })
 
     it('should match snapshot', function () {
-      const svg = makeBadge({ text: ['cactus', 'grown'], format: 'svg' })
-      snapshot(svg)
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+      })
     })
   })
 
   describe('JSON', function () {
     it('should produce the expected JSON', function () {
       const json = makeBadge({
-        text: ['cactus', 'grown'],
+        label: 'cactus',
+        message: 'grown',
         format: 'json',
         links: ['https://example.com/', 'https://other.example.com/'],
       })
@@ -106,458 +113,471 @@ describe('The badge generator', function () {
       })
     })
 
-    it('should replace undefined svg template with "flat"', function () {
+    it('should replace undefined svg badge style with "flat"', function () {
       const jsonBadgeWithUnknownStyle = makeBadge({
-        text: ['name', 'Bob'],
+        label: 'name',
+        message: 'Bob',
         format: 'svg',
       })
       const jsonBadgeWithDefaultStyle = makeBadge({
-        text: ['name', 'Bob'],
+        label: 'name',
+        message: 'Bob',
         format: 'svg',
-        template: 'flat',
+        style: 'flat',
       })
       expect(jsonBadgeWithUnknownStyle)
         .to.equal(jsonBadgeWithDefaultStyle)
         .and.to.satisfy(isSvg)
     })
 
-    it('should fail with unknown svg template', function () {
+    it('should fail with unknown svg badge style', function () {
       expect(() =>
         makeBadge({
-          text: ['name', 'Bob'],
+          label: 'name',
+          message: 'Bob',
           format: 'svg',
-          template: 'unknown_style',
+          style: 'unknown_style',
         })
-      ).to.throw(Error, "Unknown template: 'unknown_style'")
+      ).to.throw(Error, "Unknown badge style: 'unknown_style'")
     })
   })
 
   describe('"flat" template badge generation', function () {
     it('should match snapshots: message/label, no logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-          labelColor: '#0f0',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
     })
 
     it('should match snapshots: message/label, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message only, no logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+      })
     })
 
     it('should match snapshots: message only, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message only, with logo and labelColor', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message/label, with links', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat',
-          color: '#b3e',
-          labelColor: '#0f0',
-          links: ['https://shields.io/', 'https://www.google.co.uk/'],
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#b3e',
+        labelColor: '#0f0',
+        links: ['https://shields.io/', 'https://www.google.co.uk/'],
+      })
     })
   })
 
   describe('"flat-square" template badge generation', function () {
     it('should match snapshots: message/label, no logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-          labelColor: '#0f0',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
     })
 
     it('should match snapshots: message/label, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message only, no logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+      })
     })
 
     it('should match snapshots: message only, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message only, with logo and labelColor', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message/label, with links', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'flat-square',
-          color: '#b3e',
-          labelColor: '#0f0',
-          links: ['https://shields.io/', 'https://www.google.co.uk/'],
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat-square',
+        color: '#b3e',
+        labelColor: '#0f0',
+        links: ['https://shields.io/', 'https://www.google.co.uk/'],
+      })
     })
   })
 
   describe('"plastic" template badge generation', function () {
     it('should match snapshots: message/label, no logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-          labelColor: '#0f0',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
     })
 
     it('should match snapshots: message/label, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message only, no logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+      })
     })
 
     it('should match snapshots: message only, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message only, with logo and labelColor', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message/label, with links', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'plastic',
-          color: '#b3e',
-          labelColor: '#0f0',
-          links: ['https://shields.io/', 'https://www.google.co.uk/'],
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'plastic',
+        color: '#b3e',
+        labelColor: '#0f0',
+        links: ['https://shields.io/', 'https://www.google.co.uk/'],
+      })
     })
   })
 
   describe('"for-the-badge" template badge generation', function () {
     // https://github.com/badges/shields/issues/1280
     it('numbers should produce a string', function () {
-      const svg = makeBadge({
-        text: [1998, 1999],
-        format: 'svg',
-        template: 'for-the-badge',
-      })
-      expect(svg).to.include('1998').and.to.include('1999')
+      expect(
+        makeBadge({
+          label: 1998,
+          message: 1999,
+          format: 'svg',
+          style: 'for-the-badge',
+        })
+      )
+        .to.include('1998')
+        .and.to.include('1999')
     })
 
     it('lowercase/mixedcase string should produce uppercase string', function () {
-      const svg = makeBadge({
-        text: ['Label', '1 string'],
-        format: 'svg',
-        template: 'for-the-badge',
-      })
-      expect(svg).to.include('LABEL').and.to.include('1 STRING')
+      expect(
+        makeBadge({
+          label: 'Label',
+          message: '1 string',
+          format: 'svg',
+          style: 'for-the-badge',
+        })
+      )
+        .to.include('LABEL')
+        .and.to.include('1 STRING')
     })
 
     it('should match snapshots: message/label, no logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-          labelColor: '#0f0',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
     })
 
     it('should match snapshots: message/label, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message only, no logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+      })
     })
 
     it('should match snapshots: message only, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message only, with logo and labelColor', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message/label, with links', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'for-the-badge',
-          color: '#b3e',
-          labelColor: '#0f0',
-          links: ['https://shields.io/', 'https://www.google.co.uk/'],
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#b3e',
+        labelColor: '#0f0',
+        links: ['https://shields.io/', 'https://www.google.co.uk/'],
+      })
     })
   })
 
   describe('"social" template badge generation', function () {
     it('should produce capitalized string for badge key', function () {
-      const svg = makeBadge({
-        text: ['some-key', 'some-value'],
-        format: 'svg',
-        template: 'social',
-      })
-      expect(svg).to.include('Some-key').and.to.include('some-value')
+      expect(
+        makeBadge({
+          label: 'some-key',
+          message: 'some-value',
+          format: 'svg',
+          style: 'social',
+        })
+      )
+        .to.include('Some-key')
+        .and.to.include('some-value')
     })
 
     // https://github.com/badges/shields/issues/1606
     it('should handle empty strings used as badge keys', function () {
-      const svg = makeBadge({
-        text: ['', 'some-value'],
-        format: 'json',
-        template: 'social',
-      })
-      expect(svg).to.include('""').and.to.include('some-value')
+      expect(
+        makeBadge({
+          label: '',
+          message: 'some-value',
+          format: 'json',
+          style: 'social',
+        })
+      )
+        .to.include('""')
+        .and.to.include('some-value')
     })
 
     it('should match snapshots: message/label, no logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-          labelColor: '#0f0',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+        labelColor: '#0f0',
+      })
     })
 
     it('should match snapshots: message/label, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message only, no logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+      })
     })
 
     it('should match snapshots: message only, with logo', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message only, with logo and labelColor', function () {
-      snapshot(
-        makeBadge({
-          text: ['', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-          labelColor: '#0f0',
-          logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: '',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+        labelColor: '#0f0',
+        logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
+      })
     })
 
     it('should match snapshots: message/label, with links', function () {
-      snapshot(
-        makeBadge({
-          text: ['cactus', 'grown'],
-          format: 'svg',
-          template: 'social',
-          color: '#b3e',
-          labelColor: '#0f0',
-          links: ['https://shields.io/', 'https://www.google.co.uk/'],
-        })
-      )
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'social',
+        color: '#b3e',
+        labelColor: '#0f0',
+        links: ['https://shields.io/', 'https://www.google.co.uk/'],
+      })
     })
   })
 
   describe('badges with logos should always produce the same badge', function () {
     it('badge with logo', function () {
-      const svg = makeBadge({
-        text: ['label', 'message'],
+      expectBadgeToMatchSnapshot({
+        label: 'label',
+        message: 'message',
         format: 'svg',
         logo: 'data:image/svg+xml;base64,PHN2ZyB4bWxu',
       })
-      snapshot(svg)
+    })
+  })
+
+  describe('text colors', function () {
+    it('should use black text when the label color is light', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'flat',
+        color: '#000',
+        labelColor: '#f3f3f3',
+      })
+    })
+
+    it('should use black text when the message color is light', function () {
+      expectBadgeToMatchSnapshot({
+        label: 'cactus',
+        message: 'grown',
+        format: 'svg',
+        style: 'for-the-badge',
+        color: '#e2ffe1',
+        labelColor: '#000',
+      })
     })
   })
 })

badge-maker/package.json

@@ -1,6 +1,6 @@
 {
   "name": "badge-maker",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Shields.io badge library",
   "keywords": [
     "GitHub",
@@ -35,9 +35,8 @@
     "logo": "https://opencollective.com/opencollective/logo.txt"
   },
   "dependencies": {
-    "anafanafo": "^1.0.0",
-    "camelcase": "^6.0.0",
-    "is-css-color": "^1.0.0"
+    "anafanafo": "2.0.0",
+    "css-color-converter": "^2.0.0"
   },
   "scripts": {
     "test": "echo 'Run tests from parent dir'; false"

config/custom-environment-variables.yml

@@ -30,9 +30,6 @@ public:
       __name: 'ALLOWED_ORIGIN'
       __format: 'json'
 
-  persistence:
-    dir: 'PERSISTENCE_DIR'
-
   services:
     bitbucketServer:
       authorizedOrigins: 'BITBUCKET_SERVER_ORIGINS'
@@ -64,7 +61,7 @@ public:
 
   fetchLimit: 'FETCH_LIMIT'
 
-  shieldsProductionHerokuHacks: 'SHIELDS_PRODUCTION_HEROKU_HACKS'
+  requireCloudflare: 'REQUIRE_CLOUDFLARE'
 
 private:
   azure_devops_token: 'AZURE_DEVOPS_TOKEN'
@@ -74,6 +71,7 @@ private:
   bitbucket_password: 'BITBUCKET_PASS'
   bitbucket_server_username: 'BITBUCKET_SERVER_USER'
   bitbucket_server_password: 'BITBUCKET_SERVER_PASS'
+  discord_bot_token: 'DISCORD_BOT_TOKEN'
   drone_token: 'DRONE_TOKEN'
   gh_client_id: 'GH_CLIENT_ID'
   gh_client_secret: 'GH_CLIENT_SECRET'

config/default.yml

@@ -16,9 +16,6 @@ public:
   cors:
     allowedOrigin: []
 
-  persistence:
-    dir: './private'
-
   services:
     github:
       baseUri: 'https://api.github.com/'
@@ -36,6 +33,6 @@ public:
 
   fetchLimit: '10MB'
 
-  shieldsProductionHerokuHacks: false
+  requireCloudflare: false
 
 private: {}

config/local-shields-io-production.template.yml

@@ -1,5 +1,6 @@
 private:
   # These are the keys which are set on the production servers.
+  discord_bot_token: ...
   gh_client_id: ...
   gh_client_secret: ...
   redis_url: ...

config/shields-io-production.yml

@@ -18,7 +18,3 @@ public:
   redirectUrl: 'https://shields.io/'
 
   rasterUrl: 'https://raster.shields.io'
-
-private:
-  # These are not really private; they should be moved to `public`.
-  shields_ips: ['192.99.59.72', '51.254.114.150', '149.56.96.133']

core/base-service/auth-helper.js

@@ -146,9 +146,11 @@ class AuthHelper {
     )
   }
 
-  get _bearerAuthHeader() {
+  _bearerAuthHeader(bearerKey) {
     const { _pass: pass } = this
-    return this.isConfigured ? { Authorization: `Bearer ${pass}` } : undefined
+    return this.isConfigured
+      ? { Authorization: `${bearerKey} ${pass}` }
+      : undefined
   }
 
   static _mergeHeaders(requestParams, headers) {
@@ -168,9 +170,15 @@ class AuthHelper {
     }
   }
 
-  withBearerAuthHeader(requestParams) {
+  withBearerAuthHeader(
+    requestParams,
+    bearerKey = 'Bearer' // lgtm [js/hardcoded-credentials]
+  ) {
     return this._withAnyAuth(requestParams, requestParams =>
-      this.constructor._mergeHeaders(requestParams, this._bearerAuthHeader)
+      this.constructor._mergeHeaders(
+        requestParams,
+        this._bearerAuthHeader(bearerKey)
+      )
     )
   }
 

core/base-service/base-graphql.js

@@ -46,6 +46,9 @@ class BaseGraphqlService extends BaseService {
    *    and custom error messages e.g: `{ 404: 'package not found' }`.
    *    This can be used to extend or override the
    *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
+   * @param {Function} [attrs.transformJson=data => data] Function which takes the raw json and transforms it before
+   * further procesing. In case of multiple query in a single graphql call and few of them
+   * throw error, partial data might be used ignoring the error.
    * @param {Function} [attrs.transformErrors=defaultTransformErrors]
    *    Function which takes an errors object from a GraphQL
    *    response and returns an instance of ShieldsRuntimeError.
@@ -61,6 +64,7 @@ class BaseGraphqlService extends BaseService {
     variables = {},
     options = {},
     httpErrorMessages = {},
+    transformJson = data => data,
     transformErrors = defaultTransformErrors,
   }) {
     const mergedOptions = {
@@ -74,7 +78,7 @@ class BaseGraphqlService extends BaseService {
       options: mergedOptions,
       errorMessages: httpErrorMessages,
     })
-    const json = this._parseJson(buffer)
+    const json = transformJson(this._parseJson(buffer))
     if (json.errors) {
       const exception = transformErrors(json.errors)
       if (exception instanceof ShieldsRuntimeError) {

core/base-service/base-graphql.spec.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 const gql = require('graphql-tag')
 const sinon = require('sinon')
@@ -12,15 +12,8 @@ const dummySchema = Joi.object({
 }).required()
 
 class DummyGraphqlService extends BaseGraphqlService {
-  static get category() {
-    return 'cat'
-  }
-
-  static get route() {
-    return {
-      base: 'foo',
-    }
-  }
+  static category = 'cat'
+  static route = { base: 'foo' }
 
   async handle() {
     const { requiredString } = await this._requestGraphql({

core/base-service/base-json.spec.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 const sinon = require('sinon')
 const BaseJsonService = require('./base-json')
@@ -10,15 +10,8 @@ const dummySchema = Joi.object({
 }).required()
 
 class DummyJsonService extends BaseJsonService {
-  static get category() {
-    return 'cat'
-  }
-
-  static get route() {
-    return {
-      base: 'foo',
-    }
-  }
+  static category = 'cat'
+  static route = { base: 'foo' }
 
   async handle() {
     const { requiredString } = await this._requestJson({

core/base-service/base-svg-scraping.spec.js

@@ -2,28 +2,17 @@
 
 const { expect } = require('chai')
 const sinon = require('sinon')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const makeBadge = require('../../badge-maker/lib/make-badge')
 const BaseSvgScrapingService = require('./base-svg-scraping')
 
-function makeExampleSvg({ label, message }) {
-  return makeBadge({ text: ['this is the label', 'this is the result!'] })
-}
-
 const schema = Joi.object({
   message: Joi.string().required(),
 }).required()
 
 class DummySvgScrapingService extends BaseSvgScrapingService {
-  static get category() {
-    return 'cat'
-  }
-
-  static get route() {
-    return {
-      base: 'foo',
-    }
-  }
+  static category = 'cat'
+  static route = { base: 'foo' }
 
   async handle() {
     return this._requestSvg({
@@ -36,10 +25,7 @@ class DummySvgScrapingService extends BaseSvgScrapingService {
 describe('BaseSvgScrapingService', function () {
   const exampleLabel = 'this is the label'
   const exampleMessage = 'this is the result!'
-  const exampleSvg = makeExampleSvg({
-    label: exampleLabel,
-    message: exampleMessage,
-  })
+  const exampleSvg = makeBadge({ label: exampleLabel, message: exampleMessage })
 
   describe('valueFromSvgBadge', function () {
     it('should find the correct value', function () {
@@ -123,9 +109,7 @@ describe('BaseSvgScrapingService', function () {
 
     it('allows overriding the valueMatcher', async function () {
       class WithValueMatcher extends BaseSvgScrapingService {
-        static get route() {
-          return {}
-        }
+        static route = {}
 
         async handle() {
           return this._requestSvg({

core/base-service/base-xml.spec.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 const sinon = require('sinon')
 const BaseXmlService = require('./base-xml')
@@ -10,15 +10,8 @@ const dummySchema = Joi.object({
 }).required()
 
 class DummyXmlService extends BaseXmlService {
-  static get category() {
-    return 'cat'
-  }
-
-  static get route() {
-    return {
-      base: 'foo',
-    }
-  }
+  static category = 'cat'
+  static route = { base: 'foo' }
 
   async handle() {
     const { requiredString } = await this._requestXml({
@@ -57,9 +50,7 @@ describe('BaseXmlService', function () {
 
     it('forwards options to _sendAndCacheRequest', async function () {
       class WithCustomOptions extends BaseXmlService {
-        static get route() {
-          return {}
-        }
+        static route = {}
 
         async handle() {
           const { requiredString } = await this._requestXml({

core/base-service/base-yaml.spec.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 const sinon = require('sinon')
 const BaseYamlService = require('./base-yaml')
@@ -10,15 +10,8 @@ const dummySchema = Joi.object({
 }).required()
 
 class DummyYamlService extends BaseYamlService {
-  static get category() {
-    return 'cat'
-  }
-
-  static get route() {
-    return {
-      base: 'foo',
-    }
-  }
+  static category = 'cat'
+  static route = { base: 'foo' }
 
   async handle() {
     const { requiredString } = await this._requestYaml({

core/base-service/base.js

@@ -5,7 +5,7 @@
 
 // See available emoji at http://emoji.muan.co/
 const emojic = require('emojic')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const log = require('../server/log')
 const { AuthHelper } = require('./auth-helper')
 const { MetricHelper, MetricNames } = require('./metric-helper')
@@ -90,9 +90,7 @@ class BaseService {
     throw new Error(`Category not set for ${this.name}`)
   }
 
-  static get isDeprecated() {
-    return false
-  }
+  static isDeprecated = false
 
   /**
    * Route to mount this service on
@@ -119,9 +117,7 @@ class BaseService {
    * @abstract
    * @type {module:core/base-service/base~Auth}
    */
-  static get auth() {
-    return undefined
-  }
+  static auth = undefined
 
   /**
    * Array of Example objects describing example URLs for this service.
@@ -139,9 +135,7 @@ class BaseService {
    * @abstract
    * @type {module:core/base-service/base~Example[]}
    */
-  static get examples() {
-    return []
-  }
+  static examples = []
 
   static get _cacheLength() {
     const cacheLengths = {
@@ -160,9 +154,7 @@ class BaseService {
    *
    * @type {module:core/base-service/base~DefaultBadgeData}
    */
-  static get defaultBadgeData() {
-    return {}
-  }
+  static defaultBadgeData = {}
 
   static render(props) {
     throw new Error(`render() function not implemented for ${this.name}`)
@@ -228,9 +220,7 @@ class BaseService {
     return checkErrorResponse(errorMessages)({ buffer, res })
   }
 
-  static get enabledMetrics() {
-    return []
-  }
+  static enabledMetrics = []
 
   static isMetricEnabled(metricName) {
     return this.enabledMetrics.includes(metricName)

core/base-service/base.spec.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const chai = require('chai')
 const { expect } = chai
 const sinon = require('sinon')
@@ -29,32 +29,19 @@ const queryParamSchema = Joi.object({
   .required()
 
 class DummyService extends BaseService {
-  static get category() {
-    return 'other'
-  }
+  static category = 'other'
+  static route = { base: 'foo', pattern: ':namedParamA', queryParamSchema }
 
-  static get route() {
-    return {
-      base: 'foo',
-      pattern: ':namedParamA',
-      queryParamSchema,
-    }
-  }
+  static examples = [
+    {
+      pattern: ':world',
+      namedParams: { world: 'World' },
+      staticPreview: this.render({ namedParamA: 'foo', queryParamA: 'bar' }),
+      keywords: ['hello'],
+    },
+  ]
 
-  static get examples() {
-    return [
-      {
-        pattern: ':world',
-        namedParams: { world: 'World' },
-        staticPreview: this.render({ namedParamA: 'foo', queryParamA: 'bar' }),
-        keywords: ['hello'],
-      },
-    ]
-  }
-
-  static get defaultBadgeData() {
-    return { label: 'cat', namedLogo: 'appveyor' }
-  }
+  static defaultBadgeData = { label: 'cat', namedLogo: 'appveyor' }
 
   static render({ namedParamA, queryParamA }) {
     return {
@@ -68,9 +55,7 @@ class DummyService extends BaseService {
 }
 
 class DummyServiceWithServiceResponseSizeMetricEnabled extends DummyService {
-  static get enabledMetrics() {
-    return [MetricNames.SERVICE_RESPONSE_SIZE]
-  }
+  static enabledMetrics = [MetricNames.SERVICE_RESPONSE_SIZE]
 }
 
 describe('BaseService', function () {
@@ -124,9 +109,7 @@ describe('BaseService', function () {
     })
 
     class WithRoute extends BaseService {
-      static get route() {
-        return {}
-      }
+      static route = {}
     }
     it('Should throw if handle() is not overridden', function () {
       return expect(WithRoute.invoke({}, {}, {})).to.be.rejectedWith(
@@ -390,9 +373,10 @@ describe('BaseService', function () {
       const expectedFormat = 'svg'
       expect(mockSendBadge).to.have.been.calledOnce
       expect(mockSendBadge).to.have.been.calledWith(expectedFormat, {
-        text: ['cat', 'Hello namedParamA: bar with queryParamA: ?'],
+        label: 'cat',
+        message: 'Hello namedParamA: bar with queryParamA: ?',
         color: 'lightgrey',
-        template: 'flat',
+        style: 'flat',
         namedLogo: undefined,
         logo: undefined,
         logoWidth: undefined,
@@ -567,12 +551,10 @@ describe('BaseService', function () {
   })
   describe('auth', function () {
     class AuthService extends DummyService {
-      static get auth() {
-        return {
-          passKey: 'myci_pass',
-          serviceKey: 'myci',
-          isRequired: true,
-        }
+      static auth = {
+        passKey: 'myci_pass',
+        serviceKey: 'myci',
+        isRequired: true,
       }
 
       async handle() {

core/base-service/cache-headers.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const assert = require('assert')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const coalesce = require('./coalesce')
 
 const serverStartTimeGMTString = new Date().toGMTString()

core/base-service/categories.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const categories = require('../../services/categories')
 
 const isRealCategory = Joi.equal(...categories.map(({ id }) => id)).required()

core/base-service/coalesce-badge.js

@@ -160,12 +160,10 @@ module.exports = function coalesceBadge(
   }
 
   return {
-    text: [
-      // Use `coalesce()` to support empty labels and messages, as in the
-      // static badge.
-      coalesce(overrideLabel, serviceLabel, defaultLabel, category),
-      coalesce(serviceMessage, 'n/a'),
-    ],
+    // Use `coalesce()` to support empty labels and messages, as in the static
+    // badge.
+    label: coalesce(overrideLabel, serviceLabel, defaultLabel, category),
+    message: coalesce(serviceMessage, 'n/a'),
     color: coalesce(
       // In case of an error, disregard user's color override.
       isError ? undefined : overrideColor,
@@ -179,7 +177,7 @@ module.exports = function coalesceBadge(
       serviceLabelColor,
       defaultLabelColor
     ),
-    template: style,
+    style,
     namedLogo,
     logo: logoSvgBase64,
     logoWidth,

core/base-service/coalesce-badge.spec.js

@@ -7,63 +7,61 @@ const coalesceBadge = require('./coalesce-badge')
 describe('coalesceBadge', function () {
   describe('Label', function () {
     it('uses the default label', function () {
-      expect(coalesceBadge({}, {}, { label: 'heyo' }).text).to.deep.equal([
-        'heyo',
-        'n/a',
-      ])
+      expect(coalesceBadge({}, {}, { label: 'heyo' })).to.include({
+        label: 'heyo',
+      })
     })
 
     // This behavior isn't great and we might want to remove it.
     it('uses the category as a default label', function () {
-      expect(
-        coalesceBadge({}, {}, {}, { category: 'cat' }).text
-      ).to.deep.equal(['cat', 'n/a'])
+      expect(coalesceBadge({}, {}, {}, { category: 'cat' })).to.include({
+        label: 'cat',
+      })
     })
 
     it('preserves an empty label', function () {
-      expect(
-        coalesceBadge({}, { label: '', message: '10k' }, {}).text
-      ).to.deep.equal(['', '10k'])
+      expect(coalesceBadge({}, { label: '', message: '10k' }, {})).to.include({
+        label: '',
+      })
     })
 
     it('overrides the label', function () {
       expect(
-        coalesceBadge({ label: 'purr count' }, { label: 'purrs' }, {}).text
-      ).to.deep.equal(['purr count', 'n/a'])
+        coalesceBadge({ label: 'purr count' }, { label: 'purrs' }, {})
+      ).to.include({ label: 'purr count' })
     })
   })
 
   describe('Message', function () {
     it('applies the service message', function () {
-      expect(coalesceBadge({}, { message: '10k' }, {}).text).to.deep.equal([
-        undefined,
-        '10k',
-      ])
+      expect(coalesceBadge({}, { message: '10k' }, {})).to.include({
+        message: '10k',
+      })
     })
 
-    it('applies a numeric service message', function () {
+    // https://github.com/badges/shields/issues/1280
+    it('converts a number to a string', function () {
       // While a number of badges use this, in the long run we may want
       // `render()` to always return a string.
-      expect(coalesceBadge({}, { message: 10 }, {}).text).to.deep.equal([
-        undefined,
-        10,
-      ])
+      expect(coalesceBadge({}, { message: 10 }, {})).to.include({
+        message: 10,
+      })
     })
   })
 
   describe('Right color', function () {
     it('uses the default color', function () {
-      expect(coalesceBadge({}, {}, {}).color).to.equal('lightgrey')
+      expect(coalesceBadge({}, {}, {})).to.include({ color: 'lightgrey' })
     })
 
     it('overrides the color', function () {
       expect(
-        coalesceBadge({ color: '10ADED' }, { color: 'red' }, {}).color
-      ).to.equal('10ADED')
+        coalesceBadge({ color: '10ADED' }, { color: 'red' }, {})
+      ).to.include({ color: '10ADED' })
       // also expected for legacy name
       expect(
-        coalesceBadge({ colorB: 'B0ADED' }, { color: 'red' }, {}).color
-      ).to.equal('B0ADED')
+        coalesceBadge({ colorB: 'B0ADED' }, { color: 'red' }, {})
+      ).to.include({ color: 'B0ADED' })
     })
 
     context('In case of an error', function () {
@@ -73,21 +71,23 @@ describe('coalesceBadge', function () {
             { color: '10ADED' },
             { isError: true, color: 'lightgray' },
             {}
-          ).color
-        ).to.equal('lightgray')
+          )
+        ).to.include({ color: 'lightgray' })
         // also expected for legacy name
         expect(
           coalesceBadge(
             { colorB: 'B0ADED' },
             { isError: true, color: 'lightgray' },
             {}
-          ).color
-        ).to.equal('lightgray')
+          )
+        ).to.include({ color: 'lightgray' })
       })
     })
 
     it('applies the service color', function () {
-      expect(coalesceBadge({}, { color: 'red' }, {}).color).to.equal('red')
+      expect(coalesceBadge({}, { color: 'red' }, {})).to.include({
+        color: 'red',
+      })
     })
   })
 
@@ -97,20 +97,19 @@ describe('coalesceBadge', function () {
     })
 
     it('applies the service label color', function () {
-      expect(coalesceBadge({}, { labelColor: 'red' }, {}).labelColor).to.equal(
-        'red'
-      )
+      expect(coalesceBadge({}, { labelColor: 'red' }, {})).to.include({
+        labelColor: 'red',
+      })
     })
 
     it('overrides the label color', function () {
       expect(
         coalesceBadge({ labelColor: '42f483' }, { color: 'green' }, {})
-          .labelColor
-      ).to.equal('42f483')
+      ).to.include({ labelColor: '42f483' })
       // also expected for legacy name
       expect(
-        coalesceBadge({ colorA: 'B2f483' }, { color: 'green' }, {}).labelColor
-      ).to.equal('B2f483')
+        coalesceBadge({ colorA: 'B2f483' }, { color: 'green' }, {})
+      ).to.include({ labelColor: 'B2f483' })
     })
 
     it('converts a query-string numeric color to a string', function () {
@@ -120,8 +119,8 @@ describe('coalesceBadge', function () {
           { color: 123 },
           { color: 'green' },
           {}
-        ).color
-      ).to.equal('123')
+        )
+      ).to.include({ color: '123' })
       // also expected for legacy name
       expect(
         coalesceBadge(
@@ -129,8 +128,8 @@ describe('coalesceBadge', function () {
           { colorB: 123 },
           { color: 'green' },
           {}
-        ).color
-      ).to.equal('123')
+        )
+      ).to.include({ color: '123' })
     })
   })
 
@@ -148,9 +147,9 @@ describe('coalesceBadge', function () {
     })
 
     it('applies the named logo', function () {
-      expect(coalesceBadge({}, { namedLogo: 'npm' }, {}).namedLogo).to.equal(
-        'npm'
-      )
+      expect(coalesceBadge({}, { namedLogo: 'npm' }, {})).to.include({
+        namedLogo: 'npm',
+      })
       expect(coalesceBadge({}, { namedLogo: 'npm' }, {}).logo).to.equal(
         getShieldsIcon({ name: 'npm' })
       ).and.not.to.be.empty
@@ -219,8 +218,8 @@ describe('coalesceBadge', function () {
     it('overrides the logo with custom svg', function () {
       const logoSvg = 'data:image/svg+xml;base64,PHN2ZyB4bWxu'
       expect(
-        coalesceBadge({ logo: logoSvg }, { namedLogo: 'appveyor' }, {}).logo
-      ).to.equal(logoSvg)
+        coalesceBadge({ logo: logoSvg }, { namedLogo: 'appveyor' }, {})
+      ).to.include({ logo: logoSvg })
     })
 
     it('ignores the color when custom svg is provided', function () {
@@ -230,35 +229,36 @@ describe('coalesceBadge', function () {
           { logo: logoSvg, logoColor: 'brightgreen' },
           { namedLogo: 'appveyor' },
           {}
-        ).logo
-      ).to.equal(logoSvg)
+        )
+      ).to.include({ logo: logoSvg })
     })
   })
 
   describe('Logo width', function () {
     it('overrides the logoWidth', function () {
-      expect(coalesceBadge({ logoWidth: 20 }, {}, {}).logoWidth).to.equal(20)
+      expect(coalesceBadge({ logoWidth: 20 }, {}, {})).to.include({
+        logoWidth: 20,
+      })
     })
 
     it('applies the logo width', function () {
       expect(
-        coalesceBadge({}, { namedLogo: 'npm', logoWidth: 275 }, {}).logoWidth
-      ).to.equal(275)
+        coalesceBadge({}, { namedLogo: 'npm', logoWidth: 275 }, {})
+      ).to.include({ logoWidth: 275 })
     })
   })
 
   describe('Logo position', function () {
     it('overrides the logoPosition', function () {
-      expect(
-        coalesceBadge({ logoPosition: -10 }, {}, {}).logoPosition
-      ).to.equal(-10)
+      expect(coalesceBadge({ logoPosition: -10 }, {}, {})).to.include({
+        logoPosition: -10,
+      })
     })
 
     it('applies the logo position', function () {
       expect(
         coalesceBadge({}, { namedLogo: 'npm', logoPosition: -10 }, {})
-          .logoPosition
-      ).to.equal(-10)
+      ).to.include({ logoPosition: -10 })
     })
   })
 
@@ -279,20 +279,24 @@ describe('coalesceBadge', function () {
 
   describe('Style', function () {
     it('falls back to flat with invalid style', function () {
-      expect(coalesceBadge({ style: 'pill' }, {}, {}).template).to.equal('flat')
-      expect(coalesceBadge({ style: 7 }, {}, {}).template).to.equal('flat')
-      expect(coalesceBadge({ style: undefined }, {}, {}).template).to.equal(
-        'flat'
-      )
+      expect(coalesceBadge({ style: 'pill' }, {}, {})).to.include({
+        style: 'flat',
+      })
+      expect(coalesceBadge({ style: 7 }, {}, {})).to.include({
+        style: 'flat',
+      })
+      expect(coalesceBadge({ style: undefined }, {}, {})).to.include({
+        style: 'flat',
+      })
     })
 
     it('replaces legacy popout styles', function () {
-      expect(coalesceBadge({ style: 'popout' }, {}, {}).template).to.equal(
-        'flat'
-      )
-      expect(
-        coalesceBadge({ style: 'popout-square' }, {}, {}).template
-      ).to.equal('flat-square')
+      expect(coalesceBadge({ style: 'popout' }, {}, {})).to.include({
+        style: 'flat',
+      })
+      expect(coalesceBadge({ style: 'popout-square' }, {}, {})).to.include({
+        style: 'flat-square',
+      })
     })
   })
 
@@ -300,8 +304,7 @@ describe('coalesceBadge', function () {
     it('overrides the cache length', function () {
       expect(
         coalesceBadge({ style: 'pill' }, { cacheSeconds: 123 }, {})
-          .cacheLengthSeconds
-      ).to.equal(123)
+      ).to.include({ cacheLengthSeconds: 123 })
     })
   })
 })

core/base-service/deprecated-service.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const camelcase = require('camelcase')
 const BaseService = require('./base')
 const { isValidCategory } = require('./categories')
@@ -26,33 +26,17 @@ function deprecatedService(attrs) {
   )
 
   return class DeprecatedService extends BaseService {
-    static get name() {
-      return name
-        ? `Deprecated${name}`
-        : `Deprecated${camelcase(route.base.replace(/\//g, '_'), {
-            pascalCase: true,
-          })}`
-    }
+    static name = name
+      ? `Deprecated${name}`
+      : `Deprecated${camelcase(route.base.replace(/\//g, '_'), {
+          pascalCase: true,
+        })}`
 
-    static get category() {
-      return category
-    }
-
-    static get isDeprecated() {
-      return true
-    }
-
-    static get route() {
-      return route
-    }
-
-    static get examples() {
-      return examples
-    }
-
-    static get defaultBadgeData() {
-      return { label }
-    }
+    static category = category
+    static isDeprecated = true
+    static route = route
+    static examples = examples
+    static defaultBadgeData = { label }
 
     async handle() {
       throw new Deprecated({ prettyMessage: message })

core/base-service/examples.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { pathToRegexp, compile } = require('path-to-regexp')
 const categories = require('../../services/categories')
 const coalesceBadge = require('./coalesce-badge')
@@ -124,12 +124,7 @@ function transformExample(inExample, index, ServiceClass) {
     documentation,
   } = validateExample(inExample, index, ServiceClass)
 
-  const {
-    text: [label, message],
-    color,
-    template: style,
-    namedLogo,
-  } = coalesceBadge(
+  const { label, message, color, style, namedLogo } = coalesceBadge(
     {},
     staticPreview,
     ServiceClass.defaultBadgeData,

core/base-service/legacy-request-handler.js

@@ -107,6 +107,20 @@ function handleRequest(cacheHeaderConfig, handlerOptions) {
   } = handlerOptions
 
   return (queryParams, match, end, ask) => {
+    /*
+    This is here for legacy reasons. The badge server and frontend used to live
+    on two different servers. When we merged them there was a conflict so we
+    did this to avoid moving the endpoint docs to another URL.
+
+    Never ever do this again.
+    */
+    if (match[0] === '/endpoint' && Object.keys(queryParams).length === 0) {
+      ask.res.statusCode = 301
+      ask.res.setHeader('Location', '/endpoint/')
+      ask.res.end()
+      return
+    }
+
     const reqTime = new Date()
 
     // `defaultCacheLengthSeconds` can be overridden by
@@ -254,7 +268,7 @@ function handleRequest(cacheHeaderConfig, handlerOptions) {
         let dataHasChanged = false
         if (
           cached !== undefined &&
-          cached.data.badgeData.text[1] !== badgeData.text[1]
+          cached.data.badgeData.message !== badgeData.message
         ) {
           dataHasChanged = true
         }

core/base-service/loader-test-fixtures/valid-array.fixture.js

@@ -3,28 +3,12 @@
 const BaseJsonService = require('../base-json')
 
 class GoodServiceOne extends BaseJsonService {
-  static get category() {
-    return 'build'
-  }
-
-  static get route() {
-    return {
-      base: 'good',
-      pattern: 'one',
-    }
-  }
+  static category = 'build'
+  static route = { base: 'good', pattern: 'one' }
 }
 class GoodServiceTwo extends BaseJsonService {
-  static get category() {
-    return 'build'
-  }
-
-  static get route() {
-    return {
-      base: 'good',
-      pattern: 'two',
-    }
-  }
+  static category = 'build'
+  static route = { base: 'good', pattern: 'two' }
 }
 
 module.exports = [GoodServiceOne, GoodServiceTwo]

core/base-service/loader-test-fixtures/valid-class.fixture.js

@@ -3,16 +3,8 @@
 const BaseJsonService = require('../base-json')
 
 class GoodService extends BaseJsonService {
-  static get category() {
-    return 'build'
-  }
-
-  static get route() {
-    return {
-      base: 'it/is',
-      pattern: 'good',
-    }
-  }
+  static category = 'build'
+  static route = { base: 'it/is', pattern: 'good' }
 }
 
 module.exports = GoodService

core/base-service/loader-test-fixtures/valid-object.fixture.js

@@ -3,28 +3,12 @@
 const BaseJsonService = require('../base-json')
 
 class GoodServiceOne extends BaseJsonService {
-  static get category() {
-    return 'build'
-  }
-
-  static get route() {
-    return {
-      base: 'good',
-      pattern: 'one',
-    }
-  }
+  static category = 'build'
+  static route = { base: 'good', pattern: 'one' }
 }
 class GoodServiceTwo extends BaseJsonService {
-  static get category() {
-    return 'build'
-  }
-
-  static get route() {
-    return {
-      base: 'good',
-      pattern: 'two',
-    }
-  }
+  static category = 'build'
+  static route = { base: 'good', pattern: 'two' }
 }
 
 module.exports = { GoodServiceOne, GoodServiceTwo }

core/base-service/redirector.js

@@ -2,7 +2,7 @@
 
 const camelcase = require('camelcase')
 const emojic = require('emojic')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const queryString = require('query-string')
 const BaseService = require('./base')
 const {
@@ -41,27 +41,15 @@ module.exports = function redirector(attrs) {
   } = Joi.attempt(attrs, attrSchema, `Redirector for ${attrs.route.base}`)
 
   return class Redirector extends BaseService {
-    static get name() {
-      if (name) {
-        return name
-      } else {
-        return `${camelcase(route.base.replace(/\//g, '_'), {
-          pascalCase: true,
-        })}Redirect`
-      }
-    }
+    static name =
+      name ||
+      `${camelcase(route.base.replace(/\//g, '_'), {
+        pascalCase: true,
+      })}Redirect`
 
-    static get category() {
-      return category
-    }
-
-    static get isDeprecated() {
-      return true
-    }
-
-    static get route() {
-      return route
-    }
+    static category = category
+    static isDeprecated = true
+    static route = route
 
     static register({ camp, metricInstance }, { rasterUrl }) {
       const { regex, captureNames } = prepareRoute({

core/base-service/route.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const escapeStringRegexp = require('escape-string-regexp')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { pathToRegexp } = require('path-to-regexp')
 
 function makeFullUrl(base, partialUrl) {

core/base-service/route.spec.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { expect } = require('chai')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { test, given, forCases } = require('sazerac')
 const {
   prepareRoute,

core/base-service/service-definitions.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 
 // This should be kept in sync with the schema in
 // `frontend/lib/service-definitions/index.ts`.

core/base-service/validate.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const emojic = require('emojic')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const trace = require('./trace')
 
 function validate(

core/base-service/validate.spec.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 const sinon = require('sinon')
 const trace = require('./trace')

core/server/monitor.js

@@ -1,20 +1,6 @@
 'use strict'
 
-const config = require('config').util.toObject()
-const secretIsValid = require('./secret-is-valid')
 const RateLimit = require('./rate-limit')
-const log = require('./log')
-
-function secretInvalid(req, res) {
-  if (!secretIsValid(req.password)) {
-    // An unknown entity tries to connect. Let the connection linger for a minute.
-    setTimeout(() => {
-      res.json({ errors: [{ code: 'invalid_secrets' }] })
-    }, 10000)
-    return true
-  }
-  return false
-}
 
 function setRoutes({ rateLimit }, { server, metricInstance }) {
   const ipRateLimit = new RateLimit({
@@ -29,12 +15,6 @@ function setRoutes({ rateLimit }, { server, metricInstance }) {
   })
 
   server.handle((req, res, next) => {
-    if (req.url.startsWith('/sys/')) {
-      if (secretInvalid(req, res)) {
-        return
-      }
-    }
-
     if (rateLimit) {
       const ip =
         (req.headers['x-forwarded-for'] || '').split(', ')[0] ||
@@ -59,27 +39,6 @@ function setRoutes({ rateLimit }, { server, metricInstance }) {
     next()
   })
 
-  server.get('/sys/network', (req, res) => {
-    res.json({ ips: config.public.shields_ips })
-  })
-
-  server.ws('/sys/logs', socket => {
-    const listener = (...msg) => socket.send(msg.join(' '))
-    socket.on('close', () => log.removeListener(listener))
-    socket.on('message', msg => {
-      let req
-      try {
-        req = JSON.parse(msg)
-      } catch (e) {
-        return
-      }
-      if (!secretIsValid(req.secret)) {
-        return socket.close()
-      }
-      log.addListener(listener)
-    })
-  })
-
   server.get('/sys/rate-limit', (req, res) => {
     res.json({
       ip: ipRateLimit.toJSON(),
@@ -95,6 +54,4 @@ function setRoutes({ rateLimit }, { server, metricInstance }) {
   }
 }
 
-module.exports = {
-  setRoutes,
-}
+module.exports = { setRoutes }

core/server/secret-is-valid.js

@@ -1,7 +1,5 @@
 'use strict'
 
-const serverSecrets = require('../../lib/server-secrets')
-
 function constEq(a, b) {
   if (a.length !== b.length) {
     return false
@@ -13,9 +11,10 @@ function constEq(a, b) {
   return zero === 0
 }
 
-module.exports = function secretIsValid(secret = '') {
-  return (
-    serverSecrets.shields_secret &&
-    constEq(secret, serverSecrets.shields_secret)
-  )
+function makeSecretIsValid(shieldsSecret) {
+  return function secretIsValid(secret = '') {
+    return shieldsSecret && constEq(secret, shieldsSecret)
+  }
 }
+
+module.exports = { makeSecretIsValid }

core/server/server.js

@@ -6,9 +6,10 @@
 const path = require('path')
 const url = require('url')
 const { URL } = url
+const cloudflareMiddleware = require('cloudflare-middleware')
 const bytes = require('bytes')
 const Camp = require('@shields_io/camp')
-const originalJoi = require('@hapi/joi')
+const originalJoi = require('joi')
 const makeBadge = require('../../badge-maker/lib/make-badge')
 const GithubConstellation = require('../../services/github/github-constellation')
 const suggest = require('../../services/suggest')
@@ -117,9 +118,6 @@ const publicConfigSchema = Joi.object({
   cors: {
     allowedOrigin: Joi.array().items(optionalUrl).required(),
   },
-  persistence: {
-    dir: Joi.string().required(),
-  },
   services: Joi.object({
     bitbucketServer: defaultService,
     drone: defaultService,
@@ -148,13 +146,14 @@ const publicConfigSchema = Joi.object({
   rateLimit: Joi.boolean().required(),
   handleInternalErrors: Joi.boolean().required(),
   fetchLimit: Joi.string().regex(/^[0-9]+(b|kb|mb|gb|tb)$/i),
-  shieldsProductionHerokuHacks: Joi.boolean(),
+  requireCloudflare: Joi.boolean().required(),
 }).required()
 
 const privateConfigSchema = Joi.object({
   azure_devops_token: Joi.string(),
   bintray_user: Joi.string(),
   bintray_apikey: Joi.string(),
+  discord_bot_token: Joi.string(),
   drone_token: Joi.string(),
   gh_client_id: Joi.string(),
   gh_client_secret: Joi.string(),
@@ -168,7 +167,6 @@ const privateConfigSchema = Joi.object({
   npm_token: Joi.string(),
   redis_url: Joi.string().uri({ scheme: ['redis', 'rediss'] }),
   sentry_dsn: Joi.string(),
-  shields_ips: Joi.array().items(Joi.string().ip()),
   shields_secret: Joi.string(),
   sl_insight_userUuid: Joi.string(),
   sl_insight_apiToken: Joi.string(),
@@ -186,6 +184,11 @@ const privateMetricsInfluxConfigSchema = privateConfigSchema.append({
   influx_username: Joi.string().required(),
   influx_password: Joi.string().required(),
 })
+
+function addHandlerAtIndex(camp, index, handlerFn) {
+  camp.stack.splice(index, 0, handlerFn)
+}
+
 /**
  * The Server is based on the web framework Scoutcamp. It creates
  * an http server, sets up helpers for token persistence and monitoring.
@@ -224,7 +227,6 @@ class Server {
     }
 
     this.githubConstellation = new GithubConstellation({
-      persistence: publicConfig.persistence,
       service: publicConfig.services.github,
       private: privateConfig,
     })
@@ -278,6 +280,23 @@ class Server {
     })
   }
 
+  // See https://www.viget.com/articles/heroku-cloudflare-the-right-way/
+  requireCloudflare() {
+    // Set `req.ip`, which is expected by `cloudflareMiddleware()`. This is set
+    // by Express but not Scoutcamp.
+    addHandlerAtIndex(this.camp, 0, function (req, res, next) {
+      // On Heroku, `req.socket.remoteAddress` is the Heroku router. However,
+      // the router ensures that the last item in the `X-Forwarded-For` header
+      // is the real origin.
+      // https://stackoverflow.com/a/18517550/893113
+      req.ip = process.env.DYNO
+        ? req.headers['x-forwarded-for'].split(', ').pop()
+        : req.socket.remoteAddress
+      next()
+    })
+    addHandlerAtIndex(this.camp, 1, cloudflareMiddleware())
+  }
+
   /**
    * Set up Scoutcamp routes for 404/not found responses
    */
@@ -295,7 +314,8 @@ class Server {
         end
       )(
         makeBadge({
-          text: ['410', `${format} no longer available`],
+          label: '410',
+          message: `${format} no longer available`,
           color: 'lightgray',
           format: 'svg',
         })
@@ -310,7 +330,8 @@ class Server {
           end
         )(
           makeBadge({
-            text: ['404', 'raster badges not available'],
+            label: '404',
+            message: 'raster badges not available',
             color: 'lightgray',
             format: 'svg',
           })
@@ -328,7 +349,8 @@ class Server {
         end
       )(
         makeBadge({
-          text: ['404', 'badge not found'],
+          label: '404',
+          message: 'badge not found',
           color: 'red',
           format,
         })
@@ -392,8 +414,6 @@ class Server {
           rasterUrl: config.public.rasterUrl,
           private: config.private,
           public: config.public,
-          shieldsProductionHerokuHacks:
-            config.public.shieldsProductionHerokuHacks,
         }
       )
     )
@@ -411,6 +431,7 @@ class Server {
       ssl: { isSecure: secure, cert, key },
       cors: { allowedOrigin },
       rateLimit,
+      requireCloudflare,
     } = this.config.public
 
     log(`Server is starting up: ${this.baseUrl}`)
@@ -424,6 +445,10 @@ class Server {
       key,
     }))
 
+    if (requireCloudflare) {
+      this.requireCloudflare()
+    }
+
     const { metricInstance } = this
     this.cleanupMonitor = sysMonitor.setRoutes(
       { rateLimit },

core/server/server.spec.js

@@ -168,6 +168,28 @@ describe('The server', function () {
     })
   })
 
+  context('`requireCloudflare` is enabled', function () {
+    let server
+    afterEach(async function () {
+      if (server) {
+        server.stop()
+      }
+    })
+
+    it('should reject requests from localhost with an empty 200 response', async function () {
+      this.timeout(10000)
+      server = await createTestServer({ public: { requireCloudflare: true } })
+      await server.start()
+
+      const { statusCode, body } = await got(
+        `${server.baseUrl}badge/foo-bar-blue.svg`
+      )
+
+      expect(statusCode).to.be.equal(200)
+      expect(body).to.equal('')
+    })
+  })
+
   describe('configuration', function () {
     let server
     afterEach(async function () {

core/service-test-runner/icedfrisby-shields.js

@@ -3,7 +3,7 @@
  * @module
  */
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { expect } = require('chai')
 
 /**

core/token-pooling/fs-token-persistence.js

@@ -1,51 +0,0 @@
-'use strict'
-
-const fsos = require('fsos')
-const TokenPersistence = require('./token-persistence')
-
-class FsTokenPersistence extends TokenPersistence {
-  constructor({ path }) {
-    super()
-    this.path = path
-  }
-
-  async initialize() {
-    let contents
-    try {
-      contents = await fsos.get(this.path)
-    } catch (e) {
-      if (e.code === 'ENOENT') {
-        contents = '[]'
-      } else {
-        throw e
-      }
-    }
-
-    const tokens = JSON.parse(contents)
-    this._tokens = new Set(tokens)
-    return tokens
-  }
-
-  async save() {
-    const tokens = Array.from(this._tokens)
-    await fsos.set(this.path, JSON.stringify(tokens))
-  }
-
-  async onTokenAdded(token) {
-    if (!this._tokens) {
-      throw Error('initialize() has not been called')
-    }
-    this._tokens.add(token)
-    await this.save()
-  }
-
-  async onTokenRemoved(token) {
-    if (!this._tokens) {
-      throw Error('initialize() has not been called')
-    }
-    this._tokens.delete(token)
-    await this.save()
-  }
-}
-
-module.exports = FsTokenPersistence

core/token-pooling/fs-token-persistence.spec.js

@@ -1,72 +0,0 @@
-'use strict'
-
-const fs = require('fs')
-const tmp = require('tmp')
-const readFile = require('fs-readfile-promise')
-const { expect } = require('chai')
-const FsTokenPersistence = require('./fs-token-persistence')
-
-describe('File system token persistence', function () {
-  let path, persistence
-  beforeEach(function () {
-    path = tmp.tmpNameSync()
-    persistence = new FsTokenPersistence({ path })
-  })
-
-  context('when the file does not exist', function () {
-    it('does nothing', async function () {
-      const tokens = await persistence.initialize()
-      expect(tokens).to.deep.equal([])
-    })
-
-    it('saving creates an empty file', async function () {
-      await persistence.initialize()
-
-      await persistence.save()
-
-      const json = JSON.parse(await readFile(path))
-      expect(json).to.deep.deep.equal([])
-    })
-  })
-
-  context('when the file exists', function () {
-    const initialTokens = ['a', 'b', 'c'].map(char => char.repeat(40))
-
-    beforeEach(async function () {
-      fs.writeFileSync(path, JSON.stringify(initialTokens))
-    })
-
-    it('loads the contents', async function () {
-      const tokens = await persistence.initialize()
-      expect(tokens).to.deep.equal(initialTokens)
-    })
-
-    context('when tokens are added', function () {
-      it('saves the change', async function () {
-        const newToken = 'e'.repeat(40)
-        const expected = Array.from(initialTokens)
-        expected.push(newToken)
-
-        await persistence.initialize()
-        await persistence.noteTokenAdded(newToken)
-
-        const savedTokens = JSON.parse(await readFile(path))
-        expect(savedTokens).to.deep.equal(expected)
-      })
-    })
-
-    context('when tokens are removed', function () {
-      it('saves the change', async function () {
-        const expected = Array.from(initialTokens)
-        const toRemove = expected.pop()
-
-        await persistence.initialize()
-
-        await persistence.noteTokenRemoved(toRemove)
-
-        const savedTokens = JSON.parse(await readFile(path))
-        expect(savedTokens).to.deep.equal(expected)
-      })
-    })
-  })
-})

core/token-pooling/redis-token-persistence.js

@@ -3,13 +3,13 @@
 const { URL } = require('url')
 const Redis = require('ioredis')
 const log = require('../server/log')
-const TokenPersistence = require('./token-persistence')
 
-module.exports = class RedisTokenPersistence extends TokenPersistence {
+module.exports = class RedisTokenPersistence {
   constructor({ url, key }) {
-    super()
     this.url = url
     this.key = key
+    this.noteTokenAdded = this.noteTokenAdded.bind(this)
+    this.noteTokenRemoved = this.noteTokenRemoved.bind(this)
   }
 
   async initialize() {
@@ -40,4 +40,20 @@ module.exports = class RedisTokenPersistence extends TokenPersistence {
   async onTokenRemoved(token) {
     await this.redis.srem(this.key, token)
   }
+
+  async noteTokenAdded(token) {
+    try {
+      await this.onTokenAdded(token)
+    } catch (e) {
+      log.error(e)
+    }
+  }
+
+  async noteTokenRemoved(token) {
+    try {
+      await this.onTokenRemoved(token)
+    } catch (e) {
+      log.error(e)
+    }
+  }
 }

core/token-pooling/token-persistence.js

@@ -1,44 +0,0 @@
-'use strict'
-
-const log = require('../server/log')
-
-// This is currently bound to the legacy github auth code. That will be
-// replaced with a dependency-injected token provider.
-class TokenPersistence {
-  constructor() {
-    this.noteTokenAdded = this.noteTokenAdded.bind(this)
-    this.noteTokenRemoved = this.noteTokenRemoved.bind(this)
-  }
-
-  async initialize() {
-    throw Error('initialize() is not implemented')
-  }
-
-  async stop() {}
-
-  async onTokenAdded(token) {
-    throw Error('onTokenAdded() is not implemented')
-  }
-
-  async noteTokenAdded(token) {
-    try {
-      await this.onTokenAdded(token)
-    } catch (e) {
-      log.error(e)
-    }
-  }
-
-  async onTokenRemoved(token) {
-    throw Error('onTokenRemoved() is not implemented')
-  }
-
-  async noteTokenRemoved(token) {
-    try {
-      await this.onTokenRemoved(token)
-    } catch (e) {
-      log.error(e)
-    }
-  }
-}
-
-module.exports = TokenPersistence

dangerfile.js

@@ -111,10 +111,7 @@ if (allFiles.length > 100) {
 
     // eslint-disable-next-line promise/prefer-await-to-then
     danger.git.diffForFile(file).then(({ diff }) => {
-      if (
-        (diff.includes('authHelper') || diff.includes('serverSecrets')) &&
-        !secretsDocs.modified
-      ) {
+      if (diff.includes('authHelper') && !secretsDocs.modified) {
         warn(
           [
             `:books: Remember to ensure any changes to \`config.private\` `,
@@ -134,11 +131,11 @@ if (allFiles.length > 100) {
         )
       }
 
-      if (diff.includes("require('joi')")) {
+      if (diff.includes("require('@hapi/joi')")) {
         fail(
           [
-            `Found import of 'joi' in \`${file}\`. <br>`,
-            "Joi must be imported as '@hapi/joi'.",
+            `Found import of '@hapi/joi' in \`${file}\`. <br>`,
+            "Joi must be imported as 'joi'.",
           ].join('')
         )
       }

doc/TUTORIAL.md

@@ -25,7 +25,7 @@ and learn about the [Github workflow](http://try.github.io/).
 
 #### Node, NPM
 
-Node 10 or later is required. If you don't already have them,
+Node 12 or later is required. If you don't already have them,
 install node and npm: https://nodejs.org/en/download/
 
 ### Setup a dev install
@@ -116,17 +116,10 @@ const { BaseService } = require('..')
 // (3)
 module.exports = class Example extends BaseService {
   // (4)
-  static get category() {
-    return 'build'
-  }
+  static category = 'build'
 
   // (5)
-  static get route() {
-    return {
-      base: 'example',
-      pattern: ':text',
-    }
-  }
+  static route = { base: 'example', pattern: ':text' }
 
   // (6)
   async handle({ text }) {
@@ -186,7 +179,7 @@ const { renderVersionBadge } = require('..//version')
 const { BaseJsonService } = require('..')
 
 // (4)
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const schema = Joi.object({
   version: Joi.string().required(),
 }).required()
@@ -194,22 +187,13 @@ const schema = Joi.object({
 // (5)
 module.exports = class GemVersion extends BaseJsonService {
   // (6)
-  static get category() {
-    return 'version'
-  }
+  static category = 'version'
 
   // (7)
-  static get route() {
-    return {
-      base: 'gem/v',
-      pattern: ':gem',
-    }
-  }
+  static route = { base: 'gem/v', pattern: ':gem' }
 
   // (8)
-  static get defaultBadgeData() {
-    return { label: 'gem' }
-  }
+  static defaultBadgeData = { label: 'gem' }
 
   // (11)
   static render({ version }) {
@@ -298,23 +282,19 @@ Once we have implemented our badge, we can add it to the index so that users can
 module.exports = class GemVersion extends BaseJsonService {
   // ...
 
-  static get category() {
-    // (1)
-    return 'version'
-  }
+  // (1)
+  static category = 'version'
 
-  static get examples() {
-    // (2)
-    return [
-      {
-        // (3)
-        title: 'Gem',
-        namedParams: { gem: 'formatador' },
-        staticPreview: this.render({ version: '2.1.0' }),
-        keywords: ['ruby'],
-      },
-    ]
-  }
+  // (2)
+  static examples = [
+    {
+      // (3)
+      title: 'Gem',
+      namedParams: { gem: 'formatador' },
+      staticPreview: this.render({ version: '2.1.0' }),
+      keywords: ['ruby'],
+    },
+  ]
 }
 ```
 
@@ -331,7 +311,7 @@ Save, run `npm start`, and you can see it [locally](http://127.0.0.1:3000/).
 
 If you update `examples`, you don't have to restart the server. Run `npm run defs` in another terminal window and the frontend will update.
 
-### (4.5) Write Tests <!-- Change the link below when you change the heading -->
+### (4.5) Write Tests<!-- Change the link below when you change the heading -->
 
 [write tests]: #45-write-tests
 

doc/production-hosting.md

@@ -34,6 +34,7 @@ Production hosting is managed by the Shields ops team:
 | Cloudflare (CDN)              | Access management               | @espadrine                                                                                 |
 | Cloudflare (CDN)              | Admin access                    | @calebcartwright, @chris48s, @espadrine, @paulmelnikow, @PyvesB                            |
 | Twitch                        | OAuth app                       | @PyvesB                                                                                    |
+| Discord                       | OAuth app                       | @PyvesB                                                                                    |
 | YouTube                       | Account owner                   | @PyvesB                                                                                    |
 | OpenStreetMap (for Wheelmap)  | Account owner                   | @paulmelnikow                                                                              |
 | DNS                           | Account owner                   | @olivierlacan                                                                              |

doc/rewriting-services.md

@@ -17,9 +17,7 @@ Legacy services look like:
 
 ```js
 module.exports = class ExampleService extends LegacyService {
-  static get category() {
-    return 'build'
-  }
+  static category = 'build'
 
   static registerLegacyRouteHandler({ camp, cache }) {
     camp.route(
@@ -101,12 +99,7 @@ tests are passing, though.
 const BaseJsonService = require('../base-json')
 
 class ExampleDownloads extends BaseJsonService {
-  static get route() {
-    return {
-      base: 'example/d',
-      pattern: ':param1/:param2',
-    }
-  }
+  static route = { base: 'example/d', pattern: ':param1/:param2' }
 
   static defaultBadgeData() {
     return { label: 'downloads' } // or whatever
@@ -152,7 +145,7 @@ Once the route is working, fill out `render()` and `handle()`.
 <details>
 
 ```js
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { errorMessagesFor } = require('./github-helpers')
 
 const issueSchema = Joi.object({
@@ -181,7 +174,7 @@ or create an abstract superclass like **PypiBase**:
 <details>
 
 ```js
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const BaseJsonService = require('../base-json')
 
 const schema = Joi.object({

doc/self-hosting.md

@@ -2,7 +2,7 @@
 
 ## Installation
 
-You will need Node 10 or later, which you can install using a
+You will need Node 12 or later, which you can install using a
 [package manager][].
 
 On Ubuntu / Debian:
@@ -184,9 +184,14 @@ Start the server using the Sentry DSN. You can set it:
 sudo SENTRY_DSN=https://xxx:yyy@sentry.io/zzz node server
 ```
 
-- or by `sentry_dsn` secret property defined in `private/secret.json`
+Or via config as you would do with [server secrets](server-secrets.md):
 
+```yml
+private:
+  sentry_dsn: ...
 ```
+
+```sh
 sudo node server
 ```
 
@@ -200,3 +205,9 @@ METRICS_PROMETHEUS_ENABLED=true npm start
 ```
 
 Metrics are available at `/metrics` resource.
+
+### Cloudflare
+
+Shields uses Cloudflare as a downstream CDN. If your installation does the same,
+you can configure your server to only accept requests coming from Cloudflare's IPs.
+Set `public.requireCloudflare: true`.

doc/server-secrets.md

@@ -105,6 +105,15 @@ self-hosted Shields installation access to private repositories hosted on bitbuc
 Bitbucket badges use basic auth. Provide a username and password to give your
 self-hosted Shields installation access to a private Bitbucket Server instance.
 
+### Discord
+
+Using a token for Dicsord is optional but will allow higher API rates.
+
+- `DISCORD_BOT_TOKEN` (yml: `discord_bot_token`)
+
+Register an application in the [Discord developer console](https://discord.com/developers).
+To obtain a token, simply create a bot for your application.
+
 ### Drone
 
 - `DRONE_ORIGINS` (yml: `public.services.drone.authorizedOrigins`)

doc/service-tests.md

@@ -66,7 +66,7 @@ t.create('Build status')
    - Note that when we call our badge, we are allowing it to communicate with an external service without mocking the response. We write tests which interact with external services, which is unusual practice in unit testing. We do this because one of the purposes of service tests is to notify us if a badge has broken due to an upstream API change. For this reason it is important for at least one test to call the live API without mocking the interaction.
    - 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 or a [Joi][] schema for the different fields.
+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
    match based on a set of allowed strings, regexes, or specific values. You can
    refer to their [API reference][joi api].
@@ -82,6 +82,7 @@ harness will call it for you.
 [icedfrisby api]: https://github.com/MarkHerhold/IcedFrisby/blob/master/API.md
 [joi]: https://github.com/hapijs/joi
 [joi api]: https://github.com/hapijs/joi/blob/master/API.md
+[regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
 
 ### (3) Running the Tests
 

frontend/components/development/style-page.tsx

@@ -129,7 +129,7 @@ function StyleTable({ style }: { style: string }): JSX.Element {
         <tr>
           <td>Description</td>
           <td>Badges (new)</td>
-          <td>Badges (old)</td>
+          <td>Badges (img.shields.io)</td>
         </tr>
       </thead>
       <tbody>

frontend/enzyme-conf.spec.js

@@ -1,8 +0,0 @@
-import Enzyme from 'enzyme'
-import Adapter from 'enzyme-adapter-react-16'
-import chai from 'chai'
-import chaiEnzyme from 'chai-enzyme'
-
-Enzyme.configure({ adapter: new Adapter() })
-
-chai.use(chaiEnzyme())

frontend/lib/generate-image-markup.ts

@@ -45,7 +45,11 @@ function quoteAsciiDocAttribute(attr: string | null): string {
   if (attr == null) {
     return 'None'
   } else {
-    const withQuotesEscaped = attr.replace(/"/g, '\\"')
+    // String values are prepared and returned to users who want to include their badge
+    // in an AsciiDoc document. We're not using the value in any actual processing, so
+    // no need to perform proper sanitization. We simply escape quotes, as mandated by
+    // http://asciidoc.org/userguide.html#X21
+    const withQuotesEscaped = attr.replace(/"/g, '\\"') // lgtm [js/incomplete-sanitization]
     return `"${withQuotesEscaped}"`
   }
 }

frontend/pages/endpoint.tsx

@@ -209,7 +209,7 @@ export default function EndpointPage(): JSX.Element {
         <dt>logoColor</dt>
         <dd>
           Default: none. Same meaning as the query string. Can be overridden by
-          the query string.
+          the query string. Only works for named logos.
         </dd>
         <dt>logoWidth</dt>
         <dd>

gatsby-browser.js

@@ -12,8 +12,7 @@ function scrollToElementId(id) {
 
 export function onRouteUpdate({ location: { hash } }) {
   if (hash) {
-    if (!redirectLegacyRoutes()) {
-      window.setTimeout(() => scrollToElementId(hash), 10)
-    }
+    redirectLegacyRoutes()
+    window.setTimeout(() => scrollToElementId(hash), 10)
   }
 }

lib/logos.js

@@ -1,7 +1,11 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
-const { toSvgColor } = require('../badge-maker/lib/color')
+const Joi = require('joi')
+const {
+  toSvgColor,
+  brightness,
+  normalizeColor,
+} = require('../badge-maker/lib/color')
 const coalesce = require('../core/base-service/coalesce')
 const { svg2base64 } = require('./svg-helpers')
 const logos = require('./load-logos')()
@@ -16,6 +20,8 @@ const logoAliases = {
   stackoverflow: 'stack-overflow',
   tfs: 'azure-devops',
 }
+const lightThreshold = 0.4
+const darkThreshold = 0.6
 
 function prependPrefix(s, prefix) {
   if (s === undefined) {
@@ -67,27 +73,12 @@ function getShieldsIcon({ name, color }) {
   }
 }
 
-function brightness({ r, g, b }) {
-  return +((r * 299 + g * 587 + b * 114) / 255000).toFixed(2)
-}
-
-const hexColorRegex = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i
-
-function hexToRgb(hex) {
-  const result = hexColorRegex.exec(hex)
-  return {
-    r: parseInt(result[1], 16),
-    g: parseInt(result[2], 16),
-    b: parseInt(result[3], 16),
-  }
-}
-
 function getSimpleIconStyle({ icon, style }) {
   const { hex } = icon
-  if (style !== 'social' && brightness(hexToRgb(hex)) <= 0.4) {
+  if (style !== 'social' && brightness(normalizeColor(hex)) <= lightThreshold) {
     return 'light'
   }
-  if (style === 'social' && brightness(hexToRgb(hex)) >= 0.6) {
+  if (style === 'social' && brightness(normalizeColor(hex)) >= darkThreshold) {
     return 'dark'
   }
   return 'default'

lib/logos.spec.js

@@ -6,6 +6,7 @@ const {
   prependPrefix,
   isDataUrl,
   prepareNamedLogo,
+  getSimpleIcon,
   makeLogo,
 } = require('./logos')
 
@@ -98,6 +99,13 @@ describe('Logo helpers', function () {
     })
   })
 
+  test(getSimpleIcon, () => {
+    // https://github.com/badges/shields/issues/4016
+    given({ name: 'get' }).expect(undefined)
+    // https://github.com/badges/shields/issues/4263
+    given({ name: 'get', color: 'blue' }).expect(undefined)
+  })
+
   test(makeLogo, () => {
     forCases([
       given('npm', { logo: 'image/svg+xml;base64,PHN2ZyB4bWxu' }),

lib/server-secrets.js

@@ -1,15 +0,0 @@
-'use strict'
-
-const fs = require('fs')
-const path = require('path')
-const config = require('config').util.toObject()
-
-const legacySecretsPath = path.join(__dirname, '..', 'private', 'secret.json')
-if (fs.existsSync(legacySecretsPath)) {
-  console.error(
-    `Legacy secrets file found at ${legacySecretsPath}. It should be deleted and secrets replaced with environment variables or config/local.yml`
-  )
-  process.exit(1)
-}
-
-module.exports = config.private

now.json

@@ -1,11 +0,0 @@
-{
-  "version": 1,
-  "name": "shields",
-  "env": {
-    "PERSISTENCE_DIR": "/tmp/persistence"
-  },
-  "type": "npm",
-  "engines": {
-    "node": "8.x"
-  }
-}

package.json

@@ -22,47 +22,46 @@
     "url": "https://github.com/badges/shields"
   },
   "dependencies": {
-    "@hapi/joi": "^17.1.1",
-    "@sentry/node": "^5.18.1",
-    "bytes": "^3.1.0",
-    "camelcase": "^5.3.1",
+    "@sentry/node": "^5.27.1",
     "@shields_io/camp": "^18.0.0",
-    "chai-as-promised": "^7.1.1",
+    "badge-maker": "file:badge-maker",
+    "bytes": "^3.1.0",
+    "camelcase": "^6.1.0",
     "chalk": "^4.1.0",
     "check-node-version": "^4.0.3",
-    "chrome-web-store-item-property": "~1.2.0",
-    "config": "^3.3.1",
+    "cloudflare-middleware": "^1.0.4",
+    "config": "^3.3.2",
     "cross-env": "^7.0.2",
     "decamelize": "^3.2.0",
     "dotenv": "^8.2.0",
-    "emojic": "^1.1.15",
+    "emojic": "^1.1.16",
     "escape-string-regexp": "^4.0.0",
     "fast-xml-parser": "^3.17.4",
-    "fsos": "^1.1.6",
-    "badge-maker": "file:badge-maker",
     "glob": "^7.1.6",
     "graphql": "^14.7.0",
-    "graphql-tag": "^2.10.4",
+    "graphql-tag": "^2.11.0",
     "ioredis": "4.17.3",
-    "joi-extension-semver": "4.1.1",
+    "joi": "17.2.1",
+    "joi-extension-semver": "5.0.0",
     "js-yaml": "^3.14.0",
     "jsonpath": "~1.0.2",
     "lodash.countby": "^4.6.0",
     "lodash.groupby": "^4.6.0",
     "lodash.times": "^4.3.2",
-    "moment": "^2.27.0",
+    "moment": "^2.29.1",
     "node-env-flag": "^0.1.0",
     "parse-link-header": "^1.0.1",
     "path-to-regexp": "^5.0.0",
-    "pretty-bytes": "^5.3.0",
+    "pretty-bytes": "^5.4.1",
     "priorityqueuejs": "^2.0.0",
     "prom-client": "^11.5.3",
-    "query-string": "^6.13.1",
+    "query-string": "^6.13.6",
     "request": "~2.88.2",
     "semver": "~7.3.2",
-    "simple-icons": "2.18.0",
+    "simple-icons": "3.12.1",
+    "webextension-store-meta": "^1.0.2",
     "xmldom": "~0.2.1",
-    "xpath": "~0.0.27"
+    "xpath": "~0.0.32"
   },
   "scripts": {
     "coverage:test:core": "nyc npm run test:core",
@@ -96,8 +95,9 @@
     "test": "run-s --silent --continue-on-error lint test:frontend test:package test:core test:entrypoint check-types:package check-types:frontend prettier:check",
     "check-types:package": "tsd badge-maker",
     "check-types:frontend": "tsc --noEmit --project .",
-    "depcheck": "check-node-version --node \">= 10.0\"",
-    "postinstall": "run-s --silent depcheck",
+    "depcheck": "check-node-version --node \">= 12.0\"",
+    "fix-issue-5294": "rimraf node_modules/@types/react-native",
+    "postinstall": "run-s --silent depcheck fix-issue-5294",
     "prebuild": "run-s --silent depcheck",
     "features": "node scripts/export-supported-features-cli.js > supported-features.json",
     "defs": "node scripts/export-service-definitions-cli.js > service-definitions.yml",
@@ -141,21 +141,19 @@
     ]
   },
   "devDependencies": {
-    "@babel/core": "^7.10.4",
-    "@babel/polyfill": "^7.10.4",
-    "@babel/register": "7.10.4",
+    "@babel/core": "^7.12.3",
+    "@babel/polyfill": "^7.12.1",
+    "@babel/register": "7.12.1",
     "@mapbox/react-click-to-select": "^2.2.0",
-    "@types/chai": "^4.2.11",
-    "@types/chai-enzyme": "^0.6.7",
-    "@types/enzyme": "^3.10.5",
+    "@types/chai": "^4.2.14",
     "@types/lodash.debounce": "^4.0.6",
     "@types/lodash.groupby": "^4.6.6",
-    "@types/mocha": "^7.0.2",
-    "@types/node": "^14.0.14",
-    "@types/react-helmet": "^6.0.0",
+    "@types/mocha": "^8.0.3",
+    "@types/node": "^14.11.8",
+    "@types/react-helmet": "^6.1.0",
     "@types/react-modal": "^3.10.6",
-    "@types/react-select": "^3.0.14",
-    "@types/styled-components": "4.1.8",
+    "@types/react-select": "^3.0.22",
+    "@types/styled-components": "5.1.3",
     "@typescript-eslint/eslint-plugin": "^2.34.0",
     "@typescript-eslint/parser": "^2.34.0",
     "babel-plugin-inline-react-svg": "^1.1.1",
@@ -163,55 +161,53 @@
     "babel-preset-gatsby": "^0.5.1",
     "caller": "^1.0.1",
     "chai": "^4.1.2",
+    "chai-as-promised": "^7.1.1",
     "chai-datetime": "^1.7.0",
-    "chai-enzyme": "^1.0.0-beta.1",
     "chai-string": "^1.4.0",
     "cheerio": "^1.0.0-rc.3",
     "child-process-promise": "^2.2.1",
     "clipboard-copy": "^3.1.0",
-    "concurrently": "^5.2.0",
-    "cypress": "^4.10.0",
-    "danger": "^10.2.1",
+    "concurrently": "^5.3.0",
+    "cypress": "^5.3.0",
+    "danger": "^10.5.0",
     "danger-plugin-no-test-shortcuts": "^2.0.0",
     "deepmerge": "^4.2.2",
-    "enzyme": "^3.11.0",
-    "enzyme-adapter-react-16": "^1.15.2",
     "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.11.0",
+    "eslint-config-prettier": "^6.13.0",
     "eslint-config-standard": "^14.1.1",
     "eslint-config-standard-react": "^9.2.0",
     "eslint-plugin-chai-friendly": "^0.6.0",
-    "eslint-plugin-cypress": "^2.11.1",
-    "eslint-plugin-import": "^2.22.0",
-    "eslint-plugin-jsdoc": "^28.5.1",
+    "eslint-plugin-cypress": "^2.11.2",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jsdoc": "^30.7.3",
     "eslint-plugin-mocha": "^6.3.0",
     "eslint-plugin-no-extension-in-require": "^0.2.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-react": "^7.20.3",
+    "eslint-plugin-react": "^7.21.5",
     "eslint-plugin-react-hooks": "^2.5.1",
-    "eslint-plugin-sort-class-members": "^1.7.0",
-    "eslint-plugin-standard": "^4.0.1",
+    "eslint-plugin-sort-class-members": "^1.8.0",
+    "eslint-plugin-standard": "^4.0.2",
     "fetch-ponyfill": "^6.1.1",
     "form-data": "^3.0.0",
     "fs-readfile-promise": "^3.0.1",
-    "gatsby": "2.24.2",
+    "gatsby": "2.24.73",
     "gatsby-plugin-catch-links": "^2.3.10",
-    "gatsby-plugin-page-creator": "^2.3.12",
+    "gatsby-plugin-page-creator": "^2.3.33",
     "gatsby-plugin-react-helmet": "^3.3.9",
     "gatsby-plugin-remove-trailing-slashes": "^2.3.10",
     "gatsby-plugin-styled-components": "^3.3.9",
-    "gatsby-plugin-typescript": "^2.4.13",
-    "got": "11.5.0",
+    "gatsby-plugin-typescript": "^2.4.24",
+    "got": "11.7.0",
     "humanize-string": "^2.1.0",
-    "husky": "^4.2.5",
+    "husky": "^4.3.0",
     "icedfrisby": "4.0.0",
     "icedfrisby-nock": "^2.0.0",
     "is-png": "^2.0.0",
     "is-svg": "^4.2.1",
     "js-yaml-loader": "^1.2.2",
-    "jsdoc": "^3.6.4",
-    "lint-staged": "^10.2.11",
+    "jsdoc": "^3.6.6",
+    "lint-staged": "^10.4.2",
     "lodash.debounce": "^4.0.8",
     "lodash.difference": "^4.5.0",
     "minimist": "^1.2.5",
@@ -219,15 +215,15 @@
     "mocha-env-reporter": "^4.0.0",
     "mocha-junit-reporter": "^2.0.0",
     "mocha-yaml-loader": "^1.0.3",
-    "nock": "13.0.2",
-    "node-mocks-http": "^1.8.1",
-    "nodemon": "^2.0.4",
+    "nock": "13.0.4",
+    "node-mocks-http": "^1.9.0",
+    "nodemon": "^2.0.6",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "opn-cli": "^5.0.0",
-    "portfinder": "^1.0.26",
-    "prettier": "2.0.5",
-    "react": "^16.13.1",
+    "portfinder": "^1.0.28",
+    "prettier": "2.1.2",
+    "react": "^16.14.0",
     "react-dom": "^16.13.1",
     "react-error-overlay": "^6.0.7",
     "react-helmet": "^6.1.0",
@@ -239,19 +235,19 @@
     "require-hacker": "^3.0.1",
     "rimraf": "^3.0.2",
     "sazerac": "^2.0.0",
-    "sinon": "^9.0.2",
+    "sinon": "^9.2.0",
     "sinon-chai": "^3.5.0",
     "snap-shot-it": "^7.9.3",
-    "start-server-and-test": "1.11.0",
-    "styled-components": "^5.1.1",
+    "start-server-and-test": "1.11.5",
+    "styled-components": "^5.2.0",
     "tmp": "0.2.1",
-    "tsd": "^0.12.1",
-    "ts-mocha": "^7.0.0",
-    "typescript": "^3.8.3"
+    "tsd": "^0.13.1",
+    "ts-mocha": "^8.0.0",
+    "typescript": "^4.0.3"
   },
   "engines": {
-    "node": "^10.16.3",
-    "npm": "^6.11.3"
+    "node": "^12.18.3",
+    "npm": "^6.14.7"
   },
   "babel": {
     "plugins": [

scripts/redis-connectivity-test.js

@@ -5,7 +5,6 @@ console.log(config)
 const GithubConstellation = require('../services/github/github-constellation')
 
 const { persistence } = new GithubConstellation({
-  persistence: config.public.persistence,
   service: config.public.services.github,
   private: config.private,
 })

scripts/run_package_tests.sh

@@ -0,0 +1,35 @@
+#!/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.
+if [[ "$NODE_VERSION" == "v10" ]]; then
+    # Avoid a depcheck error.
+    npm ci --ignore-scripts
+else
+    npm ci
+fi
+
+# Run the package tests.
+npm run test:package
+npm run check-types:package
+
+# Delete the shields.io dependencies.
+rm -rf node_modules/
+
+# Run a smoke test (render a badge with the CLI) with only the package
+# dependencies installed.
+cd badge-maker
+npm link
+badge cactus grown :green @flat

services/amo/amo-base.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { nonNegativeInteger } = require('../validators')
 const { BaseJsonService } = require('..')
 
@@ -18,9 +18,7 @@ const schema = Joi.object({
 }).required()
 
 class BaseAmoService extends BaseJsonService {
-  static get defaultBadgeData() {
-    return { label: 'mozilla add-on' }
-  }
+  static defaultBadgeData = { label: 'mozilla add-on' }
 
   async fetch({ addonId }) {
     return this._requestJson({

services/amo/amo-downloads.service.js

@@ -14,32 +14,20 @@ const documentation = `
 `
 
 class AmoWeeklyDownloads extends BaseAmoService {
-  static get category() {
-    return 'downloads'
-  }
+  static category = 'downloads'
+  static route = { base: 'amo/dw', pattern: ':addonId' }
 
-  static get route() {
-    return {
-      base: 'amo/dw',
-      pattern: ':addonId',
-    }
-  }
+  static examples = [
+    {
+      title: 'Mozilla Add-on',
+      namedParams: { addonId: 'dustman' },
+      staticPreview: this.render({ downloads: 120 }),
+      keywords,
+      documentation,
+    },
+  ]
 
-  static get examples() {
-    return [
-      {
-        title: 'Mozilla Add-on',
-        namedParams: { addonId: 'dustman' },
-        staticPreview: this.render({ downloads: 120 }),
-        keywords,
-        documentation,
-      },
-    ]
-  }
-
-  static get defaultBadgeData() {
-    return { label: 'downloads' }
-  }
+  static defaultBadgeData = { label: 'downloads' }
 
   static render({ downloads }) {
     return {

services/amo/amo-downloads.tester.js

@@ -9,7 +9,7 @@ const t = (module.exports = new ServiceTester({
 }))
 
 t.create('Weekly Downloads')
-  .get('/dw/dustman.json')
+  .get('/dw/duckduckgo-for-firefox.json')
   .expectBadge({ label: 'downloads', message: isMetricOverTimePeriod })
 
 t.create('Weekly Downloads (not found)')

services/amo/amo-rating.service.js

@@ -5,35 +5,25 @@ const { floorCount: floorCountColor } = require('../color-formatters')
 const { BaseAmoService, keywords } = require('./amo-base')
 
 module.exports = class AmoRating extends BaseAmoService {
-  static get category() {
-    return 'rating'
-  }
+  static category = 'rating'
+  static route = { base: 'amo', pattern: ':format(stars|rating)/:addonId' }
 
-  static get route() {
-    return {
-      base: 'amo',
-      pattern: ':format(stars|rating)/:addonId',
-    }
-  }
-
-  static get examples() {
-    return [
-      {
-        title: 'Mozilla Add-on',
-        pattern: 'rating/:addonId',
-        namedParams: { addonId: 'dustman' },
-        staticPreview: this.render({ format: 'rating', rating: 4 }),
-        keywords,
-      },
-      {
-        title: 'Mozilla Add-on',
-        pattern: 'stars/:addonId',
-        namedParams: { addonId: 'dustman' },
-        staticPreview: this.render({ format: 'stars', rating: 4 }),
-        keywords,
-      },
-    ]
-  }
+  static examples = [
+    {
+      title: 'Mozilla Add-on',
+      pattern: 'rating/:addonId',
+      namedParams: { addonId: 'dustman' },
+      staticPreview: this.render({ format: 'rating', rating: 4 }),
+      keywords,
+    },
+    {
+      title: 'Mozilla Add-on',
+      pattern: 'stars/:addonId',
+      namedParams: { addonId: 'dustman' },
+      staticPreview: this.render({ format: 'stars', rating: 4 }),
+      keywords,
+    },
+  ]
 
   static render({ format, rating }) {
     rating = Math.round(rating)

services/amo/amo-rating.tester.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { isStarRating } = require('../test-validators')
 const t = (module.exports = require('../tester').createServiceTester())
 

services/amo/amo-users.service.js

@@ -4,33 +4,19 @@ const { metric } = require('../text-formatters')
 const { BaseAmoService, keywords } = require('./amo-base')
 
 module.exports = class AmoUsers extends BaseAmoService {
-  static get category() {
-    return 'downloads'
-  }
+  static category = 'downloads'
+  static route = { base: 'amo/users', pattern: ':addonId' }
 
-  static get route() {
-    return {
-      base: 'amo/users',
-      pattern: ':addonId',
-    }
-  }
+  static examples = [
+    {
+      title: 'Mozilla Add-on',
+      namedParams: { addonId: 'dustman' },
+      staticPreview: this.render({ users: 750 }),
+      keywords,
+    },
+  ]
 
-  static get examples() {
-    return [
-      {
-        title: 'Mozilla Add-on',
-        namedParams: { addonId: 'dustman' },
-        staticPreview: this.render({ users: 750 }),
-        keywords,
-      },
-    ]
-  }
-
-  static get defaultBadgeData() {
-    return {
-      label: 'users',
-    }
-  }
+  static defaultBadgeData = { label: 'users' }
 
   static render({ users }) {
     return {

services/amo/amo-version.service.js

@@ -4,27 +4,17 @@ const { renderVersionBadge } = require('../version')
 const { BaseAmoService, keywords } = require('./amo-base')
 
 module.exports = class AmoVersion extends BaseAmoService {
-  static get category() {
-    return 'version'
-  }
+  static category = 'version'
+  static route = { base: 'amo/v', pattern: ':addonId' }
 
-  static get route() {
-    return {
-      base: 'amo/v',
-      pattern: ':addonId',
-    }
-  }
-
-  static get examples() {
-    return [
-      {
-        title: 'Mozilla Add-on',
-        namedParams: { addonId: 'dustman' },
-        staticPreview: renderVersionBadge({ version: '2.1.0' }),
-        keywords,
-      },
-    ]
-  }
+  static examples = [
+    {
+      title: 'Mozilla Add-on',
+      namedParams: { addonId: 'dustman' },
+      staticPreview: renderVersionBadge({ version: '2.1.0' }),
+      keywords,
+    },
+  ]
 
   async handle({ addonId }) {
     const data = await this.fetch({ addonId })

services/ansible/ansible-quality.service.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { floorCount } = require('../color-formatters')
 const { BaseJsonService, InvalidResponse } = require('..')
 
@@ -19,32 +19,20 @@ class AnsibleGalaxyContent extends BaseJsonService {
 }
 
 module.exports = class AnsibleGalaxyContentQualityScore extends AnsibleGalaxyContent {
-  static get category() {
-    return 'analysis'
-  }
+  static category = 'analysis'
+  static route = { base: 'ansible/quality', pattern: ':projectId' }
 
-  static get route() {
-    return {
-      base: 'ansible/quality',
-      pattern: ':projectId',
-    }
-  }
-
-  static get examples() {
-    return [
-      {
-        title: 'Ansible Quality Score',
-        namedParams: {
-          projectId: '432',
-        },
-        staticPreview: this.render({ qualityScore: 4.125 }),
+  static examples = [
+    {
+      title: 'Ansible Quality Score',
+      namedParams: {
+        projectId: '432',
       },
-    ]
-  }
+      staticPreview: this.render({ qualityScore: 4.125 }),
+    },
+  ]
 
-  static get defaultBadgeData() {
-    return { label: 'quality' }
-  }
+  static defaultBadgeData = { label: 'quality' }
 
   static render({ qualityScore }) {
     return {

services/ansible/ansible-role.service.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { downloadCount } = require('../color-formatters')
 const { metric } = require('../text-formatters')
 const { nonNegativeInteger } = require('../validators')
@@ -27,30 +27,18 @@ class AnsibleGalaxyRole extends BaseJsonService {
 }
 
 class AnsibleGalaxyRoleDownloads extends AnsibleGalaxyRole {
-  static get category() {
-    return 'downloads'
-  }
+  static category = 'downloads'
+  static route = { base: 'ansible/role/d', pattern: ':roleId' }
 
-  static get route() {
-    return {
-      base: 'ansible/role/d',
-      pattern: ':roleId',
-    }
-  }
+  static examples = [
+    {
+      title: 'Ansible Role',
+      namedParams: { roleId: '3078' },
+      staticPreview: this.render({ downloads: 76 }),
+    },
+  ]
 
-  static get examples() {
-    return [
-      {
-        title: 'Ansible Role',
-        namedParams: { roleId: '3078' },
-        staticPreview: this.render({ downloads: 76 }),
-      },
-    ]
-  }
-
-  static get defaultBadgeData() {
-    return { label: 'role downloads' }
-  }
+  static defaultBadgeData = { label: 'role downloads' }
 
   static render({ downloads }) {
     return {
@@ -66,32 +54,20 @@ class AnsibleGalaxyRoleDownloads extends AnsibleGalaxyRole {
 }
 
 class AnsibleGalaxyRoleName extends AnsibleGalaxyRole {
-  static get category() {
-    return 'other'
-  }
+  static category = 'other'
+  static route = { base: 'ansible/role', pattern: ':roleId' }
 
-  static get route() {
-    return {
-      base: 'ansible/role',
-      pattern: ':roleId',
-    }
-  }
+  static examples = [
+    {
+      title: 'Ansible Role',
+      namedParams: { roleId: '3078' },
+      staticPreview: this.render({
+        name: 'ansible-roles.sublimetext3_packagecontrol',
+      }),
+    },
+  ]
 
-  static get examples() {
-    return [
-      {
-        title: 'Ansible Role',
-        namedParams: { roleId: '3078' },
-        staticPreview: this.render({
-          name: 'ansible-roles.sublimetext3_packagecontrol',
-        }),
-      },
-    ]
-  }
-
-  static get defaultBadgeData() {
-    return { label: 'role' }
-  }
+  static defaultBadgeData = { label: 'role' }
 
   static render({ name }) {
     return { message: name, color: 'blue' }

services/apm/apm.service.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { renderLicenseBadge } = require('../licenses')
 const { renderVersionBadge } = require('../version')
 const { metric } = require('../text-formatters')
@@ -20,9 +20,7 @@ const schema = Joi.object({
 })
 
 class BaseAPMService extends BaseJsonService {
-  static get defaultBadgeData() {
-    return { label: 'apm' }
-  }
+  static defaultBadgeData = { label: 'apm' }
 
   async fetch({ packageName }) {
     return this._requestJson({
@@ -34,31 +32,19 @@ class BaseAPMService extends BaseJsonService {
 }
 
 class APMDownloads extends BaseAPMService {
-  static get category() {
-    return 'downloads'
-  }
+  static category = 'downloads'
+  static route = { base: 'apm/dm', pattern: ':packageName' }
 
-  static get route() {
-    return {
-      base: 'apm/dm',
-      pattern: ':packageName',
-    }
-  }
+  static examples = [
+    {
+      title: 'APM',
+      namedParams: { packageName: 'vim-mode' },
+      staticPreview: this.render({ downloads: '60043' }),
+      keywords,
+    },
+  ]
 
-  static get examples() {
-    return [
-      {
-        title: 'APM',
-        namedParams: { packageName: 'vim-mode' },
-        staticPreview: this.render({ downloads: '60043' }),
-        keywords,
-      },
-    ]
-  }
-
-  static get defaultBadgeData() {
-    return { label: 'downloads' }
-  }
+  static defaultBadgeData = { label: 'downloads' }
 
   static render({ downloads }) {
     return { message: metric(downloads), color: 'green' }
@@ -71,27 +57,17 @@ class APMDownloads extends BaseAPMService {
 }
 
 class APMVersion extends BaseAPMService {
-  static get category() {
-    return 'version'
-  }
+  static category = 'version'
+  static route = { base: 'apm/v', pattern: ':packageName' }
 
-  static get route() {
-    return {
-      base: 'apm/v',
-      pattern: ':packageName',
-    }
-  }
-
-  static get examples() {
-    return [
-      {
-        title: 'APM',
-        namedParams: { packageName: 'vim-mode' },
-        staticPreview: this.render({ version: '0.6.0' }),
-        keywords,
-      },
-    ]
-  }
+  static examples = [
+    {
+      title: 'APM',
+      namedParams: { packageName: 'vim-mode' },
+      staticPreview: this.render({ version: '0.6.0' }),
+      keywords,
+    },
+  ]
 
   static render({ version }) {
     return renderVersionBadge({ version })
@@ -110,31 +86,19 @@ class APMVersion extends BaseAPMService {
 }
 
 class APMLicense extends BaseAPMService {
-  static get category() {
-    return 'license'
-  }
+  static category = 'license'
+  static route = { base: 'apm/l', pattern: ':packageName' }
 
-  static get route() {
-    return {
-      base: 'apm/l',
-      pattern: ':packageName',
-    }
-  }
+  static examples = [
+    {
+      title: 'APM',
+      namedParams: { packageName: 'vim-mode' },
+      staticPreview: this.render({ license: 'MIT' }),
+      keywords,
+    },
+  ]
 
-  static get examples() {
-    return [
-      {
-        title: 'APM',
-        namedParams: { packageName: 'vim-mode' },
-        staticPreview: this.render({ license: 'MIT' }),
-        keywords,
-      },
-    ]
-  }
-
-  static get defaultBadgeData() {
-    return { label: 'license' }
-  }
+  static defaultBadgeData = { label: 'license' }
 
   static render({ license }) {
     return renderLicenseBadge({ license })

services/appveyor/appveyor-base.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { nonNegativeInteger } = require('../validators')
 const { isBuildStatus } = require('../build-status')
 const { BaseJsonService } = require('..')
@@ -21,9 +21,7 @@ const schema = Joi.object({
 }).required()
 
 module.exports = class AppVeyorBase extends BaseJsonService {
-  static get category() {
-    return 'build'
-  }
+  static category = 'build'
 
   async fetch({ user, repo, branch }) {
     let url = `https://ci.appveyor.com/api/projects/${user}/${repo}`

services/appveyor/appveyor-build.service.js

@@ -4,26 +4,22 @@ const { renderBuildStatusBadge } = require('../build-status')
 const AppVeyorBase = require('./appveyor-base')
 
 module.exports = class AppVeyorBuild extends AppVeyorBase {
-  static get route() {
-    return this.buildRoute('appveyor/build')
-  }
+  static route = this.buildRoute('appveyor/build')
 
-  static get examples() {
-    return [
-      {
-        title: 'AppVeyor',
-        pattern: ':user/:repo',
-        namedParams: { user: 'gruntjs', repo: 'grunt' },
-        staticPreview: this.render({ status: 'success' }),
-      },
-      {
-        title: 'AppVeyor branch',
-        pattern: ':user/:repo/:branch',
-        namedParams: { user: 'gruntjs', repo: 'grunt', branch: 'master' },
-        staticPreview: this.render({ status: 'success' }),
-      },
-    ]
-  }
+  static examples = [
+    {
+      title: 'AppVeyor',
+      pattern: ':user/:repo',
+      namedParams: { user: 'gruntjs', repo: 'grunt' },
+      staticPreview: this.render({ status: 'success' }),
+    },
+    {
+      title: 'AppVeyor branch',
+      pattern: ':user/:repo/:branch',
+      namedParams: { user: 'gruntjs', repo: 'grunt', branch: 'master' },
+      staticPreview: this.render({ status: 'success' }),
+    },
+  ]
 
   static render({ status }) {
     return renderBuildStatusBadge({ status })

services/appveyor/appveyor-job-build.service.js

@@ -5,38 +5,34 @@ const { NotFound } = require('..')
 const AppVeyorBase = require('./appveyor-base')
 
 module.exports = class AppVeyorJobBuild extends AppVeyorBase {
-  static get route() {
-    return {
-      base: 'appveyor/job/build',
-      pattern: ':user/:repo/:job/:branch*',
-    }
+  static route = {
+    base: 'appveyor/job/build',
+    pattern: ':user/:repo/:job/:branch*',
   }
 
-  static get examples() {
-    return [
-      {
-        title: 'AppVeyor Job',
-        pattern: ':user/:repo/:job',
-        namedParams: {
-          user: 'wpmgprostotema',
-          repo: 'voicetranscoder',
-          job: 'Linux',
-        },
-        staticPreview: renderBuildStatusBadge({ status: 'success' }),
+  static examples = [
+    {
+      title: 'AppVeyor Job',
+      pattern: ':user/:repo/:job',
+      namedParams: {
+        user: 'wpmgprostotema',
+        repo: 'voicetranscoder',
+        job: 'Linux',
       },
-      {
-        title: 'AppVeyor Job branch',
-        pattern: ':user/:repo/:job/:branch',
-        namedParams: {
-          user: 'wpmgprostotema',
-          repo: 'voicetranscoder',
-          job: 'Windows',
-          branch: 'master',
-        },
-        staticPreview: renderBuildStatusBadge({ status: 'success' }),
+      staticPreview: renderBuildStatusBadge({ status: 'success' }),
+    },
+    {
+      title: 'AppVeyor Job branch',
+      pattern: ':user/:repo/:job/:branch',
+      namedParams: {
+        user: 'wpmgprostotema',
+        repo: 'voicetranscoder',
+        job: 'Windows',
+        branch: 'master',
       },
-    ]
-  }
+      staticPreview: renderBuildStatusBadge({ status: 'success' }),
+    },
+  ]
 
   transform({ data, jobName }) {
     if (!('build' in data)) {

services/appveyor/appveyor-tests.service.js

@@ -37,72 +37,68 @@ const commonPreviewProps = {
 }
 
 module.exports = class AppVeyorTests extends AppVeyorBase {
-  static get route() {
-    return {
-      ...this.buildRoute('appveyor/tests'),
-      queryParamSchema: testResultQueryParamSchema,
-    }
+  static route = {
+    ...this.buildRoute('appveyor/tests'),
+    queryParamSchema: testResultQueryParamSchema,
   }
 
-  static get examples() {
-    return [
-      {
-        title: 'AppVeyor tests',
-        pattern: ':user/:repo',
-        namedParams: {
-          user: 'NZSmartie',
-          repo: 'coap-net-iu0to',
-        },
-        staticPreview: this.render(commonPreviewProps),
-        documentation,
+  static examples = [
+    {
+      title: 'AppVeyor tests',
+      pattern: ':user/:repo',
+      namedParams: {
+        user: 'NZSmartie',
+        repo: 'coap-net-iu0to',
       },
-      {
-        title: 'AppVeyor tests (branch)',
-        pattern: ':user/:repo/:branch',
-        namedParams: {
-          user: 'NZSmartie',
-          repo: 'coap-net-iu0to',
-          branch: 'master',
-        },
-        staticPreview: this.render(commonPreviewProps),
-        documentation,
+      staticPreview: this.render(commonPreviewProps),
+      documentation,
+    },
+    {
+      title: 'AppVeyor tests (branch)',
+      pattern: ':user/:repo/:branch',
+      namedParams: {
+        user: 'NZSmartie',
+        repo: 'coap-net-iu0to',
+        branch: 'master',
       },
-      {
-        title: 'AppVeyor tests (compact)',
-        pattern: ':user/:repo',
-        namedParams: {
-          user: 'NZSmartie',
-          repo: 'coap-net-iu0to',
-        },
-        queryParams: { compact_message: null },
-        staticPreview: this.render({
-          ...commonPreviewProps,
-          isCompact: true,
-        }),
-        documentation,
+      staticPreview: this.render(commonPreviewProps),
+      documentation,
+    },
+    {
+      title: 'AppVeyor tests (compact)',
+      pattern: ':user/:repo',
+      namedParams: {
+        user: 'NZSmartie',
+        repo: 'coap-net-iu0to',
       },
-      {
-        title: 'AppVeyor tests with custom labels',
-        pattern: ':user/:repo',
-        namedParams: {
-          user: 'NZSmartie',
-          repo: 'coap-net-iu0to',
-        },
-        queryParams: {
-          passed_label: 'good',
-          failed_label: 'bad',
-          skipped_label: 'n/a',
-        },
-        staticPreview: this.render({
-          ...commonPreviewProps,
-          passedLabel: 'good',
-          failedLabel: 'bad',
-          skippedLabel: 'n/a',
-        }),
-        documentation,
+      queryParams: { compact_message: null },
+      staticPreview: this.render({
+        ...commonPreviewProps,
+        isCompact: true,
+      }),
+      documentation,
+    },
+    {
+      title: 'AppVeyor tests with custom labels',
+      pattern: ':user/:repo',
+      namedParams: {
+        user: 'NZSmartie',
+        repo: 'coap-net-iu0to',
       },
-    ]
-  }
+      queryParams: {
+        passed_label: 'good',
+        failed_label: 'bad',
+        skipped_label: 'n/a',
+      },
+      staticPreview: this.render({
+        ...commonPreviewProps,
+        passedLabel: 'good',
+        failedLabel: 'bad',
+        skippedLabel: 'n/a',
+      }),
+      documentation,
+    },
+  ]
 
   static get defaultBadgeData() {
     return {

services/appveyor/appveyor-tests.tester.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const queryString = require('querystring')
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const t = (module.exports = require('../tester').createServiceTester())
 
 const isAppveyorTestTotals = Joi.string().regex(

services/archlinux/archlinux.service.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { renderVersionBadge } = require('../version')
 const { BaseJsonService } = require('..')
 
@@ -9,34 +9,25 @@ const schema = Joi.object({
 }).required()
 
 module.exports = class ArchLinux extends BaseJsonService {
-  static get category() {
-    return 'version'
+  static category = 'version'
+  static route = {
+    base: 'archlinux/v',
+    pattern: ':repository/:architecture/:packageName',
   }
 
-  static get route() {
-    return {
-      base: 'archlinux/v',
-      pattern: ':repository/:architecture/:packageName',
-    }
-  }
-
-  static get examples() {
-    return [
-      {
-        title: 'Arch Linux package',
-        namedParams: {
-          architecture: 'x86_64',
-          repository: 'core',
-          packageName: 'pacman',
-        },
-        staticPreview: renderVersionBadge({ version: '5.1.3' }),
+  static examples = [
+    {
+      title: 'Arch Linux package',
+      namedParams: {
+        architecture: 'x86_64',
+        repository: 'core',
+        packageName: 'pacman',
       },
-    ]
-  }
+      staticPreview: renderVersionBadge({ version: '5.1.3' }),
+    },
+  ]
 
-  static get defaultBadgeData() {
-    return { label: 'arch linux' }
-  }
+  static defaultBadgeData = { label: 'arch linux' }
 
   async handle({ repository, architecture, packageName }) {
     const data = await this._requestJson({

services/aur/aur.service.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { floorCount: floorCountColor } = require('../color-formatters')
 const { addv, metric } = require('../text-formatters')
 const { nonNegativeInteger } = require('../validators')
@@ -25,9 +25,7 @@ const aurSchema = Joi.object({
 }).required()
 
 class BaseAurService extends BaseJsonService {
-  static get defaultBadgeData() {
-    return { label: 'aur' }
-  }
+  static defaultBadgeData = { label: 'aur' }
 
   static _validate(data, schema) {
     if (data.resultcount === 0) {
@@ -51,30 +49,18 @@ class BaseAurService extends BaseJsonService {
 }
 
 class AurLicense extends BaseAurService {
-  static get category() {
-    return 'license'
-  }
+  static category = 'license'
+  static route = { base: 'aur/license', pattern: ':packageName' }
 
-  static get route() {
-    return {
-      base: 'aur/license',
-      pattern: ':packageName',
-    }
-  }
+  static examples = [
+    {
+      title: 'AUR license',
+      namedParams: { packageName: 'android-studio' },
+      staticPreview: this.render({ license: 'Apache' }),
+    },
+  ]
 
-  static get examples() {
-    return [
-      {
-        title: 'AUR license',
-        namedParams: { packageName: 'android-studio' },
-        staticPreview: this.render({ license: 'Apache' }),
-      },
-    ]
-  }
-
-  static get defaultBadgeData() {
-    return { label: 'license' }
-  }
+  static defaultBadgeData = { label: 'license' }
 
   static render({ license }) {
     return { message: license, color: 'blue' }
@@ -97,30 +83,19 @@ class AurLicense extends BaseAurService {
 }
 
 class AurVotes extends BaseAurService {
-  static get category() {
-    return 'rating'
-  }
+  static category = 'rating'
 
-  static get route() {
-    return {
-      base: 'aur/votes',
-      pattern: ':packageName',
-    }
-  }
+  static route = { base: 'aur/votes', pattern: ':packageName' }
 
-  static get examples() {
-    return [
-      {
-        title: 'AUR votes',
-        namedParams: { packageName: 'dropbox' },
-        staticPreview: this.render({ votes: '2280' }),
-      },
-    ]
-  }
+  static examples = [
+    {
+      title: 'AUR votes',
+      namedParams: { packageName: 'dropbox' },
+      staticPreview: this.render({ votes: '2280' }),
+    },
+  ]
 
-  static get defaultBadgeData() {
-    return { label: 'votes' }
-  }
+  static defaultBadgeData = { label: 'votes' }
 
   static render({ votes }) {
     return {
@@ -136,26 +111,17 @@ class AurVotes extends BaseAurService {
 }
 
 class AurVersion extends BaseAurService {
-  static get category() {
-    return 'version'
-  }
+  static category = 'version'
 
-  static get route() {
-    return {
-      base: 'aur/version',
-      pattern: ':packageName',
-    }
-  }
+  static route = { base: 'aur/version', pattern: ':packageName' }
 
-  static get examples() {
-    return [
-      {
-        title: 'AUR version',
-        namedParams: { packageName: 'visual-studio-code-bin' },
-        staticPreview: this.render({ version: '1.34.0-2', outOfDate: null }),
-      },
-    ]
-  }
+  static examples = [
+    {
+      title: 'AUR version',
+      namedParams: { packageName: 'visual-studio-code-bin' },
+      staticPreview: this.render({ version: '1.34.0-2', outOfDate: null }),
+    },
+  ]
 
   static render({ version, outOfDate }) {
     const color = outOfDate === null ? 'blue' : 'orange'
@@ -172,30 +138,19 @@ class AurVersion extends BaseAurService {
 }
 
 class AurMaintainer extends BaseAurService {
-  static get category() {
-    return 'other'
-  }
+  static category = 'other'
 
-  static get route() {
-    return {
-      base: 'aur/maintainer',
-      pattern: ':packageName',
-    }
-  }
+  static route = { base: 'aur/maintainer', pattern: ':packageName' }
 
-  static get examples() {
-    return [
-      {
-        title: 'AUR maintainer',
-        namedParams: { packageName: 'google-chrome' },
-        staticPreview: this.render({ maintainer: 'luzifer' }),
-      },
-    ]
-  }
+  static examples = [
+    {
+      title: 'AUR maintainer',
+      namedParams: { packageName: 'google-chrome' },
+      staticPreview: this.render({ maintainer: 'luzifer' }),
+    },
+  ]
 
-  static get defaultBadgeData() {
-    return { label: 'maintainer', color: 'blue' }
-  }
+  static defaultBadgeData = { label: 'maintainer', color: 'blue' }
 
   static render({ maintainer }) {
     return { message: maintainer }

services/aur/aur.spec.js

@@ -0,0 +1,18 @@
+'use strict'
+
+const { test, given } = require('sazerac')
+const { AurVersion } = require('./aur.service')
+
+describe('AurVersion', function () {
+  test(AurVersion.render, () => {
+    given({ version: '1:1.1.42.622-1', outOfDate: 1 }).expect({
+      color: 'orange',
+      message: 'v1:1.1.42.622-1',
+    })
+
+    given({ version: '7', outOfDate: null }).expect({
+      color: 'blue',
+      message: 'v7',
+    })
+  })
+})

services/aur/aur.tester.js

@@ -22,14 +22,6 @@ t.create('version (valid)')
     color: 'blue',
   })
 
-t.create('version (valid, out of date)')
-  .get('/version/gog-gemini-rue.json')
-  .expectBadge({
-    label: 'aur',
-    message: isVPlusDottedVersionNClausesWithOptionalSuffix,
-    color: 'orange',
-  })
-
 t.create('version (not found)')
   .get('/version/not-a-package.json')
   .expectBadge({ label: 'aur', message: 'package not found' })

services/azure-devops/azure-devops-base.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { BaseJsonService, NotFound } = require('..')
 
 const latestBuildSchema = Joi.object({

services/azure-devops/azure-devops-build.service.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Joi = require('@hapi/joi')
+const Joi = require('joi')
 const { renderBuildStatusBadge } = require('../build-status')
 const { BaseSvgScrapingService, NotFound } = require('..')
 const { keywords, fetch } = require('./azure-devops-helpers')
@@ -34,76 +34,70 @@ const documentation = `
 `
 
 module.exports = class AzureDevOpsBuild extends BaseSvgScrapingService {
-  static get category() {
-    return 'build'
+  static category = 'build'
+
+  static route = {
+    base: 'azure-devops/build',
+    pattern: ':organization/:projectId/:definitionId/:branch*',
+    queryParamSchema,
   }
 
-  static get route() {
-    return {
-      base: 'azure-devops/build',
-      pattern: ':organization/:projectId/:definitionId/:branch*',
-      queryParamSchema,
-    }
-  }
-
-  static get examples() {
-    return [
-      {
-        title: 'Azure DevOps builds',
-        pattern: ':organization/:projectId/:definitionId',
-        namedParams: {
-          organization: 'totodem',
-          projectId: '8cf3ec0e-d0c2-4fcd-8206-ad204f254a96',
-          definitionId: '2',
-        },
-        staticPreview: renderBuildStatusBadge({ status: 'succeeded' }),
-        keywords,
-        documentation,
+  static examples = [
+    {
+      title: 'Azure DevOps builds',
+      pattern: ':organization/:projectId/:definitionId',
+      namedParams: {
+        organization: 'totodem',
+        projectId: '8cf3ec0e-d0c2-4fcd-8206-ad204f254a96',
+        definitionId: '2',
       },
-      {
-        title: 'Azure DevOps builds (branch)',
-        pattern: ':organization/:projectId/:definitionId/:branch',
-        namedParams: {
-          organization: 'totodem',
-          projectId: '8cf3ec0e-d0c2-4fcd-8206-ad204f254a96',
-          definitionId: '2',
-          branch: 'master',
-        },
-        staticPreview: renderBuildStatusBadge({ status: 'succeeded' }),
-        keywords,
-        documentation,
+      staticPreview: renderBuildStatusBadge({ status: 'succeeded' }),
+      keywords,
+      documentation,
+    },
+    {
+      title: 'Azure DevOps builds (branch)',
+      pattern: ':organization/:projectId/:definitionId/:branch',
+      namedParams: {
+        organization: 'totodem',
+        projectId: '8cf3ec0e-d0c2-4fcd-8206-ad204f254a96',
+        definitionId: '2',
+        branch: 'master',
       },
-      {
-        title: 'Azure DevOps builds (stage)',
-        namedParams: {
-          organization: 'totodem',
-          projectId: '8cf3ec0e-d0c2-4fcd-8206-ad204f254a96',
-          definitionId: '5',
-        },
-        queryParams: {
-          stage: 'Successful Stage',
-        },
-        staticPreview: renderBuildStatusBadge({ status: 'succeeded' }),
-        keywords,
-        documentation,
+      staticPreview: renderBuildStatusBadge({ status: 'succeeded' }),
+      keywords,
+      documentation,
+    },
+    {
+      title: 'Azure DevOps builds (stage)',
+      namedParams: {
+        organization: 'totodem',
+        projectId: '8cf3ec0e-d0c2-4fcd-8206-ad204f254a96',
+        definitionId: '5',
       },
-      {
-        title: 'Azure DevOps builds (job)',
-        namedParams: {
-          organization: 'totodem',
-          projectId: '8cf3ec0e-d0c2-4fcd-8206-ad204f254a96',
-          definitionId: '5',
-        },
-        queryParams: {
-          stage: 'Successful Stage',
-          job: 'Successful Job',
-        },
-        staticPreview: renderBuildStatusBadge({ status: 'succeeded' }),
-        keywords,
-        documentation,
+      queryParams: {
+        stage: 'Successful Stage',
       },
-    ]
-  }
+      staticPreview: renderBuildStatusBadge({ status: 'succeeded' }),
+      keywords,
+      documentation,
+    },
+    {
+      title: 'Azure DevOps builds (job)',
+      namedParams: {
+        organization: 'totodem',
+        projectId: '8cf3ec0e-d0c2-4fcd-8206-ad204f254a96',
+        definitionId: '5',
+      },
+      queryParams: {
+        stage: 'Successful Stage',
+        job: 'Successful Job',
+      },
+      staticPreview: renderBuildStatusBadge({ status: 'succeeded' }),
+      keywords,
+      documentation,
+    },
+  ]
 
   async handle(
     { organization, projectId, definitionId, branch },