Files
Sebastian Poxhofer 3412de84ce refactor(linters): enable oxlint rule prefer-named-capture-group (#44714)
* refactor(lint): enable oxlint prefer-named-capture-group at error

Numbered capture groups (m[1], $1) break silently when a regex is
edited and group order shifts. Named groups (?<name>...) make intent
explicit and accesses (m.groups.name) resilient to reordering.

This enables the built-in eslint rule prefer-named-capture-group,
surfacing 321 pre-existing unnamed-group violations across ~121
files to be burned down incrementally in follow-up commits.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RxHFNsSworLcv23xXk9Hk

* refactor(versioning): name capture groups for prefer-named-capture-group

Burns down all prefer-named-capture-group violations in
lib/modules/versioning/. Unused capture groups (only reachable via
.test() or whole-match) become non-capturing (?:...); groups whose
value is read become named (?<name>...), with accesses rewritten to
match.groups!.<name> (or destructured from .groups!) instead of
positional match[n]/$n so a future edit that reorders groups cannot
silently break the reader.

Two cases needed extra care to preserve behavior:
- semver/common.ts and poetry/patterns.ts split() on a regex whose
  capture group is relied upon by String.prototype.split to keep the
  separator in the output array; the group is kept capturing and
  named, not converted to non-capturing.
- hashicorp/convertor.ts's semverRegex is only ever embedded via
  .source into a named `(?<version>...)` group elsewhere and never
  matched directly, so its internal groups are safe to make
  non-capturing.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RxHFNsSworLcv23xXk9Hk

* refactor(datasource): name capture groups for prefer-named-capture-group

Burns down all prefer-named-capture-group violations under
lib/modules/datasource/. Same treatment as the versioning module:
unused groups become non-capturing, used groups get names, and
positional match[n] reads move to match.groups!.<name>.

docker/ecr.ts and pypi/common.ts keep their positional destructuring
(`const [, region] = ...`, `!!m &&`) working unchanged since a named
capture group is still addressable by its numeric index in
JavaScript — only pypi/common.ts's access was rewritten to
m.groups!.owner for clarity since it read a single group directly.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RxHFNsSworLcv23xXk9Hk

* refactor(platform): name capture groups for prefer-named-capture-group

Burns down all prefer-named-capture-group violations under
lib/modules/platform/. Uses the repo's established idiom of
`match.groups?.<name>` after an optional-chained exec()/match() (see
bitbucket/index.ts hostnameWithoutApiPrefix, gerrit/utils.ts
extractSourceBranch) and `$<name>` in String.replace replacement
strings. Unused groups (markdown/HTML massaging regexes matched only
to be stripped) become non-capturing.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RxHFNsSworLcv23xXk9Hk

* refactor(manager): name capture groups in ansible-galaxy for prefer-named-capture-group

Burns down prefer-named-capture-group violations in
lib/modules/manager/ansible-galaxy/. newBlockRegEx and blockLineRegEx
dropped their unused outer wrapping group (only the inner key/value
groups were ever read) and named the key/value groups; nameMatchRegex's
remaining unused groups (protocol/user-info/port alternatives) become
non-capturing since only source/hostname/depName/version are read via
.groups. Accesses in collections.ts and roles.ts move from
lineMatch[2]/lineMatch[3] to lineMatch.groups!.key/value.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RxHFNsSworLcv23xXk9Hk

* refactor(manager): name capture groups for prefer-named-capture-group (batch 1)

Burns down prefer-named-capture-group violations across the first
alphabetical slice of lib/modules/manager/ (ansible through mix).
Used groups get names with accesses rewritten to match.groups!.<name>
(or $<name> in replacement strings); groups whose value is never read
become non-capturing (?:...). Two String.split() call sites
(git-submodules/extract.ts, meteor/extract.ts) keep the established
"named group still readable positionally from the split() result
array" idiom instead of restructuring the destructuring.

bazel/rules/go.ts and buildpacks/extract.ts dockerRef verified
byte-for-byte equivalent before/after via a quick node script since
several nested groups collapsed to non-capturing at once.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RxHFNsSworLcv23xXk9Hk

* refactor(manager): name capture groups for prefer-named-capture-group (batch 2)

Burns down prefer-named-capture-group violations across the remaining
alphabetical slice of lib/modules/manager/ (npm through terragrunt).
Same treatment as batch 1: used groups get names with accesses moved
to match.groups!.<name> or $<name> replacement strings; unused groups
(wrapping alternations, quantifier repetition groups only consumed via
.test(), or values never read from a match) become non-capturing.

terraform/extractors/others/modules.ts and terragrunt/modules.ts share
near-identical URL-parsing regexes (github/bitbucket/git/azure-devops
ref matchers) — the same set of always-unused `depth=`/`&depth=`
query-string groups is converted to non-capturing in both files.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RxHFNsSworLcv23xXk9Hk

* refactor(config): name capture groups for prefer-named-capture-group

Burns down prefer-named-capture-group violations in lib/config/.
Used groups get names with replacement strings switched from $1/$2 to
$<name>; the unused separator group in schedule-migration.ts's
afterBeforeRegex becomes non-capturing. presets/parse.ts keeps
assigning through the already-declared `repo` variable rather than
array-destructuring the exec() result, matching this file's existing
style for the other named-group regexes just above it.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RxHFNsSworLcv23xXk9Hk

* refactor(util): name capture groups for prefer-named-capture-group

Burns down prefer-named-capture-group violations across lib/util/ and
lib/logger/. Same treatment as previous batches: named groups for
values that are read (via $<name> replacement strings, .groups!.<name>,
or destructured from .groups), non-capturing groups where nothing reads
the captured value (e.g. semantic.ts's angular-commit .test()-only
regex). www-authenticate.ts's tokenizer entries each get their own
named group but keep accessing the match generically via match[1],
since a positionally-indexed named group is still readable by index.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RxHFNsSworLcv23xXk9Hk

* refactor(workers): name capture groups for prefer-named-capture-group

Burns down prefer-named-capture-group violations in lib/workers/.
Used groups get names with $<name> replacement strings; unused
wrapper/alternation groups (e.g. semantic-commit-message.ts's optional
scope/issue wrappers, release-notes.ts's date-heading and
horizontal-rule matchers that are only probed with .search()/replaced
wholesale) become non-capturing.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RxHFNsSworLcv23xXk9Hk

* refactor(test,tools): name capture groups for prefer-named-capture-group

Finishes the prefer-named-capture-group burndown: test/, tools/, and
vitest.config.mts. Groups whose value is read get names ($<name>
replacement strings or .groups.<name> access); groups only used via
.test()/.search() or that feed a .match(/…/g) call (whose return value
is the array of whole matches, not captured groups) become
non-capturing.

This is the last remaining slice of pre-existing violations, so the
rule (already enabled at error repo-wide) now passes with zero
findings across the whole codebase.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017RxHFNsSworLcv23xXk9Hk

* fix prettier failure

* refactor(lint): use a named capture group in `v8-ignore-no-count`

New rule from main trips the newly enabled `prefer-named-capture-group` oxlint rule.

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-09-03 09:54:40 +00:00

355 lines
10 KiB
TypeScript

import { isString } from '@sindresorhus/is';
import * as semver from 'semver';
import type { SemVer } from 'semver-utils';
import { parseRange } from 'semver-utils';
import { logger } from '../../../logger/index.ts';
import { regEx } from '../../../util/regex.ts';
import { coerceString } from '../../../util/string.ts';
import type { NewValueConfig } from '../types.ts';
import {
cleanVersion,
containsOperators,
getOptions,
makeVersion,
matchesWithOptions,
} from './common.ts';
// always include prereleases
export function getMajor(version: string): null | number {
const cleanedVersion = cleanVersion(version);
const options = getOptions(version);
options.includePrerelease = true;
const cleanerVersion = makeVersion(cleanedVersion, options);
if (isString(cleanerVersion)) {
return parseInt(cleanerVersion.split('.')[0], 10);
}
return null;
}
// always include prereleases
export function getMinor(version: string): null | number {
const cleanedVersion = cleanVersion(version);
const options = getOptions(version);
options.includePrerelease = true;
const cleanerVersion = makeVersion(cleanedVersion, options);
if (isString(cleanerVersion)) {
return parseInt(cleanerVersion.split('.')[1], 10);
}
return null;
}
// always include prereleases
export function getPatch(version: string): null | number {
const cleanedVersion = cleanVersion(version);
const options = getOptions(version);
options.includePrerelease = true;
const cleanerVersion = makeVersion(cleanedVersion, options);
if (isString(cleanerVersion)) {
const newVersion = semver.valid(
semver.coerce(cleanedVersion, {
loose: false,
}),
options,
);
/* v8 ignore next -- newVersion always has a patch segment once cleanerVersion is a valid, coercible semver string */
return parseInt(coerceString(newVersion).split('.')[2] ?? '', 10);
}
return null;
}
export function fixParsedRange(range: string): any {
const ordValues = [];
// don't bump or'd single version values
const originalSplit = range.split(' ');
for (let i = 0; i < originalSplit.length; i += 1) {
if (
!containsOperators(originalSplit[i]) &&
!originalSplit[i].includes('||')
) {
if (i !== 0 && originalSplit[i - 1].includes('||')) {
ordValues.push(`|| ${originalSplit[i]}`);
} else if (i !== originalSplit.length && originalSplit[i + 1] === '||') {
ordValues.push(`${originalSplit[i]} ||`);
}
} else {
ordValues.push(originalSplit[i]);
}
}
const parsedRange = parseRange(range);
const cleanRange = range.replace(regEx(/(?:[<=>^~])(?: )?/g), '');
const splitRange = cleanRange.split(' ');
const semverRange: SemVer[] = [];
for (let i = 0; i < splitRange.length; i += 1) {
if (!splitRange[i].includes('||')) {
const splitVersion = splitRange[i].split('.');
const major = splitVersion[0];
const minor = splitVersion[1];
const patch = splitVersion[2];
const operator = ordValues[i].includes('||')
? '||'
: parsedRange[i].operator;
const NewSemVer: SemVer = {
major,
};
let full = `${coerceString(operator)}${major}`;
if (minor) {
NewSemVer.minor = minor;
full = `${full}.${minor}`;
if (patch) {
NewSemVer.patch = patch;
full = `${full}.${patch}`;
}
}
/* v8 ignore next -- a segment with no operator is only reachable when adjacent to `||`, which always makes `operator` truthy (`'||'`) above; any other bare segment throws earlier at ordValues[i] */
if (operator) {
NewSemVer.operator = operator;
full = range.includes(`${operator} `)
? `${operator} ${full.replace(operator, '')}`
: `${operator}${full.replace(operator, '')}`;
}
full = ordValues[i].includes('||') ? ordValues[i] : full;
NewSemVer.semver = full;
semverRange.push(NewSemVer);
}
}
return semverRange;
}
export function replaceRange({
currentValue,
newVersion,
}: NewValueConfig): string {
const parsedRange = parseRange(currentValue);
const element = parsedRange.at(-1)!;
const toVersionMajor = getMajor(newVersion);
const toVersionMinor = getMinor(newVersion);
const toVersionPatch = getPatch(newVersion);
const suffix = semver.prerelease(newVersion)
? `-${String(semver.prerelease(newVersion)?.[0])}`
: '';
if (element.operator === '~>') {
return `~> ${toVersionMajor}.${toVersionMinor}.0`;
}
if (element.operator === '=') {
return `=${newVersion}`;
}
if (element.operator === '~') {
if (suffix.length) {
return `~${toVersionMajor}.${toVersionMinor}.${toVersionPatch}${suffix}`;
}
return `~${toVersionMajor}.${toVersionMinor}.0`;
}
if (element.operator === '<=') {
let res;
if (!!element.patch || suffix.length) {
res = `<=${newVersion}`;
} else if (element.minor) {
res = `<=${toVersionMajor}.${toVersionMinor}`;
} else {
res = `<=${toVersionMajor}`;
}
if (currentValue.includes('<= ')) {
res = res.replace('<=', '<= ');
}
return res;
}
if (element.operator === '<' && toVersionMajor) {
let res;
if (currentValue.endsWith('.0.0')) {
const newMajor = toVersionMajor + 1;
res = `<${newMajor}.0.0`;
} else if (element.patch) {
res = `<${semver.inc(newVersion, 'patch')}`;
} else if (element.minor && toVersionMinor) {
res = `<${toVersionMajor}.${toVersionMinor + 1}`;
} else {
res = `<${toVersionMajor + 1}`;
}
if (currentValue.includes('< ')) {
res = res.replace(regEx(/</g), '< ');
}
return res;
}
if (element.operator === '>') {
let res;
if (currentValue.endsWith('.0.0') && toVersionMajor) {
const newMajor = toVersionMajor + 1;
res = `>${newMajor}.0.0`;
} else if (element.patch) {
res = `>${toVersionMajor}.${toVersionMinor}.${toVersionPatch}`;
} else if (element.minor) {
res = `>${toVersionMajor}.${toVersionMinor}`;
} else {
res = `>${toVersionMajor}`;
}
if (currentValue.includes('> ')) {
res = res.replace(regEx(/</g), '> ');
}
return res;
}
if (!element.operator) {
if (element.minor) {
if (element.minor === 'x') {
return `${toVersionMajor}.x`;
}
if (element.minor === '*') {
return `${toVersionMajor}.*`;
}
if (element.patch === 'x') {
return `${toVersionMajor}.${toVersionMinor}.x`;
}
if (element.patch === '*') {
return `${toVersionMajor}.${toVersionMinor}.*`;
}
return `${newVersion}`;
}
return `${toVersionMajor}`;
}
return newVersion;
}
export function widenRange(
{ currentValue, currentVersion, newVersion }: NewValueConfig,
options: semver.Options,
): string | null {
const parsedRange = parseRange(currentValue);
const element = parsedRange.at(-1)!;
if (matchesWithOptions(newVersion, currentValue, options)) {
return currentValue;
}
const newValue = replaceRange({
currentValue,
rangeStrategy: 'replace',
currentVersion,
newVersion,
});
if (element.operator?.startsWith('<')) {
const splitCurrent = currentValue.split(element.operator);
splitCurrent.pop();
return splitCurrent.join(element.operator) + newValue;
}
if (parsedRange.length > 1) {
const previousElement = parsedRange.at(-2)!;
if (previousElement.operator === '-') {
const splitCurrent = currentValue.split('-');
splitCurrent.pop();
return `${splitCurrent.join('-')}- ${newValue}`;
}
if (element.operator?.startsWith('>')) {
logger.warn(`Complex ranges ending in greater than are not supported`);
return null;
}
}
return `${currentValue} || ${newValue}`;
}
export function bumpRange(
{ currentValue, currentVersion, newVersion }: NewValueConfig,
options: semver.Options,
): string | null {
if (!containsOperators(currentValue) && currentValue.includes('||')) {
return widenRange(
{
currentValue,
rangeStrategy: 'widen',
currentVersion,
newVersion,
},
options,
);
}
const parsedRange = parseRange(currentValue);
const element = parsedRange.at(-1)!;
const toVersionMajor = getMajor(newVersion);
const toVersionMinor = getMinor(newVersion);
const suffix = semver.prerelease(newVersion)
? `-${String(semver.prerelease(newVersion)?.[0])}`
: '';
if (parsedRange.length === 1) {
if (!element.operator) {
return replaceRange({
currentValue,
rangeStrategy: 'replace',
currentVersion,
newVersion,
});
}
if (element.operator.startsWith('~')) {
const split = currentValue.split('.');
if (suffix.length) {
return `${element.operator}${newVersion}`;
}
if (split.length === 1) {
// ~4
return `${element.operator}${toVersionMajor}`;
}
if (split.length === 2) {
// ~4.1
return `${element.operator}${toVersionMajor}.${toVersionMinor}`;
}
return `${element.operator}${newVersion}`;
}
if (element.operator === '=') {
return `=${newVersion}`;
}
if (element.operator === '>=') {
return currentValue.includes('>= ')
? `>= ${newVersion}`
: `>=${newVersion}`;
}
if (element.operator.startsWith('<')) {
return currentValue;
}
} else {
const newRange = fixParsedRange(currentValue);
const versions = newRange.map((x: any) => {
// don't bump or'd single version values
if (x.operator === '||') {
return x.semver;
}
/* v8 ignore next -- fixParsedRange only ever produces elements with `operator === '||'` (handled above) or a real comparator operator; a falsy, non-`||` operator would have already thrown inside fixParsedRange */
if (x.operator) {
const bumpedSubRange = bumpRange(
{
currentValue: x.semver,
rangeStrategy: 'bump',
currentVersion,
newVersion,
},
options,
);
if (
bumpedSubRange &&
matchesWithOptions(newVersion, bumpedSubRange, options)
) {
return bumpedSubRange;
}
}
return replaceRange({
currentValue: x.semver,
rangeStrategy: 'replace',
currentVersion,
newVersion,
});
});
return versions.filter((x: any) => x !== null && x !== '').join(' ');
}
logger.debug(
`Unsupported range type for rangeStrategy=bump: ${currentValue}`,
);
return null;
}