Files
shields/services/bundlephobia/bundlephobia.service.js
Paul Melnikow 226fa67a02 Create shortcut for BaseService-related imports (#2809)
Continue to implement #2698:

- Add `core/base-service/index.js` (but hold off on moving the things it imports)
- Add shortcuts in `services/index.js` for Base*Service, errors, and deprecatedService. This file will be streamlined later to avoid cluttering it with rarely used bits.
- Apply consistent ordering of imports and use of `module.exports` in testers.
- Remove some renaming of imports.
- Remove obsolete tests here and there.
2019-01-21 15:41:24 -05:00

117 lines
3.3 KiB
JavaScript

'use strict'
const prettyBytes = require('pretty-bytes')
const { makeBadgeData: getBadgeData } = require('../../lib/badge-data')
const LegacyService = require('../legacy-service')
const keywords = ['node']
// This legacy service should be rewritten to use e.g. BaseJsonService.
//
// Tips for rewriting:
// https://github.com/badges/shields/blob/master/doc/rewriting-services.md
//
// Do not base new services on this code.
module.exports = class Bundlephobia extends LegacyService {
static get category() {
return 'size'
}
static get route() {
return {
base: 'bundlephobia',
}
}
static get examples() {
return [
{
title: 'npm bundle size (minified)',
pattern: 'min/:packageName',
namedParams: { packageName: 'react' },
staticPreview: {
label: 'minified size',
message: '6.06 kB',
color: 'blue',
},
keywords,
},
{
title: 'npm bundle size (minified + gzip)',
pattern: 'minzip/:packageName',
namedParams: { packageName: 'react' },
staticPreview: {
label: 'minzipped size',
message: '2.57 kB',
color: 'blue',
},
keywords,
},
]
}
static registerLegacyRouteHandler({ camp, cache }) {
camp.route(
/^\/bundlephobia\/(min|minzip)\/(?:@([^/]+)?\/)?([^/]+)?(?:\/([^/]+)?)?\.(svg|png|gif|jpg|json)?$/,
cache((data, match, sendBadge, request) => {
// A: /bundlephobia/(min|minzip)/:package.:format
// B: /bundlephobia/(min|minzip)/:package/:version.:format
// C: /bundlephobia/(min|minzip)/@:scope/:package.:format
// D: /bundlephobia/(min|minzip)/@:scope/:package/:version.:format
const resultType = match[1]
const scope = match[2]
const packageName = match[3]
const packageVersion = match[4]
const format = match[5]
const showMin = resultType === 'min'
const badgeData = getBadgeData(
showMin ? 'minified size' : 'minzipped size',
data
)
let packageString =
typeof scope === 'string' ? `@${scope}/${packageName}` : packageName
if (packageVersion) {
packageString += `@${packageVersion}`
}
const requestOptions = {
url: 'https://bundlephobia.com/api/size',
qs: {
package: packageString,
},
json: true,
}
/**
* `ErrorCode` => `error code`
* @param {string} code
* @returns {string}
*/
const formatErrorCode = code =>
code
.replace(/([A-Z])/g, ' $1')
.trim()
.toLowerCase()
request(requestOptions, (error, response, body) => {
if (typeof body !== 'object' || body === null) {
badgeData.text[1] = 'error'
badgeData.colorscheme = 'red'
} else if (error !== null || body.error) {
badgeData.text[1] =
'code' in body.error ? formatErrorCode(body.error.code) : 'error'
badgeData.colorscheme = 'red'
} else {
badgeData.text[1] = prettyBytes(showMin ? body.size : body.gzip)
badgeData.colorscheme = 'blue'
}
sendBadge(format, badgeData)
})
})
)
}
}