Files
renovate/lib/modules/versioning/ruby/version.ts
T
Sebastian Poxhofer 97327c3d28 refactor(linters): add prefer-coerce-array rule (#45492)
* refactor(linters): add prefer-coerce-array rule

Refs #45217

`x ?? []` and `coerceArray(x)` say the same thing, but only the second
one is searchable and consistent. The rule flags a `??` whose default is
a bare `[]` literal; a non-empty default or an asserted `([] as Foo[])`
still passes.

Applying it across `lib/` surfaced three spots the helper cannot cover,
which keep `?? []` with a disable comment or a narrower fix:

- `package-files.ts` destructures a tuple, which `coerceArray()` widens
- `generate.spec.ts` defaults `matchAll()`, an iterator rather than an array
- `mise/upgradeable-tooling.ts` declares a `Record` return, so its
  `?? []` fallback was wrong to begin with and becomes `coerceObject()`

* refactor(platform/github): hoist the GHE version header lookup

`Object.entries(...).find()` returns a tuple, and defaulting it with
`?? []` only to destructure the second element reads as an array
default when it is not one. Name the found entry instead, which drops
the `?? []` rather than routing a tuple through `coerceArray()`.
2026-08-28 09:27:58 +00:00

166 lines
4.2 KiB
TypeScript

import { eq, major, minor, patch, prerelease } from '@renovatebot/ruby-semver';
import type { SegmentElement } from '@renovatebot/ruby-semver/dist/ruby/version.js';
import { create } from '@renovatebot/ruby-semver/dist/ruby/version.js';
import { coerceArray } from '../../../util/array.ts';
import { regEx } from '../../../util/regex.ts';
interface RubyVersion {
major: number;
minor: number;
patch: number;
prerelease: string[] | null;
}
function releaseSegments(version: string): SegmentElement[] {
const v = create(version);
if (v) {
return v.release().getSegments();
}
/* istanbul ignore next */
return [];
}
function parse(version: string): RubyVersion {
return {
major: major(version),
minor: minor(version),
patch: patch(version),
prerelease: prerelease(version),
};
}
function floor(version: string): string {
const segments = releaseSegments(version);
if (segments.length <= 1) {
// '~> 2' is equivalent to '~> 2.0', thus no need to floor
return segments.join('.');
}
return [...segments.slice(0, -1), 0].join('.');
}
function adapt(left: string, right: string): string {
return left.split('.').slice(0, right.split('.').length).join('.');
}
function trimZeroes(version: string): string {
const segments = version.split('.');
while (segments.length > 0 && segments.at(-1) === '0') {
segments.pop();
}
return segments.join('.');
}
// Returns the upper bound of `~>` operator.
function pgteUpperBound(version: string): string {
const segments = releaseSegments(version);
if (segments.length > 1) {
segments.pop();
}
return incrementLastSegment(segments.join('.'));
}
// istanbul ignore next
function incrementLastSegment(version: string): string {
const segments = releaseSegments(version);
const nextLast = parseInt(segments.pop() as string, 10) + 1;
return [...segments, nextLast].join('.');
}
// istanbul ignore next
function incrementMajor(
maj: number,
min: number,
ptch: number,
pre: string[],
): number {
return min === 0 || ptch === 0 || pre.length === 0 ? maj + 1 : maj;
}
// istanbul ignore next
function incrementMinor(min: number, ptch: number, pre: string[]): number {
return ptch === 0 || pre.length === 0 ? min + 1 : min;
}
// istanbul ignore next
function incrementPatch(ptch: number, pre: string[]): number {
return pre.length === 0 ? ptch + 1 : ptch;
}
// istanbul ignore next
function increment(from: string, to: string): string {
const parsed = parse(from);
const { major: maj, prerelease: pre } = parsed;
let { minor: min, patch: ptch } = parsed;
min = min || 0;
ptch = ptch || 0;
let nextVersion: string;
const adapted = adapt(to, from);
if (eq(from, adapted)) {
return incrementLastSegment(from);
}
function isStable(x: string): boolean {
return regEx(/^[0-9.-/]+$/).test(x);
}
if (major(from) !== major(adapted)) {
nextVersion = [incrementMajor(maj, min, ptch, coerceArray(pre)), 0, 0].join(
'.',
);
} else if (minor(from) !== minor(adapted)) {
nextVersion = [maj, incrementMinor(min, ptch, coerceArray(pre)), 0].join(
'.',
);
} else if (patch(from) !== patch(adapted)) {
nextVersion = [maj, min, incrementPatch(ptch, coerceArray(pre))].join('.');
} else if (isStable(from) && isStable(adapted)) {
nextVersion = [maj, min, incrementPatch(ptch, coerceArray(pre))].join('.');
} else {
nextVersion = [maj, min, ptch].join('.');
}
return increment(nextVersion, to);
}
// istanbul ignore next
function decrement(version: string): string {
const segments = releaseSegments(version);
const nextSegments = segments
.reverse()
.reduce(
(
accumulator: number[],
segment: SegmentElement,
index: number,
): number[] => {
if (index === 0) {
return [(segment as number) - 1];
}
if (accumulator[index - 1] === -1) {
return [
...accumulator.slice(0, index - 1),
0,
(segment as number) - 1,
];
}
return [...accumulator, segment as number];
},
[],
);
return nextSegments.reverse().join('.');
}
export {
adapt,
decrement,
floor,
increment,
parse,
pgteUpperBound,
trimZeroes,
};