Skip to content

fix(scripts): update overrides when updating packages #7081

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

Merged
merged 1 commit into from
Jul 2, 2025
Merged

fix(scripts): update overrides when updating packages #7081

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
1 change: 1 addition & 0 deletions scripts/update-dependencies-config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ module.exports = {
'@typescript-eslint/eslint-plugin',
'@typescript-eslint/parser',
'eslint@8', // TODO: update to flat config, switch to eslint 9, remove the fixed version
'eslint-plugin-chai-friendly',
Copy link
Collaborator Author

@gribnoysup gribnoysup Jul 2, 2025

Choose a reason for hiding this comment

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

Also forgot to add this dependency in the list here

'eslint-plugin-jsx-a11y',
'eslint-plugin-react',
'eslint-plugin-react-hooks',
Expand Down
85 changes: 60 additions & 25 deletions scripts/update-dependencies.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@ const {

const UPDATE_CONFIGS = require('./update-dependencies-config');

async function hoistSharedDependencies(newVersions) {
async function hoistSharedDependencies(root, newVersions) {
try {
const root = await findMonorepoRoot();

await withProgress('Cleaning up existing node_modules', async () => {
await runInDir("npx lerna exec 'rm -Rf node_modules'", root);
await runInDir('rm -Rf node_modules', root);
Expand Down Expand Up @@ -71,6 +69,55 @@ async function getVersion(depSpec) {
return [name, version.trim()];
}

function updateDependencies(packageJson, newVersions) {
for (const depType of [
'dependencies',
'devDependencies',
'peerDependencies',
'optionalDependencies',
]) {
if (packageJson[depType]) {
for (const packageName of Object.keys(packageJson[depType])) {
if (packageJson[depType][packageName] && newVersions[packageName]) {
packageJson[depType][packageName] = `^${newVersions[packageName]}`;
}
}
}
}
}

/**
* example overrides config:
*
* {
* "overrides": {
* "@npm/foo": "1.0.0",
* "@npm/bar": {
* ".": "1.0.0",
* "@npm/buz": "1.0.0"
* },
* "@npm/a": {
* "@npm/b": {
* "@npm/c": "1.0.0"
* }
* }
* }
* }
*
* https://docs.npmjs.com/cli/v11/configuring-npm/package-json#overrides
*/
function updateOverrides(overrides, newVersions, parent) {
for (const name of Object.keys(overrides ?? {})) {
if (typeof overrides[name] === 'string' && newVersions[name]) {
overrides[name] = `^${newVersions[name]}`;
} else if (name === '.' && parent && newVersions[parent]) {
overrides[name] = `^${newVersions[name]}`;
} else if (typeof overrides[name] === 'object') {
updateOverrides(overrides[name], newVersions, name);
}
}
}

async function main() {
let dependencies;

Expand Down Expand Up @@ -124,29 +171,17 @@ async function main() {
const newVersionsObj = Object.fromEntries(newVersions);
let hasChanged;

const monorepoRoot = await findMonorepoRoot();
const workspaces = [monorepoRoot].concat(
await Array.fromAsync(listAllPackages(), (workspace) => workspace.location)
);

await withProgress('Updating package.json in workspaces', async () => {
for await (const props of listAllPackages()) {
await updatePackageJson(props.location, (packageJson) => {
for (const workspacePath of workspaces) {
await updatePackageJson(workspacePath, (packageJson) => {
const origPackageJson = cloneDeep(packageJson);
for (const depType of [
'dependencies',
'devDependencies',
'peerDependencies',
'optionalDependencies',
]) {
if (packageJson[depType]) {
for (const packageName of Object.keys(packageJson[depType])) {
if (
packageJson[depType][packageName] &&
newVersionsObj[packageName]
) {
packageJson[depType][
packageName
] = `^${newVersionsObj[packageName]}`;
}
}
}
}
updateDependencies(packageJson, newVersionsObj);
updateOverrides(packageJson.overrides, newVersionsObj);
hasChanged = hasChanged || !isEqual(origPackageJson, packageJson);
return packageJson;
});
Expand All @@ -159,7 +194,7 @@ async function main() {
return;
}

await hoistSharedDependencies(newVersions);
await hoistSharedDependencies(monorepoRoot, newVersions);

console.log();
console.log('Successfully updated dependencies');
Expand Down
Loading