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(core): handle yarn workspace packages when pruning #13170

Merged
merged 2 commits into from Nov 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 23 additions & 0 deletions packages/nx/src/utils/lock-file/yarn.spec.ts
Expand Up @@ -182,6 +182,29 @@ describe('yarn LockFile utility', () => {
removeComment(berryLockFileDevkitAndYargs)
);
});

it('shold correctly prune lockfile with multiple packages and custom name', () => {
const result = pruneYarnLockFile(
parsedLockFile,
['yargs', '@nrwl/devkit', 'typescript'],
'custom-name'
);
expect(result.lockFileMetadata.workspacePackages).toMatchInlineSnapshot(`
Object {
"custom-name@workspace:^": Object {
"dependencies": Object {
"@nrwl/devkit": "14.7.5",
"typescript": "~4.8.2",
"yargs": "^17.4.0",
},
"languageName": "unknown",
"linkType": "soft",
"resolution": "custom-name@workspace:^",
"version": "0.0.0-use.local",
},
}
`);
});
});
});

Expand Down
63 changes: 36 additions & 27 deletions packages/nx/src/utils/lock-file/yarn.ts
Expand Up @@ -304,30 +304,41 @@ function pruneWorkspacePackages(
): LockFileDependencies {
const result: LockFileDependencies = {};

Object.entries(workspacePackages).forEach(
([packageKey, { dependencies, ...value }]) => {
const isRootPackage = packageKey.indexOf('@workspace:.') !== -1;
const prunedWorkspaceDependencies = pruneWorkspacePackageDependencies(
dependencies,
packages,
prunedDependencies,
isRootPackage
);
result[packageKey] = {
...value,
dependencies: sortObject(prunedWorkspaceDependencies),
};
}
);
let workspaceProjKey = '';

if (projectName) {
workspaceProjKey =
Object.keys(workspacePackages).find((key) =>
key.startsWith(`${projectName}@workspace:`)
) || `${projectName}@workspace:^`;
} else {
workspaceProjKey = Object.keys(workspacePackages).find(
(key) => key.indexOf('@workspace:.') !== -1
);
}

if (workspaceProjKey) {
const prunedWorkspaceDependencies = pruneWorkspacePackageDependencies(
workspacePackages[workspaceProjKey]?.dependencies || {},
packages,
prunedDependencies
);
result[workspaceProjKey] = {
version: '0.0.0-use.local',
resolution: workspaceProjKey,
languageName: 'unknown',
linkType: 'soft',
dependencies: sortObject(prunedWorkspaceDependencies),
};
}

return result;
}

function pruneWorkspacePackageDependencies(
dependencies: Record<string, string>,
packages: string[],
prunedDependencies: LockFileData['dependencies'],
isRoot: boolean
prunedDependencies: LockFileData['dependencies']
): Record<string, string> {
const result: Record<string, string> = {};

Expand All @@ -345,16 +356,14 @@ function pruneWorkspacePackageDependencies(
}
);
// add all missing deps to root workspace package
if (isRoot) {
packages.forEach((p) => {
if (!result[p]) {
// extract first version expression from package's structure
const metaVersion = Object.values(prunedDependencies[p])[0]
.packageMeta[0] as string;
result[p] = metaVersion.split('@npm:')[1];
}
});
}
packages.forEach((p) => {
if (!result[p]) {
// extract first version expression from package's structure
const metaVersion = Object.values(prunedDependencies[p])[0]
.packageMeta[0] as string;
result[p] = metaVersion.split('@npm:')[1];
}
});

return result;
}
Expand Down