feat: add dependency-cruiser plugin (#911)

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

Author: filipw01

packages/knip/fixtures/plugins/dependency-cruiser/.dependency-cruiser.js

@@ -0,0 +1 @@
+module.exports = {}

packages/knip/fixtures/plugins/dependency-cruiser/baseline.config.js

@@ -0,0 +1 @@
+module.exports = {}

packages/knip/fixtures/plugins/dependency-cruiser/custom-depcruise-config.js

@@ -0,0 +1 @@
+module.exports = {}

packages/knip/fixtures/plugins/dependency-cruiser/dependency-cruise.config.js

@@ -0,0 +1 @@
+module.exports = {}

packages/knip/fixtures/plugins/dependency-cruiser/node_modules/dependency-cruiser/index.js

@@ -0,0 +1,13 @@
+{
+  "name": "@fixtures/dependency-cruiser",
+  "version": "*",
+  "devDependencies": {
+    "dependency-cruiser": "*"
+  },
+  "scripts": {
+    "test": "dependency-cruiser",
+    "test:custom": "depcruise --config custom-depcruise-config.js",
+    "test:baseline": "depcruise-baseline -c baseline.config.js",
+    "test:dependency-cruise": "dependency-cruise -c dependency-cruise.config.js"
+  }
+} 

packages/knip/fixtures/plugins/dependency-cruiser/node_modules/dependency-cruiser/package.json

@@ -328,6 +328,10 @@
           "title": "Cypress plugin configuration (https://knip.dev/reference/plugins/cypress)",
           "$ref": "#/definitions/plugin"
         },
+        "dependency-cruiser": {
+          "title": "dependency-cruiser plugin configuration (https://knip.dev/reference/plugins/dependency-cruiser)",
+          "$ref": "#/definitions/plugin"
+        },
         "dotenv": {
           "title": "dotenv plugin configuration (https://knip.dev/reference/plugins/dotenv)",
           "$ref": "#/definitions/plugin"

packages/knip/fixtures/plugins/dependency-cruiser/package.json

@@ -0,0 +1,25 @@
+import type { IsPluginEnabled, Plugin } from '../../types/config.js';
+import { hasDependency } from '../../util/plugin.js';
+
+// https://github.com/sverweij/dependency-cruiser
+
+const title = 'dependency-cruiser';
+
+const enablers = ['dependency-cruiser'];
+
+const isEnabled: IsPluginEnabled = ({ dependencies }) => hasDependency(dependencies, enablers);
+
+const config = ['.dependency-cruiser.{js,cjs,mjs,json}'];
+
+const args = {
+  binaries: ['depcruise', 'dependency-cruise', 'dependency-cruiser', 'depcruise-baseline'],
+  config: true,
+};
+
+export default {
+  title,
+  enablers,
+  isEnabled,
+  config,
+  args,
+} satisfies Plugin;

packages/knip/schema.json

@@ -11,6 +11,7 @@ import { default as commitlint } from './commitlint/index.js';
 import { default as cspell } from './cspell/index.js';
 import { default as cucumber } from './cucumber/index.js';
 import { default as cypress } from './cypress/index.js';
+import { default as dependencyCruiser } from './dependency-cruiser/index.js';
 import { default as dotenv } from './dotenv/index.js';
 import { default as drizzle } from './drizzle/index.js';
 import { default as eleventy } from './eleventy/index.js';
@@ -103,6 +104,7 @@ export const Plugins = {
   cspell,
   cucumber,
   cypress,
+  'dependency-cruiser': dependencyCruiser,
   dotenv,
   drizzle,
   eleventy,

packages/knip/src/plugins/dependency-cruiser/index.ts

@@ -25,6 +25,7 @@ export const pluginsSchema = z.object({
   cspell: pluginSchema,
   cucumber: pluginSchema,
   cypress: pluginSchema,
+  'dependency-cruiser': pluginSchema,
   dotenv: pluginSchema,
   drizzle: pluginSchema,
   eleventy: pluginSchema,

packages/knip/src/plugins/index.ts

@@ -12,6 +12,7 @@ export type PluginName =
   | 'cspell'
   | 'cucumber'
   | 'cypress'
+  | 'dependency-cruiser'
   | 'dotenv'
   | 'drizzle'
   | 'eleventy'
@@ -104,6 +105,7 @@ export const pluginNames = [
   'cspell',
   'cucumber',
   'cypress',
+  'dependency-cruiser',
   'dotenv',
   'drizzle',
   'eleventy',

packages/knip/src/schema/plugins.ts

@@ -0,0 +1,21 @@
+import { test } from 'bun:test';
+import assert from 'node:assert/strict';
+import { main } from '../../src/index.js';
+import { resolve } from '../../src/util/path.js';
+import baseArguments from '../helpers/baseArguments.js';
+import baseCounters from '../helpers/baseCounters.js';
+
+const cwd = resolve('fixtures/plugins/dependency-cruiser');
+
+test('Find dependencies with the dependency-cruiser plugin', async () => {
+  const { counters } = await main({
+    ...baseArguments,
+    cwd,
+  });
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    processed: 4,
+    total: 4,
+  });
+});