diff --git a/lib/badge-cli.js b/lib/badge-cli.js index 6362040c25..92feb5e394 100755 --- a/lib/badge-cli.js +++ b/lib/badge-cli.js @@ -2,7 +2,7 @@ 'use strict'; -const badge = require('./badge'); +const makeBadge = require('./make-badge'); const svg2img = require('./svg-to-img'); const colorscheme = require('./colorscheme.json'); @@ -63,7 +63,7 @@ if (color[0] === ':') { if (colorA) { badgeData.colorA = colorA; } } -badge(badgeData, function produceOutput(svg) { +makeBadge(badgeData, function produceOutput(svg) { if (/png|jpg|gif/.test(format)) { svg2img(svg, format, function (err, data) { if (err) { diff --git a/lib/badge.js b/lib/make-badge.js similarity index 100% rename from lib/badge.js rename to lib/make-badge.js diff --git a/lib/badge.spec.js b/lib/make-badge.spec.js similarity index 74% rename from lib/badge.spec.js rename to lib/make-badge.spec.js index 95588fb0fd..6a65340a08 100644 --- a/lib/badge.spec.js +++ b/lib/make-badge.spec.js @@ -1,12 +1,12 @@ 'use strict'; const assert = require('assert'); -const badge = require('./badge'); +const makeBadge = require('./make-badge'); const isSvg = require('is-svg'); describe('The badge generator', function () { it('should produce SVG', function (done) { - badge({ text: ['cactus', 'grown'], format: 'svg' }, svg => { + makeBadge({ text: ['cactus', 'grown'], format: 'svg' }, svg => { assert.ok(isSvg(svg)); assert(svg.includes('cactus'), 'cactus'); assert(svg.includes('grown'), 'grown'); diff --git a/lib/request-handler.js b/lib/request-handler.js index 4e6318524f..c78b89265f 100644 --- a/lib/request-handler.js +++ b/lib/request-handler.js @@ -3,7 +3,7 @@ // eslint-disable-next-line node/no-deprecated-api const domain = require('domain'); const request = require('request'); -const badge = require('./badge'); +const makeBadge = require('./make-badge'); const { makeBadgeData: getBadgeData } = require('./badge-data'); const log = require('./log'); const LruCache = require('./lru-cache'); @@ -106,7 +106,7 @@ function handleRequest (handlerOptions) { // A request was made not long ago. const tooSoon = (+reqTime - cached.time) < cached.interval; if (tooSoon || (cached.dataChange / cached.reqs <= freqRatioMax)) { - badge(cached.data.badgeData, makeSend(cached.data.format, ask.res, end)); + makeBadge(cached.data.badgeData, makeSend(cached.data.format, ask.res, end)); cachedVersionSent = true; // We do not wish to call the vendor servers. if (tooSoon) { return; } @@ -120,7 +120,7 @@ function handleRequest (handlerOptions) { if (cachedVersionSent) { return; } if (requestCache.has(cacheIndex)) { const cached = requestCache.get(cacheIndex).data; - badge(cached.badgeData, makeSend(cached.format, ask.res, end)); + makeBadge(cached.badgeData, makeSend(cached.format, ask.res, end)); return; } ask.res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate'); @@ -130,7 +130,7 @@ function handleRequest (handlerOptions) { try { extension = match[0].split('.').pop(); } catch(e) { extension = 'svg'; } - badge(badgeData, makeSend(extension, ask.res, end)); + makeBadge(badgeData, makeSend(extension, ask.res, end)); }, 25000); // Only call vendor servers when last request is older than… @@ -186,7 +186,7 @@ function handleRequest (handlerOptions) { }; requestCache.set(cacheIndex, updatedCache); if (!cachedVersionSent) { - badge(badgeData, makeSend(format, ask.res, end)); + makeBadge(badgeData, makeSend(format, ask.res, end)); } }, cachingRequest); }); diff --git a/lib/svg-badge-parser.spec.js b/lib/svg-badge-parser.spec.js index 81b7967ddd..f4060e3c0b 100644 --- a/lib/svg-badge-parser.spec.js +++ b/lib/svg-badge-parser.spec.js @@ -2,7 +2,7 @@ const assert = require('assert'); const { makeBadgeData } = require('./badge-data'); -const badge = require('./badge'); +const makeBadge = require('./make-badge'); const { valueFromSvgBadge } = require('./svg-badge-parser'); describe('The SVG badge parser', function() { @@ -11,7 +11,7 @@ describe('The SVG badge parser', function() { const badgeData = makeBadgeData('this is the label', {}); badgeData.text[1] = 'this is the result!'; - badge(badgeData, (svg, err) => { + makeBadge(badgeData, (svg, err) => { assert(! err); exampleSvg = svg; done(); diff --git a/lib/svg-to-img.spec.js b/lib/svg-to-img.spec.js index f4e0f34ffc..1bb5e87f28 100644 --- a/lib/svg-to-img.spec.js +++ b/lib/svg-to-img.spec.js @@ -1,7 +1,7 @@ 'use strict'; const assert = require('assert'); -const badge = require('./badge'); +const makeBadge = require('./make-badge'); const isPng = require('is-png'); const sinon = require('sinon'); const svg2img = require('./svg-to-img'); @@ -12,7 +12,7 @@ describe('The rasterizer', function () { afterEach(function () { cacheGet.restore(); }); it('should produce PNG', function(done) { - badge({ text: ['cactus', 'grown'], format: 'svg' }, svg => { + makeBadge({ text: ['cactus', 'grown'], format: 'svg' }, svg => { svg2img(svg, 'png', (err, data) => { assert.equal(err, null); assert.ok(isPng(data)); @@ -22,7 +22,7 @@ describe('The rasterizer', function () { }); it('should cache its results', function(done) { - badge({ text: ['will-this', 'be-cached?'], format: 'svg' }, svg => { + makeBadge({ text: ['will-this', 'be-cached?'], format: 'svg' }, svg => { svg2img(svg, 'png', (err, data) => { assert.equal(err, null); assert.ok(isPng(data)); diff --git a/package.json b/package.json index 66caed8e25..190498055c 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ }, "license": "CC0-1.0", "author": "Thaddée Tyl ", - "main": "lib/badge.js", + "main": "lib/make-badge.js", "repository": { "type": "git", "url": "https://github.com/badges/shields" @@ -67,7 +67,7 @@ "files": [ "README.md", "lib/badge-cli.js", - "lib/badge.js", + "lib/make-badge.js", "lib/colorscheme.json", "lib/lru-cache.js", "lib/measure-text.js", diff --git a/server.js b/server.js index 2cd7071332..2c1e3d56b8 100644 --- a/server.js +++ b/server.js @@ -22,7 +22,7 @@ var tryUrl = require('url').format({ pathname: '/', }); var log = require('./lib/log.js'); -var badge = require('./lib/badge.js'); +const makeBadge = require('./lib/make-badge'); var githubAuth = require('./lib/github-auth'); var queryString = require('query-string'); var prettyBytes = require('pretty-bytes'); @@ -151,7 +151,7 @@ camp.notfound(/\.(svg|png|gif|jpg|json)/, function(query, match, end, request) { badgeData.colorscheme = 'red'; // Add format to badge data. badgeData.format = format; - badge(badgeData, makeSend(format, request.res, end)); + makeBadge(badgeData, makeSend(format, request.res, end)); }); camp.notfound(/.*/, function(query, match, end, request) { @@ -7244,10 +7244,10 @@ function(data, match, end, ask) { if (isValidStyle(data.style)) { badgeData.template = data.style; } - badge(badgeData, makeSend(format, ask.res, end)); + makeBadge(badgeData, makeSend(format, ask.res, end)); } catch(e) { log.error(e.stack); - badge({text: ['error', 'bad badge'], colorscheme: 'red'}, + makeBadge({text: ['error', 'bad badge'], colorscheme: 'red'}, makeSend(format, ask.res, end)); } }); @@ -7264,7 +7264,7 @@ camp.route(/^\/flip\.svg$/, function(data, match, end, ask) { bitFlip = !bitFlip; badgeData.text[1] = bitFlip? 'on': 'off'; badgeData.colorscheme = bitFlip? 'brightgreen': 'red'; - badge(badgeData, makeSend('svg', ask.res, end)); + makeBadge(badgeData, makeSend('svg', ask.res, end)); }); // Any badge, old version. @@ -7288,9 +7288,9 @@ function(data, match, end, ask) { try { var badgeData = {text: [subject, status]}; badgeData.colorscheme = color; - badge(badgeData, makeSend('png', ask.res, end)); + makeBadge(badgeData, makeSend('png', ask.res, end)); } catch(e) { - badge({text: ['error', 'bad badge'], colorscheme: 'red'}, + makeBadge({text: ['error', 'bad badge'], colorscheme: 'red'}, makeSend('png', ask.res, end)); } });