feat: support nx crystal for nx plugin (#496)

* feat: support nx crystal for nx plugin

* chore: fix lint

* fix: make target defaults only rely on scopped plugins

* tests: added an extra test case

* chore: fix typo

* Update packages/knip/fixtures/plugins/nx-crystal/package.json

Co-authored-by: Lars Kappert <lars@webpro.nl>

---------

Co-authored-by: Lars Kappert <lars@webpro.nl>

Author: beaussan

packages/knip/fixtures/plugins/nx-crystal/nx.json

@@ -0,0 +1,75 @@
+{
+  "plugins": [
+    {
+      "plugin": "@nx/webpack/plugin",
+      "options": {
+        "buildTargetName": "build",
+        "serveTargetName": "serve",
+        "previewTargetName": "preview"
+      }
+    },
+    {
+      "plugin": "@nx/eslint/plugin",
+      "options": {
+        "targetName": "lint"
+      }
+    },
+    {
+      "plugin": "@nx/playwright/plugin",
+      "options": {
+        "targetName": "e2e"
+      }
+    },
+    {
+      "plugin": "@nx/jest/plugin",
+      "options": {
+        "targetName": "test"
+      }
+    },
+    {
+      "plugin": "@nx/vite/plugin",
+      "options": {
+        "buildTargetName": "build",
+        "previewTargetName": "preview",
+        "testTargetName": "test",
+        "serveTargetName": "serve",
+        "serveStaticTargetName": "serve-static"
+      }
+    }
+  ],
+  "generators": {
+    "@nx/react": {
+      "application": {
+        "babel": true,
+        "style": "css",
+        "linter": "eslint",
+        "bundler": "webpack"
+      },
+      "component": {
+        "style": "css"
+      },
+      "library": {
+        "style": "css",
+        "linter": "eslint",
+        "unitTestRunner": "vitest"
+      }
+    }
+  },
+  "targetDefaults": {
+    "@nx/rollup:rollup": {
+      "cache": true,
+      "dependsOn": ["^build"],
+      "inputs": ["production", "^production"]
+    },
+    "my-custom-thing": {
+      "cache": true,
+      "dependsOn": ["^my-custom-thing"],
+      "inputs": ["production", "^production"]
+    },
+    "test:custom-thing": {
+      "cache": true,
+      "dependsOn": ["^my-custom-thing"],
+      "inputs": ["production", "^production"]
+    }
+  }
+}

packages/knip/fixtures/plugins/nx-crystal/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@fixtures/nx-crystal",
+  "scripts": {
+    "nx": "nx"
+  },
+  "devDependencies": {
+    "@nx/webpack": "*",
+    "@nx/eslint": "*",
+    "@nx/playwright": "*",
+    "@nx/jest": "*",
+    "@nx/vite": "*",
+    "@nx/cypress": "*",
+    "@nx/react": "*",
+    "@nx/rollup": "*",
+    "@nrwl/workspace": "*"
+  }
+}

packages/knip/src/plugins/nx/index.ts

@@ -1,7 +1,8 @@
 import { compact } from '../../util/array.js';
+import { getPackageNameFromModuleSpecifier } from '../../util/modules.js';
 import { timerify } from '../../util/Performance.js';
 import { getDependenciesFromScripts, hasDependency, load } from '../../util/plugin.js';
-import type { NxProjectConfiguration } from './types.js';
+import type { NxConfigRoot, NxProjectConfiguration } from './types.js';
 import type { IsPluginEnabledCallback, GenericPluginCallback } from '../../types/plugins.js';
 
 const NAME = 'Nx';
@@ -10,13 +11,44 @@ const ENABLERS = ['nx', /^@nrwl\//, /^@nx\//];
 
 const isEnabled: IsPluginEnabledCallback = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
 
-const CONFIG_FILE_PATTERNS = ['project.json', '{apps,libs}/**/project.json'];
+const CONFIG_FILE_PATTERNS = ['nx.json', 'project.json', '{apps,libs}/**/project.json'];
+
+const findNxDependenciesInNxJson: GenericPluginCallback = async configFilePath => {
+  const localConfig: NxConfigRoot | undefined = await load(configFilePath);
+
+  if (!localConfig) return [];
+
+  const targetsDefault = localConfig.targetDefaults
+    ? Object.keys(localConfig.targetDefaults)
+        // Ensure we only grab executors from plugins instead of manual targets
+        // Limiting to scoped packages to ensure we don't have false positives
+        .filter(it => it.includes(':') && it.startsWith('@'))
+        .map(it => it.split(':')[0])
+    : [];
+
+  const plugins =
+    localConfig.plugins && Array.isArray(localConfig.plugins)
+      ? localConfig.plugins.map(it => getPackageNameFromModuleSpecifier(it.plugin)).filter(value => value !== undefined)
+      : [];
+
+  const generators = localConfig.generators
+    ? Object.keys(localConfig.generators)
+        .map(it => getPackageNameFromModuleSpecifier(it))
+        .filter(value => value !== undefined)
+    : [];
+
+  return compact([...targetsDefault, ...plugins, ...generators]);
+};
 
 const findNxDependencies: GenericPluginCallback = async (configFilePath, options) => {
   const { isProduction } = options;
 
   if (isProduction) return [];
 
+  if (configFilePath.endsWith('nx.json')) {
+    return findNxDependenciesInNxJson(configFilePath, options);
+  }
+
   const localConfig: NxProjectConfiguration | undefined = await load(configFilePath);
 
   if (!localConfig) return [];

packages/knip/src/plugins/nx/types.ts

@@ -9,3 +9,11 @@ export interface NxProjectConfiguration {
     };
   };
 }
+
+export interface NxConfigRoot {
+  plugins?: Array<{
+    plugin: string;
+  }>
+  generators?: Record<string, unknown>;
+  targetDefaults?: Record<string, unknown>;
+}

packages/knip/test/plugins/nx-crystal.test.ts

@@ -0,0 +1,22 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+import { default as nx } from '../../src/plugins/nx/index.js';
+import { resolve, join } from '../../src/util/path.js';
+import { buildOptions } from '../helpers/index.js';
+
+const cwd = resolve('fixtures/plugins/nx-crystal');
+const options = buildOptions(cwd);
+
+test('Find dependencies in Nx configuration nx.json', async () => {
+  const configFilePath = join(cwd, 'nx.json');
+  const dependencies = await nx.findDependencies(configFilePath, options);
+  assert.deepEqual(dependencies, [
+    '@nx/rollup',
+    '@nx/webpack',
+    '@nx/eslint',
+    '@nx/playwright',
+    '@nx/jest',
+    '@nx/vite',
+    '@nx/react',
+  ]);
+});