Add @sveltejs/package plugin (resolve #1690)

webpro · webpro · commit 8b2d402c9fff · 2026-04-21T09:19:44.000+02:00
diff --git a/packages/knip/fixtures/plugins/sveltejs-package/node_modules/@sveltejs/package/package.json b/packages/knip/fixtures/plugins/sveltejs-package/node_modules/@sveltejs/package/package.json
diff --git a/packages/knip/fixtures/plugins/sveltejs-package/package.json b/packages/knip/fixtures/plugins/sveltejs-package/package.json
@@ -0,0 +1,16 @@
+{
+  "name": "@fixtures/sveltejs-package",
+  "type": "module",
+  "exports": {
+    ".": { "svelte": "./dist/index.js" },
+    "./lib/*": { "svelte": "./dist/*.js" },
+    "./ui/*": { "svelte": "./dist/ui/*/index.js" }
+  },
+  "scripts": {
+    "build": "svelte-package"
+  },
+  "devDependencies": {
+    "@sveltejs/package": "*",
+    "typescript": "*"
+  }
+}
diff --git a/packages/knip/fixtures/plugins/sveltejs-package/src/lib/auth.ts b/packages/knip/fixtures/plugins/sveltejs-package/src/lib/auth.ts
@@ -0,0 +1 @@
+export const signIn = () => 'signed-in';
diff --git a/packages/knip/fixtures/plugins/sveltejs-package/src/lib/index.ts b/packages/knip/fixtures/plugins/sveltejs-package/src/lib/index.ts
@@ -0,0 +1 @@
+export { signIn } from './auth.ts';
diff --git a/packages/knip/fixtures/plugins/sveltejs-package/src/lib/session.ts b/packages/knip/fixtures/plugins/sveltejs-package/src/lib/session.ts
@@ -0,0 +1 @@
+export const session = () => 'session';
diff --git a/packages/knip/fixtures/plugins/sveltejs-package/src/lib/ui/button/button.ts b/packages/knip/fixtures/plugins/sveltejs-package/src/lib/ui/button/button.ts
@@ -0,0 +1,2 @@
+const Button = { name: 'Button' };
+export default Button;
diff --git a/packages/knip/fixtures/plugins/sveltejs-package/src/lib/ui/button/index.ts b/packages/knip/fixtures/plugins/sveltejs-package/src/lib/ui/button/index.ts
@@ -0,0 +1 @@
+export { default as Button } from './button.ts';
diff --git a/packages/knip/fixtures/plugins/sveltejs-package/src/tools/dev-only.ts b/packages/knip/fixtures/plugins/sveltejs-package/src/tools/dev-only.ts
@@ -0,0 +1 @@
+export const unused = () => 'unused';
diff --git a/packages/knip/fixtures/plugins/sveltejs-package/tsconfig.json b/packages/knip/fixtures/plugins/sveltejs-package/tsconfig.json
@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "strict": true
+  },
+  "include": ["src/**/*"]
+}
diff --git a/packages/knip/fixtures/plugins/sveltejs-package2/node_modules/@sveltejs/package/package.json b/packages/knip/fixtures/plugins/sveltejs-package2/node_modules/@sveltejs/package/package.json
diff --git a/packages/knip/fixtures/plugins/sveltejs-package2/package.json b/packages/knip/fixtures/plugins/sveltejs-package2/package.json
@@ -0,0 +1,11 @@
+{
+  "name": "@fixtures/sveltejs-package2",
+  "type": "module",
+  "main": "./build/index.js",
+  "scripts": {
+    "build": "svelte-package -i src/components -o build"
+  },
+  "devDependencies": {
+    "@sveltejs/package": "*"
+  }
+}
diff --git a/packages/knip/fixtures/plugins/sveltejs-package2/src/components/index.ts b/packages/knip/fixtures/plugins/sveltejs-package2/src/components/index.ts
@@ -0,0 +1 @@
+export const root = () => 'root';
diff --git a/packages/knip/fixtures/plugins/sveltejs-package2/src/orphan.ts b/packages/knip/fixtures/plugins/sveltejs-package2/src/orphan.ts
@@ -0,0 +1 @@
+export const orphan = () => 'orphan';
diff --git a/packages/knip/fixtures/plugins/sveltejs-package2/tsconfig.json b/packages/knip/fixtures/plugins/sveltejs-package2/tsconfig.json
@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "strict": true
+  },
+  "include": ["src/**/*"]
+}
diff --git a/packages/knip/src/plugins/index.ts b/packages/knip/src/plugins/index.ts
@@ -115,6 +115,7 @@ import { default as storybook } from './storybook/index.ts';
 import { default as stryker } from './stryker/index.ts';
 import { default as stylelint } from './stylelint/index.ts';
 import { default as svelte } from './svelte/index.ts';
