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.

Sign up for GitHub

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

fix(npm): replace pnpm overrides in right position #28606

Merged
merged 1 commit into from
Apr 24, 2024
Merged

fix(npm): replace pnpm overrides in right position #28606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion lib/modules/manager/npm/extract/common/package-file.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ export function extractPackageJson(
if (is.string(overridesVal)) {
dep = {
depName: overridesKey,
depType: 'overrides',
depType: 'pnpm.overrides',
...extractDependency(depName, overridesKey, overridesVal),
};
setNodeCommitTopic(dep);
Expand Down
4 changes: 2 additions & 2 deletions lib/modules/manager/npm/extract/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -934,15 +934,15 @@ describe('modules/manager/npm/extract/index', () => {
prettyDepType: 'devDependency',
},
{
depType: 'overrides',
depType: 'pnpm.overrides',
depName: 'node',
currentValue: '8.9.2',
datasource: 'npm',
commitMessageTopic: 'Node.js',
prettyDepType: 'overrides',
},
{
depType: 'overrides',
depType: 'pnpm.overrides',
depName: '@types/react',
currentValue: '18.0.5',
datasource: 'npm',
Expand Down
3 changes: 3 additions & 0 deletions lib/modules/manager/npm/extract/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ export type NpmPackage = PackageJson & {
dependenciesMeta?: DependenciesMeta;
overrides?: OverrideDependency;
volta?: PackageJson.Dependency;
pnpm?: {
overrides?: PackageJson.Dependency;
};
};

export type LockFileEntry = Record<
Expand Down
27 changes: 27 additions & 0 deletions lib/modules/manager/npm/update/dependency/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,5 +375,32 @@ describe('modules/manager/npm/update/dependency/index', () => {
});
expect(testContent).toEqual(expected);
});

it('handles pnpm.override dependency', () => {
const upgrade = {
depType: 'pnpm.overrides',
depName: 'typescript',
newValue: '0.60.0',
};
const overrideDependencies = `{
"pnpm": {
"overrides": {
"typescript": "0.0.5"
}
}
}`;
const expected = `{
"pnpm": {
"overrides": {
"typescript": "0.60.0"
}
}
}`;
const testContent = npmUpdater.updateDependency({
fileContent: overrideDependencies,
upgrade,
});
expect(testContent).toEqual(expected);
});
});
});
16 changes: 11 additions & 5 deletions lib/modules/manager/npm/update/dependency/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,20 @@ function renameObjKey(
function replaceAsString(
parsedContents: NpmPackage,
fileContent: string,
depType: NpmDepType | 'dependenciesMeta' | 'packageManager',
depType:
| NpmDepType
| 'dependenciesMeta'
| 'packageManager'
| 'pnpm.overrides',
depName: string,
oldValue: string,
newValue: string,
parents?: string[],
): string {
if (depType === 'packageManager') {
parsedContents[depType] = newValue;
} else if (depType === 'pnpm.overrides') {
parsedContents.pnpm!.overrides![depName] = newValue;
} else if (depName === oldValue) {
// The old value is the name of the dependency itself
delete Object.assign(parsedContents[depType]!, {
Expand Down Expand Up @@ -130,10 +136,9 @@ export function updateDependency({
}
}
if (upgrade.npmPackageAlias) {
// TODO: types (#22198)
newValue = `npm:${upgrade.packageName}@${newValue}`;
}
// TODO: types (#22198)

logger.debug(`npm.updateDependency(): ${depType}.${depName} = ${newValue}`);
try {
const parsedContents: NpmPackage = JSON.parse(fileContent);
Expand All @@ -142,7 +147,6 @@ export function updateDependency({
let oldVersion: string | undefined;
if (depType === 'packageManager') {
oldVersion = parsedContents[depType];
// TODO: types (#22198)
newValue = `${depName}@${newValue}`;
} else if (isOverrideObject(upgrade)) {
overrideDepParents = managerData?.parents;
Expand All @@ -157,8 +161,9 @@ export function updateDependency({
oldVersion = depObjectReference[overrideDepName]!;
}
}
} else if (depType === 'pnpm.overrides') {
oldVersion = parsedContents.pnpm?.overrides?.[depName];
} else {
// eslint-disable @typescript-eslint/no-unnecessary-type-assertion
oldVersion = parsedContents[depType as NpmDepType]![depName] as string;
}
if (oldVersion === newValue) {
Expand Down Expand Up @@ -262,6 +267,7 @@ export function updateDependency({
return null;
}
}

function overrideDepPosition(
overrideBlock: OverrideDependency,
parents: string[],
Expand Down