feat: node-modules-inspector plugin (#1215)

Author: lishaduck

packages/knip/fixtures/plugins/node-modules-inspector/.nmrc.js

@@ -0,0 +1,7 @@
+import { defineConfig } from 'node-modules-inspector';
+
+export default defineConfig({
+  defaultSettings: {
+    moduleTypeSimple: true,
+  },
+});

packages/knip/fixtures/plugins/node-modules-inspector/node-modules-inspector.config.ts

@@ -0,0 +1,6 @@
+import { defineConfig } from 'node-modules-inspector';
+
+export default defineConfig({
+  // Experimental publint.dev integration
+  publint: true,
+});

packages/knip/fixtures/plugins/node-modules-inspector/node_modules/node-modules-inspector/index.js

@@ -0,0 +1,10 @@
+{
+  "name": "@plugins/node-modules-inspector",
+  "dependencies": {
+    "node-modules-inspector": "*"
+  },
+  "scripts": {
+    "build": "node-modules-inspector build",
+    "build-3": "node-modules-inspector --config .nmrc.js"
+  }
+}

packages/knip/fixtures/plugins/node-modules-inspector/node_modules/node-modules-inspector/package.json

@@ -499,6 +499,10 @@
           "title": "node plugin configuration (https://knip.dev/reference/plugins/node)",
           "$ref": "#/definitions/plugin"
         },
+        "node-modules-inspector": {
+          "title": "node-modules-inspector plugin configuration (https://knip.dev/reference/plugins/node-modules-inspector)",
+          "$ref": "#/definitions/plugin"
+        },
         "node-test-runner": {
           "title": "node-test-runner plugin configuration (https://knip.dev/reference/plugins/node-test-runner)",
           "$ref": "#/definitions/plugin"

packages/knip/fixtures/plugins/node-modules-inspector/package.json

@@ -49,6 +49,7 @@ import { default as nanoStaged } from './nano-staged/index.js';
 import { default as nest } from './nest/index.js';
 import { default as netlify } from './netlify/index.js';
 import { default as next } from './next/index.js';
+import { default as nodeModulesInspector } from './node-modules-inspector/index.js';
 import { default as node } from './node/index.js';
 import { default as nodemon } from './nodemon/index.js';
 import { default as npmPackageJsonLint } from './npm-package-json-lint/index.js';
@@ -162,6 +163,7 @@ export const Plugins = {
   netlify,
   next,
   node,
+  'node-modules-inspector': nodeModulesInspector,
   nodemon,
   'npm-package-json-lint': npmPackageJsonLint,
   nuxt,

packages/knip/schema.json

@@ -0,0 +1,26 @@
+import type { IsPluginEnabled, Plugin } from '../../types/config.js';
+import { toUnconfig } from '../../util/plugin-config.js';
+import { hasDependency } from '../../util/plugin.js';
+
+// https://github.com/antfu/node-modules-inspector
+
+const title = 'node-modules-inspector';
+
+const enablers = ['node-modules-inspector'];
+
+const isEnabled: IsPluginEnabled = ({ dependencies }) => hasDependency(dependencies, enablers);
+
+const config: string[] = [...toUnconfig('node-modules-inspector.config')];
+
+const args = {
+  binaries: ['node-modules-inspector'],
+  config: true,
+};
+
+export default {
+  title,
+  enablers,
+  isEnabled,
+  config,
+  args,
+} satisfies Plugin;

packages/knip/src/plugins/index.ts

@@ -64,6 +64,7 @@ export const pluginsSchema = z.object({
   netlify: pluginSchema,
   next: pluginSchema,
   node: pluginSchema,
+  'node-modules-inspector': pluginSchema,
   nodemon: pluginSchema,
   'npm-package-json-lint': pluginSchema,
   nuxt: pluginSchema,

packages/knip/src/plugins/node-modules-inspector/index.ts

@@ -51,6 +51,7 @@ export type PluginName =
   | 'netlify'
   | 'next'
   | 'node'
+  | 'node-modules-inspector'
   | 'nodemon'
   | 'npm-package-json-lint'
   | 'nuxt'
@@ -163,6 +164,7 @@ export const pluginNames = [
   'netlify',
   'next',
   'node',
+  'node-modules-inspector',
   'nodemon',
   'npm-package-json-lint',
   'nuxt',