224 lines
14 KiB
HTML
224 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: services/winget/version.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/winget/version.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
* Comparing versions with winget's version comparator.
|
|
*
|
|
* See https://github.com/microsoft/winget-cli/blob/ae566c7bf21cfcc75be7ec30e4036a30eede8396/src/AppInstallerSharedLib/Versions.cpp for original implementation.
|
|
*
|
|
* @module
|
|
*/
|
|
|
|
/**
|
|
* Compares two strings representing version numbers lexicographically and returns an integer value.
|
|
*
|
|
* @param {string} v1 - The first version to compare
|
|
* @param {string} v2 - The second version to compare
|
|
* @returns {number} -1 if v1 is smaller than v2, 1 if v1 is larger than v2, 0 if v1 and v2 are equal
|
|
* @example
|
|
* compareVersion('1.2.3', '1.2.4') // returns -1 because numeric part of first version is smaller than the numeric part of second version.
|
|
*/
|
|
function compareVersion(v1, v2) {
|
|
// https://github.com/microsoft/winget-cli/blob/ae566c7bf21cfcc75be7ec30e4036a30eede8396/src/AppInstallerSharedLib/Versions.cpp#L109-L173
|
|
// This implementation does not parse s_Approximate_Greater_Than
|
|
// and s_Approximate_Less_Than since they won't appear in directory name (package version parsed by shields.io)
|
|
const v1Trimmed = trimPrefix(v1)
|
|
const v2Trimmed = trimPrefix(v2)
|
|
|
|
const v1Latest = v1Trimmed.trim().toLowerCase() === 'latest'
|
|
const v2Latest = v2Trimmed.trim().toLowerCase() === 'latest'
|
|
|
|
if (v1Latest && v2Latest) {
|
|
return 0
|
|
} else if (v1Latest) {
|
|
return 1
|
|
} else if (v2Latest) {
|
|
return -1
|
|
}
|
|
|
|
const v1Unknown = v1Trimmed.trim().toLowerCase() === 'unknown'
|
|
const v2Unknown = v2Trimmed.trim().toLowerCase() === 'unknown'
|
|
|
|
if (v1Unknown && v2Unknown) {
|
|
return 0
|
|
} else if (v1Unknown) {
|
|
return -1
|
|
} else if (v2Unknown) {
|
|
return 1
|
|
}
|
|
|
|
const parts1 = v1Trimmed.split('.')
|
|
const parts2 = v2Trimmed.split('.')
|
|
|
|
trimLastZeros(parts1)
|
|
trimLastZeros(parts2)
|
|
|
|
for (let i = 0; i < Math.min(parts1.length, parts2.length); i++) {
|
|
const part1 = parts1[i]
|
|
const part2 = parts2[i]
|
|
|
|
const compare = compareVersionPart(part1, part2)
|
|
if (compare !== 0) {
|
|
return compare
|
|
}
|
|
}
|
|
|
|
if (parts1.length === parts2.length) {
|
|
return 0
|
|
}
|
|
|
|
if (parts1.length > parts2.length) {
|
|
return 1
|
|
} else if (parts1.length < parts2.length) {
|
|
return -1
|
|
}
|
|
|
|
return 0
|
|
}
|
|
|
|
/**
|
|
* Removes all leading non-digit characters from a version number string
|
|
* if there is a digit before the split character, or no split characters exist.
|
|
*
|
|
* @param {string} version The version number string to trim
|
|
* @returns {string} The version number string with all leading non-digit characters removed
|
|
*/
|
|
function trimPrefix(version) {
|
|
// https://github.com/microsoft/winget-cli/blob/ae566c7bf21cfcc75be7ec30e4036a30eede8396/src/AppInstallerSharedLib/Versions.cpp#L66
|
|
// If there is a digit before the split character, or no split characters exist, trim off all leading non-digit characters
|
|
|
|
const digitPos = version.match(/(\d.*)/)
|
|
const splitPos = version.match(/\./)
|
|
if (digitPos && (splitPos == null || digitPos.index < splitPos.index)) {
|
|
// there is digit before the split character so strip off all leading non-digit characters
|
|
return version.slice(digitPos.index)
|
|
}
|
|
return version
|
|
}
|
|
|
|
/**
|
|
* Removes all trailing zeros from a version number part array.
|
|
*
|
|
* @param {string[]} parts - parts
|
|
*/
|
|
function trimLastZeros(parts) {
|
|
while (parts.length > 1 && parts[parts.length - 1].trim() === '0') {
|
|
parts.pop()
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Compares two strings representing version number parts lexicographically and returns an integer value.
|
|
*
|
|
* @param {string} part1 - The first version part to compare
|
|
* @param {string} part2 - The second version part to compare
|
|
* @returns {number} -1 if part1 is smaller than part2, 1 if part1 is larger than part2, 0 if part1 and part2 are equal
|
|
* @example
|
|
* compareVersionPart('3', '4') // returns -1 because numeric part of first part is smaller than the numeric part of second part.
|
|
*/
|
|
function compareVersionPart(part1, part2) {
|
|
// https://github.com/microsoft/winget-cli/blob/ae566c7bf21cfcc75be7ec30e4036a30eede8396/src/AppInstallerSharedLib/Versions.cpp#L324-L352
|
|
const [, numericString1, other1] = part1.trim().match(/^(\d*)(.*)$/)
|
|
const [, numericString2, other2] = part2.trim().match(/^(\d*)(.*)$/)
|
|
const numeric1 = parseInt(numericString1 || '0', 10)
|
|
const numeric2 = parseInt(numericString2 || '0', 10)
|
|
|
|
if (numeric1 < numeric2) {
|
|
return -1
|
|
} else if (numeric1 > numeric2) {
|
|
return 1
|
|
}
|
|
// numeric1 === numeric2
|
|
|
|
const otherFolded1 = (other1 ?? '').toLowerCase()
|
|
const otherFolded2 = (other2 ?? '').toLowerCase()
|
|
|
|
if (otherFolded1.length !== 0 && otherFolded2.length === 0) {
|
|
return -1
|
|
} else if (otherFolded1.length === 0 && otherFolded2.length !== 0) {
|
|
return 1
|
|
}
|
|
|
|
if (otherFolded1 < otherFolded2) {
|
|
return -1
|
|
} else if (otherFolded1 > otherFolded2) {
|
|
return 1
|
|
}
|
|
|
|
return 0
|
|
}
|
|
|
|
/**
|
|
* Finds the largest version number lexicographically from an array of strings representing version numbers and returns it as a string.
|
|
*
|
|
* @param {string[]} versions - The array of version numbers to compare
|
|
* @returns {string|undefined} The largest version number as a string, or undefined if the array is empty
|
|
* @example
|
|
* latest(['1.2.3', '1.2.4', '1.3', '2.0']) // returns '2.0' because it is the largest version number.
|
|
* latest(['1.2.3', '1.2.4', '1.3-alpha', '2.0-beta']) // returns '2.0-beta'. there is no special handling for pre-release versions.
|
|
*/
|
|
function latest(versions) {
|
|
const len = versions.length
|
|
if (len === 0) {
|
|
return
|
|
}
|
|
|
|
let version = versions[0]
|
|
for (let i = 1; i < len; i++) {
|
|
if (compareVersion(version, versions[i]) <= 0) {
|
|
version = versions[i]
|
|
}
|
|
}
|
|
return version
|
|
}
|
|
|
|
export { latest, compareVersion }
|
|
</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 Fri Mar 28 2025 18:26:11 GMT+0000 (Coordinated Universal Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|