Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(npm): Support for new option replacementApproach #34018

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/usage/configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -3252,6 +3252,16 @@ Here's an example of how you would define PR priority so that `devDependencies`
}
```

### replacementApproach

For `npm` manager when `replacementApproach=alias` then instead of replacing `"foo": "1.2.3"` with `"@my/foo": "1.2.4"` we would instead replace it with `"foo": "npm:@my/[email protected]"`.

```json
{
"replacementApproach": "alias"
}
```

### replacementName

This config option only works with some managers.
Expand Down
8 changes: 8 additions & 0 deletions lib/config/options/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1465,6 +1465,14 @@ const options: RenovateOptions[] = [
cli: false,
env: false,
},
{
name: 'replacementApproach',
description: 'Alter the behavior of how package renames are handled.',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: 'Alter the behavior of how package renames are handled.',
description: 'Select whether to perform a direct replacement or alias replacement.',

type: 'string',
stage: 'branch',
allowedValues: ['replace', 'alias'],
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
allowedValues: ['replace', 'alias'],
allowedValues: ['replace', 'alias'],
supportedManagers: ['npm'],

default: 'replace',
},
{
name: 'matchConfidence',
description:
Expand Down
18 changes: 18 additions & 0 deletions lib/modules/manager/npm/update/dependency/index.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import * as npmUpdater from '../..';
import { Fixtures } from '../../../../../../test/fixtures';
import { type Upgrade } from '../../../types';

const readFixture = (x: string): string => Fixtures.get(x, '../..');

Expand Down Expand Up @@ -254,6 +255,23 @@ describe('modules/manager/npm/update/dependency/index', () => {
expect(JSON.parse(testContent!).dependencies.abc).toBe('2.0.0');
});

it('supports alias-based replacement', () => {
const upgrade: Upgrade = {
depType: 'dependencies',
depName: 'config',
newName: 'abc',
replacementApproach: 'alias',
newValue: '2.0.0',
};
const testContent = npmUpdater.updateDependency({
fileContent: input01Content,
upgrade,
});
expect(JSON.parse(testContent!).dependencies.config).toBe(
'npm:[email protected]',
);
});

it('replaces glob package resolutions', () => {
const upgrade = {
depType: 'dependencies',
Expand Down
37 changes: 25 additions & 12 deletions lib/modules/manager/npm/update/dependency/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -161,25 +161,38 @@ export function updateDependency({
}

// TODO #22198
let newFileContent = replaceAsString(
parsedContents,
fileContent,
depType as NpmDepType,
depName,
oldVersion!,
newValue!,
overrideDepParents,
);
if (upgrade.newName) {
let newFileContent = fileContent;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
let newFileContent = fileContent;
let newFileContent: string;

if (upgrade.newName && upgrade.replacementApproach === 'alias') {
newFileContent = replaceAsString(
parsedContents,
newFileContent,
fileContent,
depType as NpmDepType,
depName,
oldVersion!,
`npm:${upgrade.newName}@${newValue}`,
overrideDepParents,
);
} else {
newFileContent = replaceAsString(
parsedContents,
fileContent,
depType as NpmDepType,
depName,
upgrade.newName,
oldVersion!,
newValue!,
overrideDepParents,
);
if (upgrade.newName) {
newFileContent = replaceAsString(
parsedContents,
newFileContent,
depType as NpmDepType,
depName,
depName,
upgrade.newName,
overrideDepParents,
);
}
}
// istanbul ignore if
if (!newFileContent) {
Expand Down
1 change: 1 addition & 0 deletions lib/modules/manager/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,7 @@ export interface Upgrade<T = Record<string, any>> extends PackageDependency<T> {
registryUrls?: string[] | null;
currentVersion?: string;
replaceString?: string;
replacementApproach?: 'replace' | 'alias';
}

export interface ArtifactNotice {
Expand Down
Loading