Skip to content

Commit

Permalink
fix(core): prevent peer deps from ending up as dev deps in create pac…
Browse files Browse the repository at this point in the history
…kage json (#13502)
  • Loading branch information
meeroslav committed Dec 1, 2022
1 parent ea8f004 commit 1a3cc51
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 27 deletions.
6 changes: 3 additions & 3 deletions e2e/next/src/next.test.ts
Expand Up @@ -242,11 +242,11 @@ describe('Next.js Applications', () => {
if (found) throw new Error('Found SVGR plugin');
console.log('NODE_ENV is', process.env.NODE_ENV);
return config;
}
};
module.exports = withNx(nextConfig);
`
);
Expand All @@ -265,7 +265,7 @@ describe('Next.js Applications', () => {
const { withNx } = require('@nrwl/next/plugins/with-nx');
// Not including "nx" entry should still work.
const nextConfig = {};
module.exports = withNx(nextConfig);
`
);
Expand Down
2 changes: 1 addition & 1 deletion e2e/node/src/node.test.ts
Expand Up @@ -229,7 +229,7 @@ describe('Build Node apps', () => {

afterEach(() => cleanupProject());

it('should generate a package.json with the `--generatePackageJson` flag MMM', async () => {
it('should generate a package.json with the `--generatePackageJson` flag', async () => {
const scope = newProject();
const nestapp = uniq('nestapp');
runCLI(`generate @nrwl/nest:app ${nestapp} --linter=eslint`);
Expand Down
Expand Up @@ -27,6 +27,7 @@ export async function createPackageJson(

const typescriptNode = context.projectGraph.externalNodes['npm:typescript'];
if (typescriptNode) {
packageJson.dependencies = packageJson.dependencies || {};
packageJson.dependencies['typescript'] = typescriptNode.data.version;
}

Expand Down
68 changes: 45 additions & 23 deletions packages/nx/src/utils/create-package-json.ts
@@ -1,8 +1,9 @@
import { readJsonFile } from './fileutils';
import { sortObjectByKeys } from 'nx/src/utils/object-sort';
import { sortObjectByKeys } from './object-sort';
import { ProjectGraph } from '../config/project-graph';
import { PackageJson } from './package-json';
import { existsSync } from 'fs';
import { workspaceRoot } from './workspace-root';

/**
* Creates a package.json in the output directory for support to install dependencies within containers.
Expand All @@ -18,61 +19,77 @@ export function createPackageJson(
): PackageJson {
const npmDeps = findAllNpmDeps(projectName, graph);
// default package.json if one does not exist
let packageJson = {
let packageJson: PackageJson = {
name: projectName,
version: '0.0.1',
dependencies: {},
devDependencies: {},
};
if (existsSync(`${graph.nodes[projectName].data.root}/package.json`)) {
try {
packageJson = readJsonFile(
`${graph.nodes[projectName].data.root}/package.json`
);
if (!packageJson.dependencies) {
packageJson.dependencies = {};
}
if (!packageJson.devDependencies) {
packageJson.devDependencies = {};
}
} catch (e) {}
}

const rootPackageJson = readJsonFile(`${options.root || '.'}/package.json`);
Object.entries(npmDeps).forEach(([packageName, version]) => {
const rootPackageJson = readJsonFile(
`${options.root || workspaceRoot}/package.json`
);
Object.entries(npmDeps.dependencies).forEach(([packageName, version]) => {
if (
rootPackageJson.devDependencies?.[packageName] &&
!packageJson.dependencies[packageName]
!packageJson.dependencies?.[packageName] &&
!packageJson.peerDependencies?.[packageName]
) {
packageJson.devDependencies = packageJson.devDependencies || {};
packageJson.devDependencies[packageName] = version;
} else {
if (!packageJson.peerDependencies?.[packageName]) {
packageJson.dependencies = packageJson.dependencies || {};
packageJson.dependencies[packageName] = version;
}
}
});
Object.entries(npmDeps.peerDependencies).forEach(([packageName, version]) => {
if (!packageJson.peerDependencies?.[packageName]) {
packageJson.dependencies[packageName] = version;
}
});

packageJson.devDependencies &&= sortObjectByKeys(packageJson.devDependencies);
packageJson.dependencies &&= sortObjectByKeys(packageJson.dependencies);
packageJson.peerDependencies &&= sortObjectByKeys(
packageJson.peerDependencies
);

return packageJson;
}

function findAllNpmDeps(
projectName: string,
graph: ProjectGraph,
list: { [packageName: string]: string } = {},
list: {
dependencies: Record<string, string>;
peerDependencies: Record<string, string>;
} = { dependencies: {}, peerDependencies: {} },
seen = new Set<string>()
) {
const node = graph.externalNodes[projectName];

if (seen.has(projectName)) {
// if it's in peerDependencies, move it to regular dependencies
// since this is a direct dependency of the project
if (node && list.peerDependencies[node.data.packageName]) {
list.dependencies[node.data.packageName] = node.data.version;
delete list.peerDependencies[node.data.packageName];
}
return list;
}

seen.add(projectName);

const node = graph.externalNodes[projectName];

if (node) {
list[node.data.packageName] = node.data.version;
recursivelyCollectPeerDependencies(node.name, graph, list);
list.dependencies[node.data.packageName] = node.data.version;
recursivelyCollectPeerDependencies(node.name, graph, list, seen);
} else {
// we are not interested in the dependencies of external projects
graph.dependencies[projectName]?.forEach((dep) => {
Expand All @@ -88,15 +105,17 @@ function findAllNpmDeps(
function recursivelyCollectPeerDependencies(
projectName: string,
graph: ProjectGraph,
list: { [packageName: string]: string } = {},
list: {
dependencies: Record<string, string>;
peerDependencies: Record<string, string>;
},
seen = new Set<string>()
) {
const npmPackage = graph.externalNodes[projectName];
if (!npmPackage || seen.has(projectName)) {
if (!npmPackage) {
return list;
}

seen.add(projectName);
const packageName = npmPackage.data.packageName;
try {
const packageJson = require(`${packageName}/package.json`);
Expand All @@ -110,9 +129,12 @@ function recursivelyCollectPeerDependencies(
.filter(Boolean)
.forEach((node) => {
if (
!packageJson.peerDependenciesMeta?.[node.data.packageName]?.optional
!packageJson.peerDependenciesMeta?.[node.data.packageName]
?.optional &&
!seen.has(node.name)
) {
list[node.data.packageName] = node.data.version;
seen.add(node.name);
list.peerDependencies[node.data.packageName] = node.data.version;
recursivelyCollectPeerDependencies(node.name, graph, list, seen);
}
});
Expand Down

1 comment on commit 1a3cc51

@vercel
Copy link

@vercel vercel bot commented on 1a3cc51 Dec 1, 2022

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-git-master-nrwl.vercel.app
nx-five.vercel.app
nx-dev-nrwl.vercel.app
nx.dev

Please sign in to comment.