02ec19fd22
The term “url” is overloaded in services, to refer to the Shields route and also the API URL. Calling the Shields URL a “route” is on the whole more descriptive, and makes it clearer and more obvious which one of these we’re talking about. It’s a small thing, though seems like an improvement. We have a few functions called `buildUrl`. I’ve renamed them to `buildRoute` when they refer to routes, and left them as `buildUrl` when they refer to API URLs. I included a minor style tweak and some formatting cleanup in `TUTORIAL.md`.
96 lines
2.7 KiB
JavaScript
96 lines
2.7 KiB
JavaScript
'use strict'
|
|
|
|
const LegacyService = require('../legacy-service')
|
|
const { makeBadgeData: getBadgeData } = require('../../lib/badge-data')
|
|
const { checkErrorResponse } = require('../../lib/error-helper')
|
|
|
|
module.exports = class LibrariesioDependencies extends LegacyService {
|
|
static get category() {
|
|
return 'dependencies'
|
|
}
|
|
|
|
static get route() {
|
|
return {
|
|
base: 'librariesio',
|
|
}
|
|
}
|
|
|
|
static get examples() {
|
|
return [
|
|
{
|
|
title: 'Libraries.io for releases',
|
|
previewUrl: 'release/hex/phoenix/1.0.3',
|
|
},
|
|
{
|
|
title: 'Libraries.io for GitHub',
|
|
previewUrl: 'github/phoenixframework/phoenix',
|
|
},
|
|
]
|
|
}
|
|
|
|
static registerLegacyRouteHandler({ camp, cache }) {
|
|
camp.route(
|
|
/^\/librariesio\/(github|release)\/([\w\-_]+\/[\w\-_]+)\/?([\w\-_.]+)?\.(svg|png|gif|jpg|json)$/,
|
|
cache((data, match, sendBadge, request) => {
|
|
const resource = match[1]
|
|
const project = match[2]
|
|
const version = match[3]
|
|
const format = match[4]
|
|
|
|
let uri
|
|
switch (resource) {
|
|
case 'github': {
|
|
uri = `https://libraries.io/api/github/${project}/dependencies`
|
|
break
|
|
}
|
|
case 'release': {
|
|
const v = version || 'latest'
|
|
uri = `https://libraries.io/api/${project}/${v}/dependencies`
|
|
break
|
|
}
|
|
}
|
|
|
|
const options = { method: 'GET', json: true, uri }
|
|
const badgeData = getBadgeData('dependencies', data)
|
|
|
|
request(options, (err, res, json) => {
|
|
if (
|
|
checkErrorResponse(badgeData, err, res, { 404: 'not available' })
|
|
) {
|
|
sendBadge(format, badgeData)
|
|
return
|
|
}
|
|
|
|
try {
|
|
const deprecated = json.dependencies.filter(dep => dep.deprecated)
|
|
|
|
const outofdate = json.dependencies.filter(dep => dep.outdated)
|
|
|
|
// Deprecated dependencies are really bad
|
|
if (deprecated.length > 0) {
|
|
badgeData.colorscheme = 'red'
|
|
badgeData.text[1] = `${deprecated.length} deprecated`
|
|
return sendBadge(format, badgeData)
|
|
}
|
|
|
|
// Out of date dependencies are pretty bad
|
|
if (outofdate.length > 0) {
|
|
badgeData.colorscheme = 'orange'
|
|
badgeData.text[1] = `${outofdate.length} out of date`
|
|
return sendBadge(format, badgeData)
|
|
}
|
|
|
|
// Up to date dependencies are good!
|
|
badgeData.colorscheme = 'brightgreen'
|
|
badgeData.text[1] = 'up to date'
|
|
return sendBadge(format, badgeData)
|
|
} catch (e) {
|
|
badgeData.text[1] = 'invalid'
|
|
sendBadge(format, badgeData)
|
|
}
|
|
})
|
|
})
|
|
)
|
|
}
|
|
}
|