Convert a bunch of exampleUrls and formats (#2633)

This commit is contained in:
Paul Melnikow
2019-01-05 14:54:34 -05:00
committed by GitHub
parent d97a5e4697
commit c4143b9c23
13 changed files with 88 additions and 63 deletions

View File

@@ -57,9 +57,8 @@ class AnsibleGalaxyRoleDownloads extends AnsibleGalaxyRole {
static get examples() {
return [
{
title: `Ansible Role`,
pattern: ':roleId',
exampleUrl: '3078',
title: 'Ansible Role',
namedParams: { roleId: '3078' },
staticExample: this.render({ downloads: 76 }),
},
]
@@ -88,17 +87,15 @@ class AnsibleGalaxyRoleName extends AnsibleGalaxyRole {
static get route() {
return {
base: 'ansible/role',
format: '(.+)',
capture: ['roleId'],
pattern: ':roleId',
}
}
static get examples() {
return [
{
title: `Ansible Role`,
pattern: ':roleId',
exampleUrl: '3078',
title: 'Ansible Role',
namedParams: { roleId: '3078' },
staticExample: this.render({
name: 'ansible-roles.sublimetext3_packagecontrol',
}),

View File

@@ -24,9 +24,14 @@ module.exports = class Bitrise extends LegacyService {
return [
{
title: 'Bitrise',
previewUrl: 'cde737473028420d/master?token=GCIdEzacE4GW32jLVrZb7A',
pattern: ':app-id/:branch?token=:app-status-badge-token',
exampleUrl: 'cde737473028420d/master?token=GCIdEzacE4GW32jLVrZb7A',
pattern: ':appId/:branch',
namedParams: { appId: 'cde737473028420d', branch: 'master' },
queryParams: { token: 'GCIdEzacE4GW32jLVrZb7A' },
staticExample: {
label: 'bitrise',
message: 'success',
color: 'brightgreen',
},
},
]
}

View File

@@ -47,18 +47,15 @@ module.exports = class Cdnjs extends BaseJsonService {
static get route() {
return {
base: 'cdnjs/v',
format: '(.+)',
capture: ['library'],
pattern: ':library',
}
}
static get examples() {
return [
{
pattern: ':library',
exampleUrl: 'jquery',
namedParams: { library: 'jquery' },
staticExample: this.render({ version: '1.5.2' }),
keywords: ['cdn', 'cdnjs'],
},
]
}

View File

@@ -81,21 +81,35 @@ module.exports = class CircleCi extends BaseJsonService {
return [
{
title: 'CircleCI (all branches)',
exampleUrl: 'project/github/RedSparr0w/node-csgo-parser',
pattern: 'project/:vcsType/:owner/:repo',
namedParams: {
vcsType: 'github',
owner: 'RedSparr0w',
repo: 'node-csgo-parser',
},
staticExample: this.render({ status: 'success' }),
},
{
title: 'CircleCI branch',
exampleUrl: 'project/github/RedSparr0w/node-csgo-parser/master',
pattern: 'project/:vcsType/:owner/:repo/:branch',
namedParams: {
vcsType: 'github',
owner: 'RedSparr0w',
repo: 'node-csgo-parser',
branch: 'master',
},
staticExample: this.render({ status: 'success' }),
},
{
title: 'CircleCI token',
pattern: 'token/:token/project/:vcsType/:owner/:repo/:branch',
exampleUrl:
'token/b90b5c49e59a4c67ba3a92f7992587ac7a0408c2/project/github/RedSparr0w/node-csgo-parser/master',
namedParams: {
token: 'b90b5c49e59a4c67ba3a92f7992587ac7a0408c2',
vcsType: 'github',
owner: 'RedSparr0w',
repo: 'node-csgo-parser',
branch: 'master',
},
staticExample: this.render({ status: 'success' }),
documentation,
},

View File

@@ -44,16 +44,14 @@ module.exports = class Clojars extends BaseJsonService {
static get route() {
return {
base: 'clojars/dt',
format: '(.+)',
capture: ['clojar'],
pattern: ':clojar+',
}
}
static get examples() {
return [
{
exampleUrl: 'prismic',
pattern: ':package',
namedParams: { clojar: 'prismic' },
staticExample: this.render({ downloads: 117 }),
},
]

View File

@@ -50,16 +50,14 @@ module.exports = class Clojars extends BaseJsonService {
static get route() {
return {
base: 'clojars/v',
format: '(.+)',
capture: ['clojar'],
pattern: ':clojar+',
}
}
static get examples() {
return [
{
exampleUrl: 'prismic',
pattern: ':package',
namedParams: { clojar: 'prismic' },
staticExample: this.render({ clojar: 'clojar', version: '1.2' }),
},
]

View File

@@ -31,14 +31,17 @@ module.exports = class CodacyCoverage extends BaseSvgScrapingService {
{
title: 'Codacy coverage',
pattern: ':projectId',
namedParams: { projectId: '59d607d0e311408885e418004068ea58' },
staticExample: this.render({ percentage: 90 }),
exampleUrl: '59d607d0e311408885e418004068ea58',
},
{
title: 'Codacy branch coverage',
pattern: ':projectId/:branch',
namedParams: {
projectId: '59d607d0e311408885e418004068ea58',
branch: 'master',
},
staticExample: this.render({ percentage: 90 }),
exampleUrl: '59d607d0e311408885e418004068ea58/master',
},
]
}

View File

@@ -24,14 +24,17 @@ module.exports = class CodacyGrade extends BaseSvgScrapingService {
{
title: 'Codacy grade',
pattern: ':projectId',
namedParams: { projectId: 'e27821fb6289410b8f58338c7e0bc686' },
staticExample: this.render({ grade: 'A' }),
exampleUrl: 'e27821fb6289410b8f58338c7e0bc686',
},
{
title: 'Codacy branch grade',
pattern: ':projectId/:branch',
namedParams: {
projectId: 'e27821fb6289410b8f58338c7e0bc686',
branch: 'master',
},
staticExample: this.render({ grade: 'A' }),
exampleUrl: 'e27821fb6289410b8f58338c7e0bc686/master',
},
]
}

View File

@@ -155,20 +155,20 @@ module.exports = class Codeclimate extends LegacyService {
return [
{
title: 'Code Climate issues',
exampleUrl: 'issues/twbs/bootstrap',
pattern: 'issues/:userRepo',
namedParams: { userRepo: 'twbs/bootstrap' },
staticExample: { label: 'issues', message: '89', color: 'red' },
},
{
title: 'Code Climate maintainability',
exampleUrl: 'maintainability/angular/angular.js',
pattern: 'maintainability/:userRepo',
namedParams: { userRepo: 'angular/angular.js' },
staticExample: { label: 'maintainability', message: 'F', color: 'red' },
},
{
title: 'Code Climate maintainability (percentage)',
exampleUrl: 'maintainability-percentage/angular/angular.js',
pattern: 'maintainability-percentage/:userRepo',
namedParams: { userRepo: 'angular/angular.js' },
staticExample: {
label: 'maintainability',
message: '4.6%',
@@ -177,8 +177,8 @@ module.exports = class Codeclimate extends LegacyService {
},
{
title: 'Code Climate coverage',
exampleUrl: 'coverage/jekyll/jekyll',
pattern: 'coverage/:userRepo',
namedParams: { userRepo: 'jekyll/jekyll' },
staticExample: {
label: 'coverage',
message: '95%',
@@ -187,8 +187,8 @@ module.exports = class Codeclimate extends LegacyService {
},
{
title: 'Code Climate coverage (letter)',
exampleUrl: 'coverage-letter/jekyll/jekyll',
pattern: 'coverage-letter/:userRepo',
namedParams: { userRepo: 'jekyll/jekyll' },
staticExample: {
label: 'coverage',
message: 'A',
@@ -197,8 +197,8 @@ module.exports = class Codeclimate extends LegacyService {
},
{
title: 'Code Climate technical debt',
exampleUrl: 'tech-debt/jekyll/jekyll',
pattern: 'tech-debt/:userRepo',
namedParams: { userRepo: 'jekyll/jekyll' },
staticExample: {
label: 'technical debt',
message: '3%',

View File

@@ -28,17 +28,35 @@ module.exports = class Codecov extends LegacyService {
return [
{
title: 'Codecov',
previewUrl: 'github/codecov/example-python',
pattern: ':vcsName/:user/:repo',
namedParams: {
vcsName: 'github',
user: 'codecov',
repo: 'example-python',
},
staticPreview: { label: 'coverage', message: '90%', color: 'green' },
},
{
title: 'Codecov branch',
previewUrl: 'github/codecov/example-python/master',
pattern: ':vcsName/:user/:repo/:branch',
namedParams: {
vcsName: 'github',
user: 'codecov',
repo: 'example-python',
branch: 'master',
},
staticPreview: { label: 'coverage', message: '90%', color: 'green' },
},
{
title: 'Codecov private',
previewUrl: 'github/codecov/example-python',
pattern: 'token/:token/github/codecov/example-python',
exampleUrl: 'token/My0A8VL917/github/codecov/example-python',
pattern: 'token/:token/:vcsName/:user/:repo',
namedParams: {
token: 'My0A8VL917',
vcsName: 'github',
user: 'codecov',
repo: 'example-python',
},
staticPreview: { label: 'coverage', message: '90%', color: 'green' },
},
]
}

View File

@@ -50,8 +50,7 @@ class CtanLicense extends BaseCtanService {
static get route() {
return {
base: 'ctan/l',
format: '(.+)',
capture: ['library'],
pattern: ':library',
}
}
@@ -59,8 +58,7 @@ class CtanLicense extends BaseCtanService {
return [
{
title: 'CTAN',
exampleUrl: 'novel',
pattern: ':library',
namedParams: { library: 'novel' },
staticExample: this.render({ licenses: ['ppl1.3c', 'ofl'] }),
keywords: ['tex'],
},
@@ -85,8 +83,7 @@ class CtanVersion extends BaseCtanService {
static get route() {
return {
base: 'ctan/v',
format: '(.+)',
capture: ['library'],
pattern: ':library',
}
}
@@ -94,8 +91,7 @@ class CtanVersion extends BaseCtanService {
return [
{
title: 'CTAN',
exampleUrl: 'tex',
pattern: ':library',
namedParams: { library: 'tex' },
staticExample: this.render({ version: '3.14159265' }),
keywords: ['tex'],
},

View File

@@ -9,8 +9,8 @@ const depfuSchema = Joi.object({
}).required()
module.exports = class Depfu extends BaseJsonService {
async fetch({ userRepo }) {
const url = `https://depfu.com/github/shields/${userRepo}`
async fetch({ user, repo }) {
const url = `https://depfu.com/github/shields/${user}/${repo}`
return this._requestJson({ url, schema: depfuSchema })
}
@@ -21,8 +21,8 @@ module.exports = class Depfu extends BaseJsonService {
}
}
async handle({ userRepo }) {
const { text, colorscheme } = await this.fetch({ userRepo })
async handle({ user, repo }) {
const { text, colorscheme } = await this.fetch({ user, repo })
return this.constructor.render({ text, colorscheme })
}
@@ -37,8 +37,7 @@ module.exports = class Depfu extends BaseJsonService {
static get route() {
return {
base: 'depfu',
format: '(.+)',
capture: ['userRepo'],
pattern: ':user/:repo',
}
}
@@ -46,8 +45,7 @@ module.exports = class Depfu extends BaseJsonService {
return [
{
title: 'Depfu',
exampleUrl: 'depfu/example-ruby',
pattern: ':user/:repo',
namedParams: { user: 'depfu', repo: 'example-ruby' },
staticExample: this.render({
text: 'recent',
colorscheme: 'brightgreen',

View File

@@ -51,8 +51,7 @@ module.exports = class Discord extends BaseJsonService {
static get route() {
return {
base: 'discord',
format: '([^/]+)',
capture: ['serverId'],
pattern: ':serverId',
}
}
@@ -60,8 +59,7 @@ module.exports = class Discord extends BaseJsonService {
return [
{
title: 'Discord',
exampleUrl: '102860784329052160',
pattern: ':serverId',
namedParams: { serverId: '102860784329052160' },
staticExample: this.render({ members: 23 }),
},
]