+import { default as sveltejsPackage } from './sveltejs-package/index.ts';
 import { default as sveltekit } from './sveltekit/index.ts';
 import { default as svgo } from './svgo/index.ts';
 import { default as svgr } from './svgr/index.ts';
@@ -264,6 +265,7 @@ export const Plugins = {
   stryker,
   stylelint,
   svelte,
+  'sveltejs-package': sveltejsPackage,
   sveltekit,
   svgo,
   svgr,
diff --git a/packages/knip/src/plugins/sveltejs-package/helpers.ts b/packages/knip/src/plugins/sveltejs-package/helpers.ts
@@ -0,0 +1,68 @@
+import parseArgs from 'minimist';
+import { type Node, parse, type Statement } from 'unbash';
+
+const BIN = 'svelte-package';
+export const DEFAULT_INPUT = 'src/lib';
+export const DEFAULT_OUTPUT = 'dist';
+
+interface IO {
+  input: string;
+  output: string;
+}
+
+const parseCommandIO = (args: string[]): IO => {
+  const parsed = parseArgs(args, { string: ['i', 'o', 'input', 'output'], alias: { input: ['i'], output: ['o'] } });
+  return { input: parsed.input ?? DEFAULT_INPUT, output: parsed.output ?? DEFAULT_OUTPUT };
+};
+
+const collectFromCommands = (statements: Statement[], out: IO[]) => {
+  for (const stmt of statements) visit(stmt.command, out);
+};
+
+const visit = (node: Node, out: IO[]) => {
+  switch (node.type) {
+    case 'Command':
+      if (node.name?.value === BIN) out.push(parseCommandIO(node.suffix.map(w => w.value)));
+      return;
+    case 'AndOr':
+    case 'Pipeline':
+      for (const n of node.commands) visit(n, out);
+      return;
+    case 'If':
+      collectFromCommands(node.clause.commands, out);
+      collectFromCommands(node.then.commands, out);
+      if (node.else) visit(node.else, out);
+      return;
+    case 'While':
+      collectFromCommands(node.clause.commands, out);
+      collectFromCommands(node.body.commands, out);
+      return;
+    case 'For':
+    case 'Select':
+    case 'Subshell':
+    case 'BraceGroup':
+      collectFromCommands(node.body.commands, out);
+      return;
+    case 'CompoundList':
+      collectFromCommands(node.commands, out);
+      return;
+    case 'Function':
+    case 'Coproc':
+      visit(node.body, out);
+      return;
+    case 'Statement':
+      visit(node.command, out);
+  }
+};
+
+export const parseScripts = (scripts: Record<string, string | undefined> | undefined): IO[] => {
+  const out: IO[] = [];
+  for (const script of Object.values(scripts ?? {})) {
+    if (typeof script !== 'string' || !script.includes(BIN)) continue;
+    try {
+      const parsed = parse(script);
+      if (parsed.commands) collectFromCommands(parsed.commands, out);
+    } catch {}
+  }
+  return out;
+};
diff --git a/packages/knip/src/plugins/sveltejs-package/index.ts b/packages/knip/src/plugins/sveltejs-package/index.ts
@@ -0,0 +1,35 @@
+import type { IsPluginEnabled, Plugin, ResolveSourceMap, SourceMap } from '../../types/config.ts';
+import { join } from '../../util/path.ts';
+import { hasDependency } from '../../util/plugin.ts';
+import { DEFAULT_INPUT, DEFAULT_OUTPUT, parseScripts } from './helpers.ts';
+
+// https://svelte.dev/docs/kit/packaging
+
+const title = '@sveltejs/package';
+
+const enablers = ['@sveltejs/package'];
+
+const isEnabled: IsPluginEnabled = ({ dependencies }) => hasDependency(dependencies, enablers);
+
+const resolveSourceMap: ResolveSourceMap = ({ cwd, manifest }) => {
+  const ios = parseScripts(manifest.scripts);
+  const effective = ios.length > 0 ? ios : [{ input: DEFAULT_INPUT, output: DEFAULT_OUTPUT }];
+  const seen = new Set<string>();
+  const pairs: SourceMap[] = [];
+  for (const { input, output } of effective) {
+    const key = `${input}→${output}`;
+    if (seen.has(key)) continue;
+    seen.add(key);
+    pairs.push({ srcDir: join(cwd, input), outDir: join(cwd, output) });
+  }
+  return pairs;
+};
+
+const plugin: Plugin = {
+  title,
+  enablers,
+  isEnabled,
+  resolveSourceMap,
+};
+
+export default plugin;
diff --git a/packages/knip/src/schema/plugins.ts b/packages/knip/src/schema/plugins.ts
@@ -129,6 +129,7 @@ export const pluginsSchema = z.object({
   stryker: pluginSchema,
   stylelint: pluginSchema,
   svelte: pluginSchema,
+  'sveltejs-package': pluginSchema,
   sveltekit: pluginSchema,
   svgo: pluginSchema,
   svgr: pluginSchema,
diff --git a/packages/knip/src/types/PluginNames.ts b/packages/knip/src/types/PluginNames.ts
@@ -116,6 +116,7 @@ export type PluginName =
   | 'stryker'
   | 'stylelint'
   | 'svelte'
+  | 'sveltejs-package'
   | 'sveltekit'
   | 'svgo'
   | 'svgr'
@@ -265,6 +266,7 @@ export const pluginNames = [
   'stryker',
   'stylelint',
   'svelte',
+  'sveltejs-package',
   'sveltekit',
   'svgo',
   'svgr',
diff --git a/packages/knip/test/plugins/sveltejs-package.test.ts b/packages/knip/test/plugins/sveltejs-package.test.ts
@@ -0,0 +1,43 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+import { main } from '../../src/index.ts';
+import baseCounters from '../helpers/baseCounters.ts';
+import { createOptions } from '../helpers/create-options.ts';
+import { resolve } from '../helpers/resolve.ts';
+
+const cwd = resolve('fixtures/plugins/sveltejs-package');
+
+test('Find dependencies with the @sveltejs/package plugin (defaults)', async () => {
+  const options = await createOptions({ cwd });
+  const { issues, counters } = await main(options);
+
+  assert('src/tools/dev-only.ts' in issues.files);
+  assert(!('src/lib/auth.ts' in issues.files));
+  assert(!('src/lib/session.ts' in issues.files));
+  assert(!('src/lib/index.ts' in issues.files));
+  assert(!('src/lib/ui/button/index.ts' in issues.files));
+  assert(!('src/lib/ui/button/button.ts' in issues.files));
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    files: 1,
+    processed: 6,
+    total: 6,
+  });
+});
+
+test('Find dependencies with the @sveltejs/package plugin (custom -i/-o)', async () => {
+  const cwd2 = resolve('fixtures/plugins/sveltejs-package2');
+  const options = await createOptions({ cwd: cwd2 });
+  const { issues, counters } = await main(options);
+
+  assert('src/orphan.ts' in issues.files);
+  assert(!('src/components/index.ts' in issues.files));
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    files: 1,
+    processed: 2,
+    total: 2,
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export const signIn = () => 'signed-in';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export const session = () => 'session';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+const Button = { name: 'Button' };`
	`2`	`+export default Button;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export { default as Button } from './button.ts';`