fix(js): ignore dependencies from non-index root files for create-pac…

…kage-json (#17930) (cherry picked from commit 28a071f)
nrwl · Jul 7, 2023 · ed22afe · ed22afe
1 parent a496ef9
commit ed22afe
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 18 deletions.
diff --git a/packages/eslint-plugin/src/rules/dependency-checks.ts b/packages/eslint-plugin/src/rules/dependency-checks.ts
@@ -9,6 +9,7 @@ import { satisfies } from 'semver';
 import { getHelperDependenciesFromProjectGraph } from '@nx/js';
 import {
   getAllDependencies,
+  getPackageJson,
   removePackageJsonFromFileMap,
 } from '../utils/package-json-utils';
 import { JSONLiteral } from 'jsonc-eslint-parser/lib/parser/ast';
@@ -126,13 +127,17 @@ export default createESLintRule<Options, MessageIds>({
       projectGraph
     );
 
+    const rootPackageJson = getPackageJson(join(workspaceRoot, 'package.json'));
+
     // find all dependencies for the project
     const npmDeps = findProjectsNpmDependencies(
       sourceProject,
       projectGraph,
       buildTarget,
+      rootPackageJson,
       {
         helperDependencies: helperDependencies.map((dep) => dep.target),
+        isProduction: true,
       },
       removePackageJsonFromFileMap(projectFileMap)
     );
@@ -148,12 +153,12 @@ export default createESLintRule<Options, MessageIds>({
       'package.json'
     );
 
-    globalThis.projPackageJsonDeps ??= getAllDependencies(projPackageJsonPath);
+    globalThis.projPackageJsonDeps ??= getAllDependencies(
+      getPackageJson(projPackageJsonPath)
+    );
     const projPackageJsonDeps: Record<string, string> =
       globalThis.projPackageJsonDeps;
-    const rootPackageJsonDeps = getAllDependencies(
-      join(workspaceRoot, 'package.json')
-    );
+    const rootPackageJsonDeps = getAllDependencies(rootPackageJson);
 
     function validateMissingDependencies(node: AST.JSONProperty) {
       if (!checkMissingDependencies) {

diff --git a/packages/eslint-plugin/src/utils/package-json-utils.ts b/packages/eslint-plugin/src/utils/package-json-utils.ts
@@ -1,16 +1,22 @@
 import { ProjectFileMap, readJsonFile } from '@nx/devkit';
 import { existsSync } from 'fs';
+import { PackageJson } from 'nx/src/utils/package-json';
 
-export function getAllDependencies(path: string): Record<string, string> {
+export function getAllDependencies(
+  packageJson: PackageJson
+): Record<string, string> {
+  return {
+    ...packageJson.dependencies,
+    ...packageJson.devDependencies,
+    ...packageJson.peerDependencies,
+  };
+}
+
+export function getPackageJson(path: string): PackageJson {
   if (existsSync(path)) {
-    const packageJson = readJsonFile(path);
-    return {
-      ...packageJson.dependencies,
-      ...packageJson.devDependencies,
-      ...packageJson.peerDependencies,
-    };
+    return readJsonFile(path);
   }
-  return {};
+  return {} as PackageJson;
 }
 
 export function removePackageJsonFromFileMap(

diff --git a/packages/js/src/utils/package-json/update-package-json.spec.ts b/packages/js/src/utils/package-json/update-package-json.spec.ts
@@ -290,7 +290,7 @@ describe('updatePackageJson', () => {
   const fileMap = {
     '@org/lib1': [
       {
-        file: 'test.ts',
+        file: 'libs/lib1/src/test.ts',
         hash: '',
         deps: ['npm:external1', 'npm:external2'],
       },

diff --git a/packages/nx/src/plugins/js/package-json/create-package-json.ts b/packages/nx/src/plugins/js/package-json/create-package-json.ts
@@ -43,11 +43,19 @@ export function createPackageJson(
   const projectNode = graph.nodes[projectName];
   const isLibrary = projectNode.type === 'lib';
 
+  const rootPackageJson = readJsonFile(
+    `${options.root || workspaceRoot}/package.json`
+  );
+
   const npmDeps = findProjectsNpmDependencies(
     projectNode,
     graph,
     options.target,
-    { helperDependencies: options.helperDependencies },
+    rootPackageJson,
+    {
+      helperDependencies: options.helperDependencies,
+      isProduction: options.isProduction,
+    },
     fileMap
   );
 
@@ -92,9 +100,6 @@ export function createPackageJson(
     );
   };
 
-  const rootPackageJson = readJsonFile(
-    `${options.root || workspaceRoot}/package.json`
-  );
   Object.entries(npmDeps.dependencies).forEach(([packageName, version]) => {
     if (
       rootPackageJson.devDependencies?.[packageName] &&
@@ -179,9 +184,11 @@ export function findProjectsNpmDependencies(
   projectNode: ProjectGraphProjectNode,
   graph: ProjectGraph,
   target: string,
+  rootPackageJson: PackageJson,
   options: {
     helperDependencies?: string[];
     ignoredDependencies?: string[];
+    isProduction?: boolean;
   },
   fileMap?: ProjectFileMap
 ): NpmDeps {
@@ -208,13 +215,22 @@ export function findProjectsNpmDependencies(
     recursivelyCollectPeerDependencies(dep, graph, npmDeps, seen);
   });
 
+  // if it's production, we want to ignore all found devDependencies
+  const ignoredDependencies =
+    options.isProduction && rootPackageJson.devDependencies
+      ? [
+          ...(options.ignoredDependencies || []),
+          ...Object.keys(rootPackageJson.devDependencies),
+        ]
+      : options.ignoredDependencies || [];
+
   findAllNpmDeps(
     fileMap,
     projectNode,
     graph,
     npmDeps,
     seen,
-    options.ignoredDependencies || [],
+    ignoredDependencies,
     dependencyInputs,
     selfInputs
   );