feat(core): add lockfile pruning to executors that generate package.j…

…son (#13734)

docs/generated/packages/node.json

@@ -457,7 +457,7 @@
           },
           "generatePackageJson": {
             "type": "boolean",
-            "description": "Generates a `package.json` file with the project's `node_module` dependencies populated for installing in a container. If a `package.json` exists in the project's directory, it will be reused with dependencies populated.",
+            "description": "Generates a `package.json` and pruned lock file with the project's `node_module` dependencies populated for installing in a container. If a `package.json` exists in the project's directory, it will be reused with dependencies populated.",
             "default": false
           },
           "transformers": {

docs/generated/packages/webpack.json

@@ -425,7 +425,7 @@
           },
           "generatePackageJson": {
             "type": "boolean",
-            "description": "Generates a `package.json` file with the project's `node_module` dependencies populated for installing in a container. If a `package.json` exists in the project's directory, it will be reused with dependencies populated.",
+            "description": "Generates a `package.json` and pruned lock file with the project's `node_module` dependencies populated for installing in a container. If a `package.json` exists in the project's directory, it will be reused with dependencies populated.",
             "default": false
           },
           "transformers": {

e2e/next/src/next.test.ts

@@ -1,6 +1,7 @@
 import {
   checkFilesExist,
   cleanupProject,
+  detectPackageManager,
   isNotWindows,
   killPorts,
   newProject,
@@ -11,12 +12,14 @@ import {
   runCLIAsync,
   runCommandUntil,
   runCypressTests,
+  tmpProjPath,
   uniq,
   updateFile,
   updateProjectConfig,
 } from '@nrwl/e2e/utils';
 import { stringUtils } from '@nrwl/workspace';
 import * as http from 'http';
+import { getLockFileName } from 'nx/src/lock-file/lock-file';
 
 describe('Next.js Applications', () => {
   let proj: string;
@@ -447,6 +450,12 @@ async function checkApp(
   expect(packageJson.dependencies['react-dom']).toBeDefined();
   expect(packageJson.dependencies.next).toBeDefined();
 
+  checkFilesExist(
+    `dist/apps/${appName}/${getLockFileName(
+      detectPackageManager(tmpProjPath())
+    )}`
+  );
+
   if (opts.checkLint) {
     const lintResults = runCLI(`lint ${appName}`);
     expect(lintResults).toContain('All files pass linting.');

e2e/node/src/node.test.ts

@@ -4,6 +4,7 @@ import {
   checkFilesExist,
   cleanupProject,
   createFile,
+  detectPackageManager,
   expectJestTestsToPass,
   killPorts,
   newProject,
@@ -20,6 +21,7 @@ import {
 } from '@nrwl/e2e/utils';
 import { exec, execSync } from 'child_process';
 import * as http from 'http';
+import { getLockFileName } from 'nx/src/lock-file/lock-file';
 import { satisfies } from 'semver';
 
 function getData(port, path = '/api'): Promise<any> {
@@ -237,6 +239,11 @@ describe('Build Node apps', () => {
     await runCLIAsync(`build ${nestapp} --generatePackageJson`);
 
     checkFilesExist(`dist/apps/${nestapp}/package.json`);
+    checkFilesExist(
+      `dist/apps/${nestapp}/${getLockFileName(
+        detectPackageManager(tmpProjPath())
+      )}`
+    );
     const packageJson = JSON.parse(
       readFile(`dist/apps/${nestapp}/package.json`)
     );

e2e/utils/index.ts

@@ -7,13 +7,7 @@ import {
   workspaceRoot,
 } from '@nrwl/devkit';
 import { angularCliVersion } from '@nrwl/workspace/src/utils/versions';
-import {
-  ChildProcess,
-  exec,
-  ExecOptions,
-  execSync,
-  ExecSyncOptions,
-} from 'child_process';
+import { ChildProcess, exec, execSync, ExecSyncOptions } from 'child_process';
 import {
   copySync,
   createFileSync,

packages/next/src/executors/build/lib/create-package-json.ts

@@ -1,5 +1,10 @@
 import type { ExecutorContext } from '@nrwl/devkit';
 import { writeJsonFile } from '@nrwl/devkit';
+import { writeFileSync } from 'fs';
+import {
+  getLockFileName,
+  pruneLockFileFromPackageJson,
+} from 'nx/src/lock-file/lock-file';
 import { createPackageJson as generatePackageJson } from 'nx/src/utils/create-package-json';
 import type { NextBuildBuilderOptions } from '../../../utils/types';
 
@@ -32,4 +37,14 @@ export async function createPackageJson(
   }
 
   writeJsonFile(`${options.outputPath}/package.json`, packageJson);
+
+  // generate lock file
+  const prunedLockFile = pruneLockFileFromPackageJson(
+    packageJson,
+    !options.includeDevDependenciesInPackageJson
+  );
+  const lockFileName = getLockFileName();
+  writeFileSync(`${options.outputPath}/${lockFileName}`, prunedLockFile, {
+    encoding: 'utf-8',
+  });
 }

packages/node/src/executors/webpack/schema.json

@@ -178,7 +178,7 @@
     },
     "generatePackageJson": {
       "type": "boolean",
-      "description": "Generates a `package.json` file with the project's `node_module` dependencies populated for installing in a container. If a `package.json` exists in the project's directory, it will be reused with dependencies populated.",
+      "description": "Generates a `package.json` and pruned lock file with the project's `node_module` dependencies populated for installing in a container. If a `package.json` exists in the project's directory, it will be reused with dependencies populated.",
       "default": false
     },
     "transformers": {

packages/nx/src/lock-file/lock-file.ts

@@ -31,10 +31,15 @@ import { existsSync } from 'fs';
 import { createProjectGraphAsync } from '../project-graph/project-graph';
 import { createPackageJson } from '../utils/create-package-json';
 import { normalizePackageJson } from './utils/pruning';
+import { PackageJson } from '../utils/package-json';
 
-const YARN_LOCK_PATH = join(workspaceRoot, 'yarn.lock');
-const NPM_LOCK_PATH = join(workspaceRoot, 'package-lock.json');
-const PNPM_LOCK_PATH = join(workspaceRoot, 'pnpm-lock.yaml');
+const YARN_LOCK_FILE = 'yarn.lock';
+const NPM_LOCK_FILE = 'package-lock.json';
+const PNPM_LOCK_FILE = 'pnpm-lock.yaml';
+
+const YARN_LOCK_PATH = join(workspaceRoot, YARN_LOCK_FILE);
+const NPM_LOCK_PATH = join(workspaceRoot, NPM_LOCK_FILE);
+const PNPM_LOCK_PATH = join(workspaceRoot, PNPM_LOCK_FILE);
 
 /**
  * Check if lock file exists
@@ -161,6 +166,21 @@ export function writeLockFile(
   throw Error(`Unknown package manager: ${packageManager}`);
 }
 
+export function getLockFileName(
+  packageManager: PackageManager = detectPackageManager(workspaceRoot)
+): string {
+  if (packageManager === 'yarn') {
+    return YARN_LOCK_FILE;
+  }
+  if (packageManager === 'pnpm') {
+    return PNPM_LOCK_FILE;
+  }
+  if (packageManager === 'npm') {
+    return NPM_LOCK_FILE;
+  }
+  throw Error(`Unknown package manager: ${packageManager}`);
+}
+
 /**
  * Prune lock file based on the given project's dependencies and overrides in local package.json
  *
@@ -174,20 +194,35 @@ export async function pruneLockFile(
   isProduction = true,
   packageManager: PackageManager = detectPackageManager(workspaceRoot)
 ): Promise<string> {
-  const lockFileData = parseLockFile(packageManager);
   const projectGraph = await createProjectGraphAsync();
 
   if (!projectGraph.nodes[projectName]) {
     throw Error(`Project "${projectName}" was not found.`);
   }
 
   const packageJson = createPackageJson(projectName, projectGraph, {});
-  // cleanup irrelevant fields from the generated package.json
-  const normalizedPackageJson = normalizePackageJson(
+  return pruneLockFileFromPackageJson(
     packageJson,
     isProduction,
-    projectName
+    packageManager
   );
+}
+
+/**
+ * Prune lock file based on the package.json
+ *
+ * @param packageJson
+ * @param isProduction
+ * @param packageManager
+ * @returns
+ */
+export function pruneLockFileFromPackageJson(
+  packageJson: PackageJson,
+  isProduction = true,
+  packageManager: PackageManager = detectPackageManager(workspaceRoot)
+): string {
+  const lockFileData = parseLockFile(packageManager);
+  const normalizedPackageJson = normalizePackageJson(packageJson, isProduction);
 
   if (packageManager === 'yarn') {
     const prunedData = pruneYarnLockFile(lockFileData, normalizedPackageJson);

packages/nx/src/lock-file/utils/pruning.ts

@@ -23,11 +23,10 @@ export type PackageJsonDeps = Pick<
  */
 export function normalizePackageJson(
   packageJson: PackageJson,
-  isProduction: boolean,
-  projectName: string
+  isProduction: boolean
 ): PackageJsonDeps {
   const normalized: PackageJsonDeps = {
-    name: packageJson.name || projectName,
+    name: packageJson.name,
     version: packageJson.version || '0.0.0',
     ...(packageJson.license && { license: packageJson.license }),
   };

packages/webpack/src/executors/webpack/schema.json

@@ -180,7 +180,7 @@
     },
     "generatePackageJson": {
       "type": "boolean",
-      "description": "Generates a `package.json` file with the project's `node_module` dependencies populated for installing in a container. If a `package.json` exists in the project's directory, it will be reused with dependencies populated.",
+      "description": "Generates a `package.json` and pruned lock file with the project's `node_module` dependencies populated for installing in a container. If a `package.json` exists in the project's directory, it will be reused with dependencies populated.",
       "default": false
     },
     "transformers": {

packages/webpack/src/utils/generate-package-json-webpack-plugin.ts

@@ -1,7 +1,6 @@
 import { type Compiler, sources, type WebpackPluginInstance } from 'webpack';
 import {
   ExecutorContext,
-  ProjectConfiguration,
   type ProjectGraph,
   serializeJson,
 } from '@nrwl/devkit';
@@ -13,6 +12,10 @@ import {
 import { readTsConfig } from '@nrwl/workspace/src/utilities/typescript';
 
 import { NormalizedWebpackExecutorOptions } from '../executors/webpack/schema';
+import {
+  getLockFileName,
+  pruneLockFileFromPackageJson,
+} from 'nx/src/lock-file/lock-file';
 
 export class GeneratePackageJsonWebpackPlugin implements WebpackPluginInstance {
   private readonly projectGraph: ProjectGraph;
@@ -76,6 +79,10 @@ export class GeneratePackageJsonWebpackPlugin implements WebpackPluginInstance {
             'package.json',
             new sources.RawSource(serializeJson(packageJson))
           );
+          compilation.emitAsset(
+            getLockFileName(),
+            new sources.RawSource(pruneLockFileFromPackageJson(packageJson))
+          );
         }
       );
     });