-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
zharinov
wants to merge
2
commits into
renovatebot:main
Choose a base branch
from
zharinov:feat/replacement-approach-alias
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
|
@@ -1465,6 +1465,14 @@ const options: RenovateOptions[] = [ | |||||||
cli: false, | ||||||||
env: false, | ||||||||
}, | ||||||||
{ | ||||||||
name: 'replacementApproach', | ||||||||
description: 'Alter the behavior of how package renames are handled.', | ||||||||
type: 'string', | ||||||||
stage: 'branch', | ||||||||
allowedValues: ['replace', 'alias'], | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
default: 'replace', | ||||||||
}, | ||||||||
{ | ||||||||
name: 'matchConfidence', | ||||||||
description: | ||||||||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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, '../..'); | ||
|
||
|
@@ -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', | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -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; | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
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) { | ||||||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.