Files
renovate/lib/modules/manager/hermit/extract.ts
Sebastian Poxhofer a1971afa78 fix(linters): add linting rule to enforce usage of our regEx utility (#44690)
* ci(linter): add renovate/require-regex-util rule

Adds a custom oxlint rule that flags raw RegExp usage in lib/
production code: any `new RegExp(...)` call and any regex literal
that is not the direct first argument of `regEx(...)`. The regEx()
helper from lib/util/regex.ts uses the RE2 engine for ReDoS-safe
matching and caches compiled patterns. lib/util/regex.ts itself is
exempt.

The rule is disabled for **/*.spec.ts, test/**, and tools/** via
config overrides, because vitest APIs such as expect.stringMatching
need bare RegExp instances (a past commit reverted regEx() there).

Severity is set to "warn" instead of "error": the repo currently has
197 pre-existing violations (above the agreed mechanical-fix
threshold of 80), and a number of them are deliberately
RE2-incompatible patterns (lookahead/lookbehind/named backreferences,
see TODO #12872/#12875 markers in e.g. lib/modules/versioning/rez/
pattern.ts and lib/modules/manager/dockerfile/extract.ts) that need
per-site judgment before they can be wrapped in regEx() or suppressed
with a justified disable comment. No violation fixes are included in
this commit.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* ci(linter): enforce renovate/require-regex-util at error

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* refactor: use regEx() for regex literals and RegExp construction in lib

Burn down all renovate/require-regex-util violations (197):

- wrap RE2-compatible regex literals and RegExp constructions in regEx()
- rewrite lookaround patterns where behavior is provably preserved:
  goproxy separator split, sbt-package link extraction, leiningen
  comment stripping and keyword search, npm GitHub owner validation
  (unit-count bound replaced by an explicit length check)
- keep native RegExp with disable comments where RE2 cannot be used:
  moo / good-enough-parser lexer patterns (moo rejects RE2 instances),
  MigrationsService propertyName (matched via isRegExp, which RE2
  instances fail), rez named backreferences and lookaheads, GitHub
  markdown link negative lookbehind, emoji astral-plane matching
- drop stale TODO #12875 comments for patterns current re2 handles

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* refactor: reduce require-regex-util disable comments

Rewrite the github massage-markdown-links URL regex to capture an
optional `api.` prefix in a named group (skipped in code) instead of
relying on a negative lookbehind, so both the base and global variants
can use regEx()/RE2 and their two disable comments are removed. Add
spec cases for api-prefixed URLs that match the URL shape.

Consolidate the four related line disables in rez/pattern.ts (bound and
range patterns emulating Python conditional patterns via named
backreferences and lookaheads, which RE2 cannot express) into a single
block disable/enable pair, matching the treatment of the lexer files.

Disable comment count drops from 13 to 8.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* refactor(datasource/sbt-package): use named capture group in link regex

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* refactor(manager/cake): restore original multiLineComment regex spelling

The [^] -> [\\s\\S] rewrite was only needed for an RE2 wrap that was
later reverted; keep the diff minimal.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(datasource/go): skip empty GOPROXY segments

The switch from a lookahead split to a capture-group split (needed because
RE2 has no lookahead support) changed how empty GOPROXY segments parse:
`a|,b` yielded `{ url: ',', fallback: '|' }` before and
`{ url: '', fallback: ',' }` after. The comma fallback only continues on
404/410, so a failing proxy ahead of an empty segment silently stopped the
lookup instead of falling through to the remaining proxies.

Empty segments carry no url to query, so drop them.

* refactor(datasource/go): use isTruthy for empty segment filter

* fix(datasource/go): filter empty segments before mapping

Filtering after the map broke the contextual typing from the
GoproxyItem[] annotation, widening fallback to string.

* refactor(platform/github): use regEx() for merge queue query stripping

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-14 14:30:46 +00:00

107 lines
2.7 KiB
TypeScript

import upath from 'upath';
import { logger } from '../../../logger/index.ts';
import { readLocalDirectory } from '../../../util/fs/index.ts';
import { minimatch } from '../../../util/minimatch.ts';
import { regEx } from '../../../util/regex.ts';
import { HermitDatasource } from '../../datasource/hermit/index.ts';
import type { PackageDependency, PackageFileContent } from '../types.ts';
import type { HermitListItem } from './types.ts';
const pkgReferenceRegex = regEx(`(?<packageName>.*?)-(?<version>[0-9]{1}.*)`);
/**
* extractPackageFile scans the folder of the package files
* and looking for .{packageName}-{version}.pkg
*/
export async function extractPackageFile(
_content: string,
packageFile: string,
): Promise<PackageFileContent | null> {
logger.trace(`hermit.extractPackageFile(${packageFile})`);
const dependencies = [] as PackageDependency[];
const packages = await listHermitPackages(packageFile);
if (!packages?.length) {
return null;
}
for (const p of packages) {
// version of a hermit package is either a Version or a Channel
// Channel will prepend with @ to distinguish from normal version
const version = p.Version === '' ? `@${p.Channel}` : p.Version;
const dep: PackageDependency = {
datasource: HermitDatasource.id,
depName: p.Name,
currentValue: version,
};
dependencies.push(dep);
}
return { deps: dependencies };
}
/**
* listHermitPackages will fetch all installed packages from the bin folder
*/
async function listHermitPackages(
packageFile: string,
): Promise<HermitListItem[] | null> {
logger.trace('hermit.listHermitPackages()');
const hermitFolder = upath.dirname(packageFile);
let files: string[] = [];
try {
files = await readLocalDirectory(hermitFolder);
} catch (err) {
logger.debug(
{ hermitFolder, err, packageFile },
'error listing hermit package references',
);
return null;
}
logger.trace({ files, hermitFolder }, 'files for hermit package list');
const out = [] as HermitListItem[];
for (const f of files) {
if (!minimatch('.*.pkg').match(f)) {
continue;
}
const fileName = f
.replace(`${hermitFolder}/`, '')
.substring(1)
.replace(regEx(/\.pkg$/), '');
const channelParts = fileName.split('@');
if (channelParts.length > 1) {
out.push({
Name: channelParts[0],
Channel: channelParts[1],
Version: '',
});
}
const groups = pkgReferenceRegex.exec(fileName)?.groups;
if (!groups) {
logger.debug(
{ fileName },
'invalid hermit package reference file name found',
);
continue;
}
out.push({
Name: groups.packageName,
Version: groups.version,
Channel: '',
});
}
return out;
}