Skip to content

chore: Expand scope of dependency mismatch generator #24880

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
ling1726 merged 3 commits into from
Sep 22, 2022
Merged

chore: Expand scope of dependency mismatch generator #24880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e3f21a2
chore: Expand scope of dependency mismatch generator
ling1726 Sep 21, 2022
0663414
update unit tests
ling1726 Sep 21, 2022
07bcf33
use react-northstar instead of northstar
ling1726 Sep 22, 2022
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
97 changes: 73 additions & 24 deletions tools/generators/dependency-mismatch/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,25 @@ describe('dependency-mismatch generator', () => {
name: 'public-docsite-v9',
version: '9.0.0',
dependencies: {
[`${workspaceNpmScope}/react-theme`]: '^9.0.0',
[`@${workspaceNpmScope}/react-theme`]: '^9.0.0',
},
devDependencies: {},
peerDependencies: {},
});

setupDummyPackage(appTree, {
name: 'react-theme',
version: '9.0.1',
dependencies: {},
devDependencies: {},
peerDependencies: {},
});
await generator(appTree);

const packageJson: PackageJson = await readTargetPackageJson();
expect(packageJson.dependencies).toMatchInlineSnapshot(`
Object {
"proj/react-theme": "^9.0.1",
"@proj/react-theme": "^9.0.1",
}
`);
});
Expand All @@ -44,49 +46,53 @@ describe('dependency-mismatch generator', () => {
name: 'public-docsite-v9',
version: '9.0.0',
devDependencies: {
[`${workspaceNpmScope}/react-theme`]: '^9.0.0',
[`@${workspaceNpmScope}/react-theme`]: '^9.0.0',
},
dependencies: {},
peerDependencies: {},
});

setupDummyPackage(appTree, {
name: 'react-theme',
version: '9.0.1',
dependencies: {},
devDependencies: {},
peerDependencies: {},
});
await generator(appTree);

const packageJson: PackageJson = await readTargetPackageJson();
expect(packageJson.devDependencies).toMatchInlineSnapshot(`
Object {
"proj/react-theme": "^9.0.1",
"@proj/react-theme": "^9.0.1",
}
`);
});

