renovate/lib/modules/versioning/same-major/index.ts

73 lines
2.1 KiB
TypeScript

import { logger } from '../../../logger';
import { api as semverCoerced } from '../semver-coerced';
import type { VersioningApi } from '../types';
export const id = 'same-major';
export const displayName = 'Same Major Versioning';
export const urls = [];
export const supportsRanges = false;
/**
*
* Converts input to range if it's a version. eg. X.Y.Z -> '>=X.Y.Z <X+1'
* If the input is already a range, it returns the input.
*/
function massageVersion(input: string): string {
// istanbul ignore if: same-major versioning should not be used with ranges as it defeats the purpose
if (!semverCoerced.isSingleVersion(input)) {
logger.warn(
{ version: input },
'Same major versioning expects a single version but got a range. Please switch to a different versioning as this may lead to unexpected behaviour.',
);
return input;
}
// we are sure to get a major because of the isSingleVersion check
const major = semverCoerced.getMajor(input)!;
return `>=${input} <${major + 1}`;
}
// for same major versioning one version is greater than the other if its major is greater
function isGreaterThan(version: string, other: string): boolean {
const versionMajor = semverCoerced.getMajor(version)!;
const otherMajor = semverCoerced.getMajor(other)!;
if (!versionMajor || !otherMajor) {
return false;
}
return versionMajor > otherMajor;
}
function matches(version: string, range: string): boolean {
return semverCoerced.matches(version, massageVersion(range));
}
function getSatisfyingVersion(
versions: string[],
range: string,
): string | null {
return semverCoerced.getSatisfyingVersion(versions, massageVersion(range));
}
function minSatisfyingVersion(
versions: string[],
range: string,
): string | null {
return semverCoerced.minSatisfyingVersion(versions, massageVersion(range));
}
function isLessThanRange(version: string, range: string): boolean {
return semverCoerced.isLessThanRange!(version, massageVersion(range));
}
export const api: VersioningApi = {
...semverCoerced,
matches,
getSatisfyingVersion,
minSatisfyingVersion,
isLessThanRange,
isGreaterThan,
};
export default api;