Migrate deprecated staticExample -> staticPreview (#2650)

doc/TUTORIAL.md

@@ -273,7 +273,7 @@ module.exports = class GemVersion extends BaseJsonService {
       {                                                         // (3)
         title: 'Gem',
         namedParams: { gem: 'formatador' },
-        staticExample: this.render({ version: '2.1.0' }),
+        staticPreview: this.render({ version: '2.1.0' }),
         keywords: ['ruby'],
       },
     ]
@@ -288,7 +288,7 @@ module.exports = class GemVersion extends BaseJsonService {
     * `title`: Descriptive text that will be shown next to the badge
     * `namedParams`: Provide a valid example of params we can substitute into
       the pattern. In this case we need a valid ruby gem, so we've picked [formatador](https://rubygems.org/gems/formatador).
-    * `staticExample`: On the index page we want to show an example badge, but for performance reasons we want that example to be generated without making an API call. `staticExample` should be populated by calling our `render()` method with some valid data.
+    * `staticPreview`: On the index page we want to show an example badge, but for performance reasons we want that example to be generated without making an API call. `staticPreview` should be populated by calling our `render()` method with some valid data.
     * `keywords`: If we want to provide additional keywords other than the title, we can add them here. This helps users to search for relevant badges.
 
 Save, run `npm start`, and you can see it [locally](http://127.0.0.1:3000/).

doc/rewriting-services.md

@@ -264,7 +264,13 @@ In either case, the service should throw e.g
 
 ## Convert the examples
 
-1. Convert all the examples to `pattern`, `namedParams`, and `staticExample`. In some cases you can use the `pattern` inherited from `route`, though in other cases you may need to specify a pattern in the example. For example, when showing download badges for several periods, you may want to render the example with an explicit `dt` instead of `:which`. You will also need to specify a pattern for badges that use a `format` regex in the route.
+1. Convert all the examples to `pattern`, `namedParams`, and
+   `staticPreview`. In some cases you can use the `pattern` inherited
+   from `route`, though in other cases you may need to specify a pattern
+   in the example. For example, when showing download badges for several
+   periods, you may want to render the example with an explicit `dt`
+   instead of `:which`. You will also need to specify a pattern for badges
+   that use a `format` regex in the route.
 
 2. Open the frontend and check that the static preview badges look good.
 Remember, none of them are live.

services/amo/amo.service.js

@@ -36,7 +36,7 @@ class AmoDownloads extends LegacyService {
       {
         title: 'Mozilla Add-on',
         namedParams: { addonId: 'dustman' },
-        staticExample: { message: '12k', color: 'brightgreen' },
+        staticPreview: { message: '12k', color: 'brightgreen' },
         keywords,
       },
     ]
@@ -62,7 +62,7 @@ class AmoVersion extends LegacyService {
       {
         title: 'Mozilla Add-on',
         namedParams: { addonId: 'dustman' },
-        staticExample: { message: 'v2.1.0', color: 'blue' },
+        staticPreview: { message: 'v2.1.0', color: 'blue' },
         keywords,
       },
     ]
@@ -94,7 +94,7 @@ class AmoRating extends LegacyService {
         title: 'Mozilla Add-on',
         pattern: 'rating/:addonId',
         namedParams: { addonId: 'dustman' },
-        staticExample: {
+        staticPreview: {
           label: 'rating',
           message: '4/5',
           color: 'brightgreen',
@@ -105,7 +105,7 @@ class AmoRating extends LegacyService {
         title: 'Mozilla Add-on',
         pattern: 'stars/:addonId',
         namedParams: { addonId: 'dustman' },
-        staticExample: {
+        staticPreview: {
           label: 'rating',
           message: starRating(4),
           color: 'brightgreen',
@@ -135,7 +135,7 @@ class AmoUsers extends LegacyService {
       {
         title: 'Mozilla Add-on',
         namedParams: { addonId: 'dustman' },
-        staticExample: { message: '706', color: 'brightgreen' },
+        staticPreview: { message: '706', color: 'brightgreen' },
         keywords,
       },
     ]

services/ansible/ansible.service.js

@@ -59,7 +59,7 @@ class AnsibleGalaxyRoleDownloads extends AnsibleGalaxyRole {
       {
         title: 'Ansible Role',
         namedParams: { roleId: '3078' },
-        staticExample: this.render({ downloads: 76 }),
+        staticPreview: this.render({ downloads: 76 }),
       },
     ]
   }
@@ -96,7 +96,7 @@ class AnsibleGalaxyRoleName extends AnsibleGalaxyRole {
       {
         title: 'Ansible Role',
         namedParams: { roleId: '3078' },
-        staticExample: this.render({
+        staticPreview: this.render({
           name: 'ansible-roles.sublimetext3_packagecontrol',
         }),
       },

services/apm/apm.service.js

@@ -64,7 +64,7 @@ class APMDownloads extends BaseAPMService {
       {
         title: 'APM',
         namedParams: { packageName: 'vim-mode' },
-        staticExample: this.render({ downloads: '60043' }),
+        staticPreview: this.render({ downloads: '60043' }),
         keywords,
       },
     ]
@@ -103,7 +103,7 @@ class APMVersion extends BaseAPMService {
       {
         title: 'APM',
         namedParams: { packageName: 'vim-mode' },
-        staticExample: this.render({ version: '0.6.0' }),
+        staticPreview: this.render({ version: '0.6.0' }),
         keywords,
       },
     ]
@@ -146,7 +146,7 @@ class APMLicense extends BaseAPMService {
       {
         title: 'APM',
         namedParams: { packageName: 'vim-mode' },
-        staticExample: this.render({ license: 'MIT' }),
+        staticPreview: this.render({ license: 'MIT' }),
         keywords,
       },
     ]

services/appveyor/appveyor-ci.service.js

@@ -13,13 +13,13 @@ module.exports = class AppVeyorCi extends AppVeyorBase {
         title: 'AppVeyor',
         pattern: ':user/:repo',
         namedParams: { user: 'gruntjs', repo: 'grunt' },
-        staticExample: this.render({ status: 'success' }),
+        staticPreview: this.render({ status: 'success' }),
       },
       {
         title: 'AppVeyor branch',
         pattern: ':user/:repo/:branch',
         namedParams: { user: 'gruntjs', repo: 'grunt', branch: 'master' },
-        staticExample: this.render({ status: 'success' }),
+        staticPreview: this.render({ status: 'success' }),
       },
     ]
   }

services/aur/aur.service.js

@@ -76,7 +76,7 @@ class AurLicense extends BaseAurService {
       {
         title: 'AUR license',
         namedParams: { packageName: 'yaourt' },
-        staticExample: this.render({ license: 'GPL' }),
+        staticPreview: this.render({ license: 'GPL' }),
       },
     ]
   }
@@ -115,7 +115,7 @@ class AurVotes extends BaseAurService {
       {
         title: 'AUR votes',
         namedParams: { packageName: 'yaourt' },
-        staticExample: this.render({ votes: '3029' }),
+        staticPreview: this.render({ votes: '3029' }),
       },
     ]
   }
@@ -151,7 +151,7 @@ class AurVersion extends BaseAurService {
       {
         title: 'AUR version',
         namedParams: { packageName: 'yaourt' },
-        staticExample: this.render({ version: 'v1.9-1', outOfDate: null }),
+        staticPreview: this.render({ version: 'v1.9-1', outOfDate: null }),
       },
     ]
   }

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

@@ -55,7 +55,7 @@ module.exports = class AzureDevOpsBuild extends BaseSvgService {
           projectId: '8cf3ec0e-d0c2-4fcd-8206-ad204f254a96',
           definitionId: '2',
         },
-        staticExample: render({ status: 'succeeded' }),
+        staticPreview: render({ status: 'succeeded' }),
         keywords,
         documentation,
       },
@@ -69,7 +69,7 @@ module.exports = class AzureDevOpsBuild extends BaseSvgService {
           definitionId: '2',
           branch: 'master',
         },
-        staticExample: render({ status: 'succeeded' }),
+        staticPreview: render({ status: 'succeeded' }),
         keywords,
         documentation,
       },

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

@@ -73,7 +73,7 @@ module.exports = class AzureDevOpsCoverage extends AzureDevOpsBase {
           project: 'opensource',
           definitionId: '25',
         },
-        staticExample: this.render({ coverage: 100 }),
+        staticPreview: this.render({ coverage: 100 }),
         keywords,
         documentation,
       },
@@ -86,7 +86,7 @@ module.exports = class AzureDevOpsCoverage extends AzureDevOpsBase {
           definitionId: '25',
           branch: 'master',
         },
-        staticExample: this.render({ coverage: 100 }),
+        staticPreview: this.render({ coverage: 100 }),
         keywords,
         documentation,
       },

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

@@ -46,7 +46,7 @@ module.exports = class AzureDevOpsRelease extends BaseSvgService {
           definitionId: '1',
           environmentId: '1',
         },
-        staticExample: render({ status: 'succeeded' }),
+        staticPreview: render({ status: 'succeeded' }),
         keywords,
         documentation,
       },

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

@@ -97,7 +97,7 @@ module.exports = class AzureDevOpsTests extends AzureDevOpsBase {
           project: 'azuredevops-powershell',
           definitionId: '1',
         },
-        staticExample: this.render({
+        staticPreview: this.render({
           passed: 20,
           failed: 1,
           skipped: 1,
@@ -115,7 +115,7 @@ module.exports = class AzureDevOpsTests extends AzureDevOpsBase {
           definitionId: '1',
           branch: 'master',
         },
-        staticExample: this.render({
+        staticPreview: this.render({
           passed: 20,
           failed: 1,
           skipped: 1,
@@ -136,7 +136,7 @@ module.exports = class AzureDevOpsTests extends AzureDevOpsBase {
           compact_message: null,
         },
         keywords: ['vso', 'vsts', 'azure-devops'],
-        staticExample: this.render({
+        staticPreview: this.render({
           passed: 20,
           failed: 1,
           skipped: 1,
@@ -159,7 +159,7 @@ module.exports = class AzureDevOpsTests extends AzureDevOpsBase {
           failed_label: 'bad',
           skipped_label: 'n/a',
         },
-        staticExample: this.render({
+        staticPreview: this.render({
           passed: 20,
           failed: 1,
           skipped: 1,

services/base.js

@@ -89,7 +89,7 @@ class BaseService {
    *
    * The preferred way to specify an example is with `namedParams` which are
    * substitued into the service's compiled route pattern. The rendered badge
-   * is specified with `staticExample`.
+   * is specified with `staticPreview`.
    *
    * For services which use a route `format`, the `pattern` can be specified as
    * part of the example.
@@ -105,7 +105,6 @@ class BaseService {
    *   `render()`: an object containing `message` and optional `label` and
    *   `color`. This is usually generated by invoking `this.render()` with some
    *   explicit props.
-   * staticExample: Deprecated. An alias for `staticPreview`.
    * previewUrl: Deprecated. An explicit example which is rendered as part of
    *   the badge listing.
    * keywords: Additional keywords, other than words in the title. This helps

services/base.spec.js

@@ -39,19 +39,19 @@ class DummyService extends BaseService {
       {
         pattern: ':world',
         namedParams: { world: 'World' },
-        staticExample: this.render({ namedParamA: 'foo', queryParamA: 'bar' }),
+        staticPreview: this.render({ namedParamA: 'foo', queryParamA: 'bar' }),
         keywords: ['hello'],
       },
       {
         namedParams: { namedParamA: 'World' },
-        staticExample: this.render({ namedParamA: 'foo', queryParamA: 'bar' }),
+        staticPreview: this.render({ namedParamA: 'foo', queryParamA: 'bar' }),
         keywords: ['hello'],
       },
       {
         pattern: ':world',
         namedParams: { world: 'World' },
         queryParams: { queryParamA: '!!!' },
-        staticExample: this.render({ namedParamA: 'foo', queryParamA: 'bar' }),
+        staticPreview: this.render({ namedParamA: 'foo', queryParamA: 'bar' }),
         keywords: ['hello'],
       },
     ]

services/beerpay/beerpay.service.js

@@ -26,7 +26,7 @@ module.exports = class Beerpay extends BaseJsonService {
       {
         title: 'Beerpay',
         namedParams: { user: 'hashdog', project: 'scrapfy-chrome-extension' },
-        staticExample: this.render({ totalAmount: 10 }),
+        staticPreview: this.render({ totalAmount: 10 }),
       },
     ]
   }

services/bintray/bintray.service.js

@@ -28,7 +28,7 @@ module.exports = class Bintray extends BaseJsonService {
     return [
       {
         title: 'Bintray',
-        staticExample: renderVersionBadge({ version: '1.6.0' }),
+        staticPreview: renderVersionBadge({ version: '1.6.0' }),
         namedParams: {
           subject: 'asciidoctor',
           repo: 'maven',

services/bitbucket/bitbucket-issues.service.js

@@ -64,7 +64,7 @@ function issueClassGenerator(raw) {
             user: 'atlassian',
             repo: 'python-bitbucket',
           },
-          staticExample: this.render({ issues: 33 }),
+          staticPreview: this.render({ issues: 33 }),
         },
       ]
     }

services/bitbucket/bitbucket-pipelines.service.js

@@ -93,7 +93,7 @@ module.exports = class BitbucketPipelines extends BaseJsonService {
           user: 'atlassian',
           repo: 'adf-builder-javascript',
         },
-        staticExample: this.render({ status: 'SUCCESSFUL' }),
+        staticPreview: this.render({ status: 'SUCCESSFUL' }),
       },
       {
         title: 'Bitbucket Pipelines branch',
@@ -103,7 +103,7 @@ module.exports = class BitbucketPipelines extends BaseJsonService {
           repo: 'adf-builder-javascript',
           branch: 'task/SECO-2168',
         },
-        staticExample: this.render({ status: 'SUCCESSFUL' }),
+        staticPreview: this.render({ status: 'SUCCESSFUL' }),
       },
     ]
   }

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

@@ -61,7 +61,7 @@ function pullRequestClassGenerator(raw) {
             user: 'atlassian',
             repo: 'python-bitbucket',
           },
-          staticExample: this.render({ prs: 22 }),
+          staticPreview: this.render({ prs: 22 }),
         },
       ]
     }

services/bitrise/bitrise.service.js

@@ -27,7 +27,7 @@ module.exports = class Bitrise extends LegacyService {
         pattern: ':appId/:branch',
         namedParams: { appId: 'cde737473028420d', branch: 'master' },
         queryParams: { token: 'GCIdEzacE4GW32jLVrZb7A' },
-        staticExample: {
+        staticPreview: {
           label: 'bitrise',
           message: 'success',
           color: 'brightgreen',

services/bountysource/bountysource.service.js

@@ -39,7 +39,7 @@ module.exports = class Bountysource extends BaseJsonService {
       {
         title: 'Bountysource',
         namedParams: { team: 'mozilla-core' },
-        staticExample: this.render({ total: 53000 }),
+        staticPreview: this.render({ total: 53000 }),
       },
     ]
   }

services/bower/bower-version.service.js

@@ -22,13 +22,13 @@ module.exports = class BowerVersion extends BaseBowerService {
         title: 'Bower',
         namedParams: { vtype: 'v', packageName: 'bootstrap' },
         pattern: 'v/:packageName',
-        staticExample: renderVersionBadge({ version: '4.2.1' }),
+        staticPreview: renderVersionBadge({ version: '4.2.1' }),
       },
       {
         title: 'Bower Pre Release',
         namedParams: { vtype: 'vpre', packageName: 'bootstrap' },
         pattern: 'vpre/:packageName',
-        staticExample: renderVersionBadge({ version: '4.2.1' }),
+        staticPreview: renderVersionBadge({ version: '4.2.1' }),
       },
     ]
   }

services/cdnjs/cdnjs.service.js

@@ -55,7 +55,7 @@ module.exports = class Cdnjs extends BaseJsonService {
     return [
       {
         namedParams: { library: 'jquery' },
-        staticExample: this.render({ version: '1.5.2' }),
+        staticPreview: this.render({ version: '1.5.2' }),
       },
     ]
   }