it('should ignore non-converged dependency', async () => {
it('should also fix peer dependencies', async () => {
const { readPackageJson: readTargetPackageJson } = setupDummyPackage(appTree, {
name: 'public-docsite-v9',
version: '9.0.0',
dependencies: {
[`${workspaceNpmScope}/react-focus`]: '^8.0.0',
peerDependencies: {
[`@${workspaceNpmScope}/react-theme`]: '^9.0.0',
},
dependencies: {},
devDependencies: {},
});

setupDummyPackage(appTree, {
name: 'react-focus',
version: '8.0.1',
name: 'react-theme',
version: '9.0.1',
dependencies: {},
devDependencies: {},
peerDependencies: {},
});
await generator(appTree);

const packageJson: PackageJson = await readTargetPackageJson();
expect(packageJson.dependencies).toMatchInlineSnapshot(`
expect(packageJson.peerDependencies).toMatchInlineSnapshot(`
Object {
"proj/react-focus": "^8.0.0",
"@proj/react-theme": "^9.0.1",
}
`);
});
Expand All @@ -96,31 +102,34 @@ describe('dependency-mismatch generator', () => {
name: 'public-docsite-v9',
version: '9.0.0',
dependencies: {
[`${workspaceNpmScope}/react-select`]: '^9.0.0-beta.1',
[`${workspaceNpmScope}/react-spinbutton`]: '9.0.0-beta.1',
[`@${workspaceNpmScope}/react-select`]: '^9.0.0-beta.1',
[`@${workspaceNpmScope}/react-spinbutton`]: '9.0.0-beta.1',
},
devDependencies: {},
peerDependencies: {},
});

setupDummyPackage(appTree, {
name: 'react-select',
version: '9.0.0-beta.2',
dependencies: {},
devDependencies: {},
peerDependencies: {},
});
setupDummyPackage(appTree, {
name: 'react-spinbutton',
version: '9.0.0-beta.2',
dependencies: {},
devDependencies: {},
peerDependencies: {},
});
await generator(appTree);

const packageJson: PackageJson = await readTargetPackageJson();
expect(packageJson.dependencies).toMatchInlineSnapshot(`
Object {
"proj/react-select": "^9.0.0-beta.2",
"proj/react-spinbutton": "9.0.0-beta.2",
"@proj/react-select": "^9.0.0-beta.2",
"@proj/react-spinbutton": "9.0.0-beta.2",
}
`);
});
Expand All @@ -130,23 +139,25 @@ describe('dependency-mismatch generator', () => {
name: 'react',
version: '8.0.0',
dependencies: {
[`${workspaceNpmScope}/react-portal-compat-context`]: '^9.0.0',
[`@${workspaceNpmScope}/react-portal-compat-context`]: '^9.0.0',
},
devDependencies: {},
peerDependencies: {},
});

setupDummyPackage(appTree, {
name: 'react-portal-compat-context',
version: '9.0.1',
dependencies: {},
devDependencies: {},
peerDependencies: {},
});
await generator(appTree);

const packageJson: PackageJson = await readTargetPackageJson();
expect(packageJson.dependencies).toMatchInlineSnapshot(`
Object {
"proj/react-portal-compat-context": "^9.0.1",
"@proj/react-portal-compat-context": "^9.0.1",
}
`);
});
Expand All @@ -156,39 +167,77 @@ describe('dependency-mismatch generator', () => {
name: 'react',
version: '8.0.0',
dependencies: {
[`${workspaceNpmScope}/tslib`]: '^2.1.1',
[`@${workspaceNpmScope}/tslib`]: '^2.1.1',
},
devDependencies: {},
peerDependencies: {},
});

await generator(appTree);

const packageJson: PackageJson = await readTargetPackageJson();
expect(packageJson.dependencies).toMatchInlineSnapshot(`
Object {
"@proj/tslib": "^2.1.1",
}
`);
});

it('generator should not run on northstar packages', async () => {
const { readPackageJson: readTargetPackageJson } = setupDummyPackage(
appTree,
{
name: 'react-northstar',
version: '0.66.0',
dependencies: {
[`@${workspaceNpmScope}/dom-utilities`]: '^1.1.1',
},
devDependencies: {},
peerDependencies: {},
},
['react-northstar'],
);

setupDummyPackage(appTree, {
name: 'dom-utilities',
version: '2.1.2',
dependencies: {},
devDependencies: {},
peerDependencies: {},
});

await generator(appTree);

const packageJson: PackageJson = await readTargetPackageJson();
expect(packageJson.dependencies).toMatchInlineSnapshot(`
Object {
"proj/tslib": "^2.1.1",
"@proj/dom-utilities": "^1.1.1",
}
`);
});
});

function setupDummyPackage(
tree: Tree,
options: {
packageJson: {
name: string;
version: string;
devDependencies: Record<string, string>;
dependencies: Record<string, string>;
peerDependencies: Record<string, string>;
},
tags: string[] = [],
Copy link
Contributor

@Hotell Hotell Sep 21, 2022

Choose a reason for hiding this comment

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

chore: can we have this only as options (named arguments), positional arguments don't scale and provide bad DX on call site

) {
const workspaceConfig = readWorkspaceConfiguration(tree);

const normalizedPkgName = `${workspaceConfig.npmScope}/${options.name}`;
const normalizedPkgName = `@${workspaceConfig.npmScope}/${packageJson.name}`;
const paths = {
root: `packages/${options.name}`,
root: `packages/${packageJson.name}`,
};

const templates = {
packageJson: {
...options,
...packageJson,
name: normalizedPkgName,
},
};
Expand All @@ -200,7 +249,7 @@ function setupDummyPackage(
root: paths.root,
projectType: 'library',
targets: {},
tags: ['platform:web'],
tags: ['platform:web', ...tags],
});

return {
Expand Down
20 changes: 15 additions & 5 deletions tools/generators/dependency-mismatch/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import * as semver from 'semver';
import { Tree, formatFiles, updateJson, readJson, readProjectConfiguration } from '@nrwl/devkit';

import { getProjectConfig, getProjects, isPackageVersionConverged, isPackageVersionPrerelease } from '../../utils';
import { getProjectConfig, getProjects, isPackageVersionPrerelease } from '../../utils';
import { PackageJson } from '../../types';

export default async function (tree: Tree) {
Expand All @@ -10,6 +10,12 @@ export default async function (tree: Tree) {
projects.forEach((_project, projectName) => {
const config = getProjectConfig(tree, { packageName: projectName });

const { tags = [] } = readProjectConfiguration(tree, projectName);
// Ignore northstar packages
if (tags.includes('react-northstar')) {
return;
}

updateJson(tree, config.paths.packageJson, (packageJson: PackageJson) => {
if (packageJson.dependencies) {
packageJson.dependencies = getUpdatedDependencies(tree, packageJson.dependencies);
Expand All @@ -19,6 +25,10 @@ export default async function (tree: Tree) {
packageJson.devDependencies = getUpdatedDependencies(tree, packageJson.devDependencies);
}

if (packageJson.peerDependencies) {
packageJson.peerDependencies = getUpdatedDependencies(tree, packageJson.peerDependencies);
}

return packageJson;
});
});
Expand All @@ -38,6 +48,10 @@ function isProjectInWorkspace(tree: Tree, projectName: string) {

function getUpdatedDependencies(tree: Tree, dependencies: Record<string, string>) {
return Object.entries(dependencies).reduce((acc, [dependencyName, versionRange]) => {
if (versionRange === '*') {
return acc;
}

if (!isProjectInWorkspace(tree, dependencyName)) {
return acc;
}
Expand All @@ -48,10 +62,6 @@ function getUpdatedDependencies(tree: Tree, dependencies: Record<string, string>
return acc;
}

if (!isPackageVersionConverged(minVersion.raw)) {
return acc;
}

const shouldHaveCaret = !isPackageVersionPrerelease(minVersion.raw) || versionRange[0] === '^';

const depPackageConfig = getProjectConfig(tree, { packageName: dependencyName });
Expand Down
Loading