Add tsup plugin

Author: webpro

README.md

@@ -304,6 +304,7 @@ Knip contains a growing list of plugins:
 - [Stylelint][plugin-stylelint]
 - [Svelte][plugin-svelte]
 - [Tailwind][plugin-tailwind]
+- [tsup][plugin-tsup]
 - [TypeDoc][plugin-typedoc]
 - [TypeScript][plugin-typescript]
 - [Vite][plugin-vite]
@@ -956,6 +957,7 @@ Special thanks to the wonderful people who have contributed to this project:
 [plugin-stylelint]: ./src/plugins/stylelint
 [plugin-svelte]: ./src/plugins/svelte
 [plugin-tailwind]: ./src/plugins/tailwind
+[plugin-tsup]: ./src/plugins/tsup
 [plugin-typedoc]: ./src/plugins/typedoc
 [plugin-typescript]: ./src/plugins/typescript
 [plugin-vite]: ./src/plugins/vite

fixtures/plugins/tsup/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@fixtures/tsup",
+  "version": "*"
+}

schema.json

@@ -384,6 +384,10 @@
           "title": "tailwind plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/tailwind/README.md)",
           "$ref": "#/definitions/plugin"
         },
+        "tsup": {
+          "title": "tsup plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/tsup/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
         "typedoc": {
           "title": "typedoc plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/typedoc/README.md)",
           "$ref": "#/definitions/plugin"

src/ConfigurationValidator.ts

@@ -111,6 +111,7 @@ const pluginsSchema = z.object({
   stryker: pluginSchema,
   stylelint: pluginSchema,
   tailwind: pluginSchema,
+  tsup: pluginSchema,
   typedoc: pluginSchema,
   typescript: pluginSchema,
   vite: pluginSchema,

src/plugins/index.ts

@@ -39,6 +39,7 @@ export * as stryker from './stryker/index.js';
 export * as stylelint from './stylelint/index.js';
 export * as svelte from './svelte/index.js';
 export * as tailwind from './tailwind/index.js';
+export * as tsup from './tsup/index.js';
 export * as typedoc from './typedoc/index.js';
 export * as typescript from './typescript/index.js';
 export * as vite from './vite/index.js';

src/plugins/tsup/README.md

@@ -0,0 +1,22 @@
+# tsup
+
+## Enabled
+
+This plugin is enabled when any of the following package names and/or regular expressions has a match in `dependencies`
+or `devDependencies`:
+
+- `tsup`
+
+## Default configuration
+
+```json
+{
+  "tsup": {
+    "config": ["tsup.config.js"]
+  }
+}
+```
+
+Also see [Knip plugins][1] for more information about plugins.
+
+[1]: https://github.com/webpro/knip/blob/main/README.md#plugins

src/plugins/tsup/index.ts

@@ -0,0 +1,33 @@
+import { timerify } from '../../util/Performance.js';
+import { hasDependency, load } from '../../util/plugin.js';
+import { toEntryPattern } from '../../util/protocols.js';
+import type { TsupConfig } from './types.js';
+import type { IsPluginEnabledCallback, GenericPluginCallback } from '../../types/plugins.js';
+
+// https://paka.dev/npm/tsup/api
+
+export const NAME = 'tsup';
+
+/** @public */
+export const ENABLERS = ['tsup'];
+
+export const isEnabled: IsPluginEnabledCallback = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
+
+export const CONFIG_FILE_PATTERNS = ['tsup.config.js'];
+
+const findTsupDependencies: GenericPluginCallback = async configFilePath => {
+  let localConfig: TsupConfig | undefined = await load(configFilePath);
+  if (typeof localConfig === 'function') localConfig = await localConfig({});
+
+  if (!localConfig) return [];
+
+  const entryPatterns = [localConfig].flat().flatMap(config => {
+    if (!config.entry) return [];
+    if (Array.isArray(config.entry)) return config.entry.map(toEntryPattern);
+    return Object.values(config.entry).map(toEntryPattern);
+  });
+
+  return entryPatterns;
+};
+
+export const findDependencies = timerify(findTsupDependencies);

src/plugins/tsup/types.ts

@@ -0,0 +1,9 @@
+type Entry = string[] | Record<string, string>;
+
+type Options = {
+  entry?: Entry;
+};
+
+type MaybePromise<T> = T | Promise<T>;
+
+export type TsupConfig = Options | Options[] | ((overrideOptions: Options) => MaybePromise<Options | Options[]>);

test/plugins/tsup.test.ts

@@ -0,0 +1,14 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+import * as tsup from '../../src/plugins/tsup/index.js';
+import { resolve, join } from '../../src/util/path.js';
+import { getManifest, pluginConfig as config } from '../helpers/index.js';
+
+const cwd = resolve('fixtures/plugins/tsup');
+const manifest = getManifest(cwd);
+
+test('Find dependencies in tsup configuration (json)', async () => {
+  const configFilePath = join(cwd, 'package.json');
+  const dependencies = await tsup.findDependencies(configFilePath, { manifest, config });
+  assert.deepEqual(dependencies, []);
+});