237 lines
14 KiB
HTML
237 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: services/color-formatters.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: services/color-formatters.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
* Commonly-used functions for determining the colour to use for a badge,
|
|
* including colours based off download count, version number, etc.
|
|
*
|
|
* @module
|
|
*/
|
|
|
|
import pep440 from '@renovatebot/pep440'
|
|
|
|
/**
|
|
* Determines the color used for a badge based on version.
|
|
*
|
|
* @param {string|number} version Version used for determining badge color
|
|
* @returns {string} Badge color
|
|
*/
|
|
function version(version) {
|
|
if (typeof version !== 'string' && typeof version !== 'number') {
|
|
throw new Error(`Can't generate a version color for ${version}`)
|
|
}
|
|
version = `${version}`
|
|
let first = version[0]
|
|
if (first === 'v') {
|
|
first = version[1]
|
|
}
|
|
if (
|
|
first === '0' ||
|
|
/alpha|beta|snapshot|dev|pre|rc|scm|cvs/i.test(version)
|
|
) {
|
|
return 'orange'
|
|
} else {
|
|
return 'blue'
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Determines the color used for a badge based on PEP440 versioning.
|
|
*
|
|
* @param {string|number} version Version used for determining badge color
|
|
* @returns {string} Badge color
|
|
*/
|
|
function pep440VersionColor(version) {
|
|
if (!pep440.valid(version)) {
|
|
return 'lightgrey'
|
|
}
|
|
const parsedVersion = pep440.explain(version)
|
|
if (parsedVersion.is_prerelease || parsedVersion.public.startsWith('0.')) {
|
|
return 'orange'
|
|
}
|
|
return 'blue'
|
|
}
|
|
|
|
/**
|
|
* Determines the color used for a badge by comparing the value and floor count values.
|
|
* The color can vary from red to bright green depending on the range the value lies in.
|
|
* Decreasing the value will shift the color towards red.
|
|
* Increasing the value will shift the color towards bright green.
|
|
*
|
|
* @param {number} value Current value
|
|
* @param {number} yellow Yellow color threshold, should be greater than 0
|
|
* @param {number} yellowgreen Yellowgreen color threshold, should be greater than yellow
|
|
* @param {number} green Green color threshold, should be greater than yellowgreen
|
|
* @returns {string} Badge color
|
|
*/
|
|
function floorCount(value, yellow, yellowgreen, green) {
|
|
if (value <= 0) {
|
|
return 'red'
|
|
} else if (value < yellow) {
|
|
return 'yellow'
|
|
} else if (value < yellowgreen) {
|
|
return 'yellowgreen'
|
|
} else if (value < green) {
|
|
return 'green'
|
|
} else {
|
|
return 'brightgreen'
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Determines the color used for a badge by comparing the download count and floor values.
|
|
* The color varies from red to bright green as the download count increases.
|
|
*
|
|
* @param {number} downloads Download count
|
|
* @returns {string} Badge color
|
|
*/
|
|
function downloadCount(downloads) {
|
|
return floorCount(downloads, 10, 100, 1000)
|
|
}
|
|
|
|
/**
|
|
* Determines the color used for a badge by comparing percentage and floor values.
|
|
* The color varies from red to bright green as the percentage increases.
|
|
*
|
|
* @param {number} percentage Percentage value
|
|
* @returns {string} Badge color
|
|
*/
|
|
function coveragePercentage(percentage) {
|
|
return floorCount(percentage, 80, 90, 100)
|
|
}
|
|
|
|
/**
|
|
* Determines the color used for a badge by matching score with grade values.
|
|
* The color varies from bright green to red as the score decreases.
|
|
* The score can be one of the following grade value: ['A', 'B', 'C', 'D', 'E'].
|
|
* The color defaults to red if the score does not matches with any of the grade values.
|
|
*
|
|
* @param {string} score Score value
|
|
* @returns {string} Badge color
|
|
*/
|
|
function letterScore(score) {
|
|
if (score === 'A') {
|
|
return 'brightgreen'
|
|
} else if (score === 'B') {
|
|
return 'green'
|
|
} else if (score === 'C') {
|
|
return 'yellowgreen'
|
|
} else if (score === 'D') {
|
|
return 'yellow'
|
|
} else if (score === 'E') {
|
|
return 'orange'
|
|
} else {
|
|
return 'red'
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Creates a callback function that determines badge color from the colors array.
|
|
* If the colors array is provided then for n steps, there should be n + 1 color.
|
|
* If the colors array is not provided then it is chosen from the default colors array
|
|
* according to the size of the steps array.
|
|
*
|
|
* @param {number[]} steps Steps array
|
|
* @param {string[]} colors Colors array. If provided, should be of length steps.length + 1
|
|
* @param {boolean} reversed If true then the colors array will be considered in reverse order
|
|
* @returns {function(number): string} Function that finds the step index by comparing value
|
|
* with steps array and returns color from colors array for the corresponding step index
|
|
*/
|
|
function colorScale(steps, colors, reversed) {
|
|
if (steps === undefined) {
|
|
throw Error('When invoking colorScale, steps should be provided.')
|
|
}
|
|
|
|
const defaultColors = {
|
|
1: ['red', 'brightgreen'],
|
|
2: ['red', 'yellow', 'brightgreen'],
|
|
3: ['red', 'yellow', 'green', 'brightgreen'],
|
|
4: ['red', 'yellow', 'yellowgreen', 'green', 'brightgreen'],
|
|
5: ['red', 'orange', 'yellow', 'yellowgreen', 'green', 'brightgreen'],
|
|
}
|
|
|
|
if (typeof colors === 'undefined') {
|
|
if (steps.length in defaultColors) {
|
|
colors = defaultColors[steps.length]
|
|
} else {
|
|
throw Error(`No default colors for ${steps.length} steps.`)
|
|
}
|
|
}
|
|
|
|
if (steps.length !== colors.length - 1) {
|
|
throw Error(
|
|
'When colors are provided, there should be n + 1 colors for n steps.',
|
|
)
|
|
}
|
|
|
|
if (reversed) {
|
|
colors = Array.from(colors).reverse()
|
|
}
|
|
|
|
return value => {
|
|
const stepIndex = steps.findIndex(step => value < step)
|
|
|
|
// For the final step, stepIndex is -1, so in all cases this expression
|
|
// works swimmingly.
|
|
return colors.slice(stepIndex)[0]
|
|
}
|
|
}
|
|
|
|
export {
|
|
colorScale,
|
|
coveragePercentage,
|
|
downloadCount,
|
|
floorCount,
|
|
letterScore,
|
|
pep440VersionColor,
|
|
version,
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-badge-maker.html">badge-maker</a></li><li><a href="module-badge-maker_lib_xml.html">badge-maker/lib/xml</a></li><li><a href="module-core_base-service_base.html">core/base-service/base</a></li><li><a href="module-core_base-service_base-graphql.html">core/base-service/base-graphql</a></li><li><a href="module-core_base-service_base-json.html">core/base-service/base-json</a></li><li><a href="module-core_base-service_base-svg-scraping.html">core/base-service/base-svg-scraping</a></li><li><a href="module-core_base-service_base-toml.html">core/base-service/base-toml</a></li><li><a href="module-core_base-service_base-xml.html">core/base-service/base-xml</a></li><li><a href="module-core_base-service_base-yaml.html">core/base-service/base-yaml</a></li><li><a href="module-core_base-service_errors.html">core/base-service/errors</a></li><li><a href="module-core_base-service_graphql.html">core/base-service/graphql</a></li><li><a href="module-core_base-service_openapi.html">core/base-service/openapi</a></li><li><a href="module-core_base-service_resource-cache.html">core/base-service/resource-cache</a></li><li><a href="module-core_base-service_service-definitions.html">core/base-service/service-definitions</a></li><li><a href="module-core_server_server.html">core/server/server</a></li><li><a href="module-core_service-test-runner_create-service-tester.html">core/service-test-runner/create-service-tester</a></li><li><a href="module-core_service-test-runner_icedfrisby-shields.html">core/service-test-runner/icedfrisby-shields</a></li><li><a href="module-core_service-test-runner_runner.html">core/service-test-runner/runner</a></li><li><a href="module-core_service-test-runner_service-tester.html">core/service-test-runner/service-tester</a></li><li><a href="module-core_service-test-runner_services-for-title.html">core/service-test-runner/services-for-title</a></li><li><a href="module-core_token-pooling_token-pool.html">core/token-pooling/token-pool</a></li><li><a href="module-services_build-status.html">services/build-status</a></li><li><a href="module-services_color-formatters.html">services/color-formatters</a></li><li><a href="module-services_contributor-count.html">services/contributor-count</a></li><li><a href="module-services_date.html">services/date</a></li><li><a href="module-services_downloads.html">services/downloads</a></li><li><a href="module-services_dynamic-common.html">services/dynamic-common</a></li><li><a href="module-services_dynamic_json-path.html">services/dynamic/json-path</a></li><li><a href="module-services_endpoint-common.html">services/endpoint-common</a></li><li><a href="module-services_licenses.html">services/licenses</a></li><li><a href="module-services_package-json-helpers.html">services/package-json-helpers</a></li><li><a href="module-services_php-version.html">services/php-version</a></li><li><a href="module-services_pipenv-helpers.html">services/pipenv-helpers</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_size.html">services/size</a></li><li><a href="module-services_steam_steam-base.html">services/steam/steam-base</a></li><li><a href="module-services_text-formatters.html">services/text-formatters</a></li><li><a href="module-services_validators.html">services/validators</a></li><li><a href="module-services_version.html">services/version</a></li><li><a href="module-services_website-status.html">services/website-status</a></li><li><a href="module-services_winget_version.html">services/winget/version</a></li></ul><h3>Classes</h3><ul><li><a href="BaseThunderstoreService.html">BaseThunderstoreService</a></li><li><a href="module-badge-maker_lib_xml-ElementList.html">ElementList</a></li><li><a href="module-badge-maker_lib_xml-XmlElement.html">XmlElement</a></li><li><a href="module-core_base-service_base-graphql-BaseGraphqlService.html">BaseGraphqlService</a></li><li><a href="module-core_base-service_base-json-BaseJsonService.html">BaseJsonService</a></li><li><a href="module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html">BaseSvgScrapingService</a></li><li><a href="module-core_base-service_base-toml-BaseTomlService.html">BaseTomlService</a></li><li><a href="module-core_base-service_base-xml-BaseXmlService.html">BaseXmlService</a></li><li><a href="module-core_base-service_base-yaml-BaseYamlService.html">BaseYamlService</a></li><li><a href="module-core_base-service_base-BaseService.html">BaseService</a></li><li><a href="module-core_base-service_errors-Deprecated.html">Deprecated</a></li><li><a href="module-core_base-service_errors-ImproperlyConfigured.html">ImproperlyConfigured</a></li><li><a href="module-core_base-service_errors-Inaccessible.html">Inaccessible</a></li><li><a href="module-core_base-service_errors-InvalidParameter.html">InvalidParameter</a></li><li><a href="module-core_base-service_errors-InvalidResponse.html">InvalidResponse</a></li><li><a href="module-core_base-service_errors-NotFound.html">NotFound</a></li><li><a href="module-core_base-service_errors-ShieldsRuntimeError.html">ShieldsRuntimeError</a></li><li><a href="module-core_server_server-Server.html">Server</a></li><li><a href="module-core_service-test-runner_runner-Runner.html">Runner</a></li><li><a href="module-core_service-test-runner_service-tester-ServiceTester.html">ServiceTester</a></li><li><a href="module-core_token-pooling_token-pool-Token.html">Token</a></li><li><a href="module-core_token-pooling_token-pool-TokenPool.html">TokenPool</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_steam_steam-base-BaseSteamAPI.html">BaseSteamAPI</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-TUTORIAL.html">TUTORIAL</a></li><li><a href="tutorial-adding-new-config-values.html">adding-new-config-values</a></li><li><a href="tutorial-authentication.html">authentication</a></li><li><a href="tutorial-badge-urls.html">badge-urls</a></li><li><a href="tutorial-code-walkthrough.html">code-walkthrough</a></li><li><a href="tutorial-deprecating-badges.html">deprecating-badges</a></li><li><a href="tutorial-input-validation.html">input-validation</a></li><li><a href="tutorial-json-format.html">json-format</a></li><li><a href="tutorial-performance-testing.html">performance-testing</a></li><li><a href="tutorial-production-hosting.html">production-hosting</a></li><li><a href="tutorial-releases.html">releases</a></li><li><a href="tutorial-self-hosting.html">self-hosting</a></li><li><a href="tutorial-server-secrets.html">server-secrets</a></li><li><a href="tutorial-service-tests.html">service-tests</a></li><li><a href="tutorial-static-badges.html">static-badges</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createNumRequestCounter">createNumRequestCounter</a></li><li><a href="global.html#fakeJwtToken">fakeJwtToken</a></li><li><a href="global.html#generateFakeConfig">generateFakeConfig</a></li><li><a href="global.html#getBadgeExampleCall">getBadgeExampleCall</a></li><li><a href="global.html#getServiceClassAuthOrigin">getServiceClassAuthOrigin</a></li><li><a href="global.html#isMetricWithPattern">isMetricWithPattern</a></li><li><a href="global.html#testAuth">testAuth</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sun Mar 02 2025 11:21:42 GMT+0000 (Coordinated Universal Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|