mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-26 15:31:53 +00:00
Sebastian Poxhofer
e0cec3dc95
feat(lint): add `types-location` rule and enable it for `lib/modules`
Reviewers consistently ask for exported types to be moved into a
colocated `types.ts`. Add a `renovate/types-location` oxlint rule that
reports `export interface` / `export type` declarations outside such a
file, and turn it on across `lib/modules`.
Re-exports (`export type { X }`, `export type *`), file-local types, and
values (enums, classes, functions) are left alone. `schema.ts` files and
`schema/` directories are excluded via config, matching how
`zod-schema-location` is configured — inferred types belong next to the
schema they are derived from.
Relocating the 87 existing violations means:
- new `types.ts` files for the modules that had none
- `terragrunt/common.ts` folded into its `types.ts`, as it held nothing
else
- `RangeBound` in `versioning/gradle/compare.ts` un-exported, since only
a file-local interface referenced it
- `bazel-module/parser/fragments.ts` split from its inferred types, which
now live in `parser/types.ts` and infer through a namespace import so
each schema keeps its merged name
101 lines
3.1 KiB
TypeScript
101 lines
3.1 KiB
TypeScript
import { regEx } from '../../../util/regex.ts';
|
|
import { coerceString } from '../../../util/string.ts';
|
|
import { GenericVersioningApi } from '../generic.ts';
|
|
import type { GenericVersion, VersioningApi } from '../types.ts';
|
|
|
|
export const id = 'docker';
|
|
export const displayName = 'Docker';
|
|
export const urls = [
|
|
'[Docker tag command](https://docs.docker.com/engine/reference/commandline/tag/)',
|
|
];
|
|
export const supportsRanges = false;
|
|
|
|
const versionPattern = regEx(/^(?<version>\d+(?:\.\d+)*)(?<prerelease>\w*)$/);
|
|
const commitHashPattern = regEx(/^[a-f0-9]{7,40}$/);
|
|
const numericPattern = regEx(/^[0-9]+$/);
|
|
|
|
class DockerVersioningApi extends GenericVersioningApi {
|
|
protected _parse(version: string): GenericVersion | null {
|
|
if (!version) {
|
|
return null;
|
|
}
|
|
if (commitHashPattern.test(version) && !numericPattern.test(version)) {
|
|
return null;
|
|
}
|
|
const versionPieces = version.replace(regEx(/^v/), '').split('-');
|
|
const [prefix, ...suffixPieces] = versionPieces;
|
|
const matchGroups = prefix?.match(versionPattern)?.groups;
|
|
if (!matchGroups) {
|
|
return null;
|
|
}
|
|
|
|
const { version: ver, prerelease } = matchGroups;
|
|
const release = ver.split('.').map(Number);
|
|
return { release, suffix: suffixPieces.join('-'), prerelease };
|
|
}
|
|
|
|
protected override _compare(version: string, other: string): number {
|
|
const parsed1 = this._parse(version);
|
|
const parsed2 = this._parse(other);
|
|
// istanbul ignore if
|
|
if (!(parsed1 && parsed2)) {
|
|
return 1;
|
|
}
|
|
const length = Math.max(parsed1.release.length, parsed2.release.length);
|
|
for (let i = 0; i < length; i += 1) {
|
|
const part1 = parsed1.release[i];
|
|
const part2 = parsed2.release[i];
|
|
// shorter is bigger 2.1 > 2.1.1
|
|
if (part1 === undefined) {
|
|
return 1;
|
|
}
|
|
if (part2 === undefined) {
|
|
return -1;
|
|
}
|
|
if (part1 !== part2) {
|
|
return part1 - part2;
|
|
}
|
|
}
|
|
if (parsed1.prerelease !== parsed2.prerelease) {
|
|
// unstable is lower
|
|
if (!parsed1.prerelease && parsed2.prerelease) {
|
|
return 1;
|
|
}
|
|
if (parsed1.prerelease && !parsed2.prerelease) {
|
|
return -1;
|
|
}
|
|
// alphabetic order
|
|
if (parsed1.prerelease && parsed2.prerelease) {
|
|
return parsed1.prerelease.localeCompare(parsed2.prerelease);
|
|
}
|
|
}
|
|
|
|
// equals
|
|
const suffix1 = coerceString(parsed1.suffix);
|
|
const suffix2 = coerceString(parsed2.suffix);
|
|
return suffix2.localeCompare(suffix1);
|
|
}
|
|
|
|
override isCompatible(version: string, current: string): boolean {
|
|
const parsed1 = this._parse(version);
|
|
const parsed2 = this._parse(current);
|
|
/* oxlint-disable typescript/prefer-optional-chain */
|
|
return !!(
|
|
parsed1 &&
|
|
parsed2 &&
|
|
parsed1.suffix === parsed2.suffix &&
|
|
parsed1.release.length === parsed2.release.length
|
|
);
|
|
/* oxlint-enable typescript/prefer-optional-chain */
|
|
}
|
|
|
|
valueToVersion(value: string): string {
|
|
// Remove any suffix after '-', e.g. '-alpine'
|
|
return value ? value.split('-')[0] : value;
|
|
}
|
|
}
|
|
|
|
export const api: VersioningApi = new DockerVersioningApi();
|
|
|
|
export default api;
|