mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 08:10:44 +00:00
ci: guard unused dead-code files
This commit is contained in:
144
scripts/check-deadcode-unused-files.mjs
Normal file
144
scripts/check-deadcode-unused-files.mjs
Normal file
@@ -0,0 +1,144 @@
|
||||
#!/usr/bin/env node
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { KNIP_UNUSED_FILE_ALLOWLIST } from "./deadcode-unused-files.allowlist.mjs";
|
||||
|
||||
const KNIP_VERSION = "6.8.0";
|
||||
const KNIP_ARGS = [
|
||||
"--config",
|
||||
"knip.config.ts",
|
||||
"--production",
|
||||
"--no-progress",
|
||||
"--reporter",
|
||||
"compact",
|
||||
"--files",
|
||||
"--no-config-hints",
|
||||
];
|
||||
|
||||
function normalizeRepoPath(value) {
|
||||
return value.replaceAll("\\", "/").replace(/^\.\//u, "");
|
||||
}
|
||||
|
||||
function uniqueSorted(values) {
|
||||
return [...new Set(values.map(normalizeRepoPath))].toSorted((left, right) =>
|
||||
left.localeCompare(right),
|
||||
);
|
||||
}
|
||||
|
||||
export function parseKnipCompactUnusedFiles(output) {
|
||||
const files = [];
|
||||
let inUnusedFilesSection = false;
|
||||
let sawUnusedFilesSection = false;
|
||||
|
||||
for (const line of output.split(/\r?\n/u)) {
|
||||
if (/^Unused files \(\d+\)$/u.test(line)) {
|
||||
inUnusedFilesSection = true;
|
||||
sawUnusedFilesSection = true;
|
||||
continue;
|
||||
}
|
||||
if (inUnusedFilesSection && line.trim() === "") {
|
||||
break;
|
||||
}
|
||||
|
||||
const separatorIndex = line.lastIndexOf(": ");
|
||||
if (separatorIndex === -1) {
|
||||
continue;
|
||||
}
|
||||
if (sawUnusedFilesSection && !inUnusedFilesSection) {
|
||||
continue;
|
||||
}
|
||||
files.push(line.slice(separatorIndex + 2).trim());
|
||||
}
|
||||
|
||||
return uniqueSorted(files);
|
||||
}
|
||||
|
||||
export function compareUnusedFilesToAllowlist(actualFiles, allowlistFiles) {
|
||||
const actual = uniqueSorted(actualFiles);
|
||||
const allowed = uniqueSorted(allowlistFiles);
|
||||
const allowedSet = new Set(allowed);
|
||||
const actualSet = new Set(actual);
|
||||
|
||||
return {
|
||||
actual,
|
||||
allowed,
|
||||
unexpected: actual.filter((file) => !allowedSet.has(file)),
|
||||
stale: allowed.filter((file) => !actualSet.has(file)),
|
||||
duplicateAllowedCount: allowlistFiles.length - new Set(allowlistFiles).size,
|
||||
allowlistIsSorted:
|
||||
JSON.stringify(allowlistFiles.map(normalizeRepoPath)) === JSON.stringify(allowed),
|
||||
};
|
||||
}
|
||||
|
||||
export function formatUnusedFileComparison(comparison) {
|
||||
const lines = [];
|
||||
if (!comparison.allowlistIsSorted) {
|
||||
lines.push("deadcode unused-file allowlist is not sorted.");
|
||||
}
|
||||
if (comparison.duplicateAllowedCount > 0) {
|
||||
lines.push(
|
||||
`deadcode unused-file allowlist contains ${comparison.duplicateAllowedCount} duplicate entr${
|
||||
comparison.duplicateAllowedCount === 1 ? "y" : "ies"
|
||||
}.`,
|
||||
);
|
||||
}
|
||||
if (comparison.unexpected.length > 0) {
|
||||
lines.push("Unexpected unused files:");
|
||||
lines.push(...comparison.unexpected.map((file) => ` ${file}`));
|
||||
}
|
||||
if (comparison.stale.length > 0) {
|
||||
lines.push("Stale allowlist entries:");
|
||||
lines.push(...comparison.stale.map((file) => ` ${file}`));
|
||||
}
|
||||
return lines.join("\n");
|
||||
}
|
||||
|
||||
export function runKnipUnusedFiles() {
|
||||
const result = spawnSync(
|
||||
"pnpm",
|
||||
["--config.minimum-release-age=0", "dlx", `knip@${KNIP_VERSION}`, ...KNIP_ARGS],
|
||||
{
|
||||
encoding: "utf8",
|
||||
stdio: ["ignore", "pipe", "pipe"],
|
||||
},
|
||||
);
|
||||
return {
|
||||
status: result.status,
|
||||
signal: result.signal,
|
||||
output: `${result.stdout ?? ""}${result.stderr ?? ""}`,
|
||||
};
|
||||
}
|
||||
|
||||
export function checkUnusedFiles(output, allowlistFiles = KNIP_UNUSED_FILE_ALLOWLIST) {
|
||||
const actual = parseKnipCompactUnusedFiles(output);
|
||||
const comparison = compareUnusedFilesToAllowlist(actual, allowlistFiles);
|
||||
return {
|
||||
ok:
|
||||
comparison.allowlistIsSorted &&
|
||||
comparison.duplicateAllowedCount === 0 &&
|
||||
comparison.unexpected.length === 0 &&
|
||||
comparison.stale.length === 0,
|
||||
comparison,
|
||||
message: formatUnusedFileComparison(comparison),
|
||||
};
|
||||
}
|
||||
|
||||
function main() {
|
||||
const result = runKnipUnusedFiles();
|
||||
const check = checkUnusedFiles(result.output);
|
||||
if (!check.ok) {
|
||||
if (check.message) {
|
||||
console.error(check.message);
|
||||
}
|
||||
process.exitCode = 1;
|
||||
return;
|
||||
}
|
||||
|
||||
console.log(
|
||||
`[deadcode] Knip unused-file allowlist matched ${check.comparison.actual.length} intentional entries.`,
|
||||
);
|
||||
}
|
||||
|
||||
if (process.argv[1] === fileURLToPath(import.meta.url)) {
|
||||
main();
|
||||
}
|
||||
77
scripts/deadcode-unused-files.allowlist.mjs
Normal file
77
scripts/deadcode-unused-files.allowlist.mjs
Normal file
@@ -0,0 +1,77 @@
|
||||
// Intentional Knip unused-file findings. These are dynamic entrypoints,
|
||||
// generated/build inputs, manifest-discovered plugin surfaces, live-test
|
||||
// helpers, or package bridge files that static production scanning cannot see.
|
||||
export const KNIP_UNUSED_FILE_ALLOWLIST = [
|
||||
"extensions/diffs/src/viewer-client.ts",
|
||||
"extensions/diffs/src/viewer-payload.ts",
|
||||
"extensions/mattermost/src/config-schema.ts",
|
||||
"extensions/memory-core/src/memory-tool-manager-mock.ts",
|
||||
"src/agents/subagent-registry.runtime.ts",
|
||||
"src/auto-reply/inbound.group-require-mention-test-plugins.ts",
|
||||
"src/auto-reply/reply/get-reply.test-loader.ts",
|
||||
"src/cli/daemon-cli-compat.ts",
|
||||
"src/cli/debug-timing.ts",
|
||||
"src/commands/doctor/shared/deprecation-compat.ts",
|
||||
"src/config/doc-baseline.runtime.ts",
|
||||
"src/config/doc-baseline.ts",
|
||||
"src/gateway/gateway-cli-backend.live-helpers.ts",
|
||||
"src/gateway/gateway-cli-backend.live-probe-helpers.ts",
|
||||
"src/gateway/gateway-codex-harness.live-helpers.ts",
|
||||
"src/infra/changelog-unreleased.ts",
|
||||
"src/mcp/openclaw-tools-serve.ts",
|
||||
"src/mcp/plugin-tools-handlers.ts",
|
||||
"src/mcp/plugin-tools-serve.ts",
|
||||
"src/mcp/tools-stdio-server.ts",
|
||||
"src/memory-host-sdk/engine-embeddings.ts",
|
||||
"src/memory-host-sdk/engine-foundation.ts",
|
||||
"src/memory-host-sdk/engine.ts",
|
||||
"src/memory-host-sdk/host/batch-error-utils.ts",
|
||||
"src/memory-host-sdk/host/batch-http.ts",
|
||||
"src/memory-host-sdk/host/batch-output.ts",
|
||||
"src/memory-host-sdk/host/batch-provider-common.ts",
|
||||
"src/memory-host-sdk/host/batch-runner.ts",
|
||||
"src/memory-host-sdk/host/batch-status.ts",
|
||||
"src/memory-host-sdk/host/batch-upload.ts",
|
||||
"src/memory-host-sdk/host/batch-utils.ts",
|
||||
"src/memory-host-sdk/host/embedding-chunk-limits.ts",
|
||||
"src/memory-host-sdk/host/embedding-input-limits.ts",
|
||||
"src/memory-host-sdk/host/embedding-model-limits.ts",
|
||||
"src/memory-host-sdk/host/embedding-provider-adapter-utils.ts",
|
||||
"src/memory-host-sdk/host/embedding-vectors.ts",
|
||||
"src/memory-host-sdk/host/embeddings-debug.ts",
|
||||
"src/memory-host-sdk/host/embeddings-model-normalize.ts",
|
||||
"src/memory-host-sdk/host/embeddings-remote-client.ts",
|
||||
"src/memory-host-sdk/host/embeddings-remote-fetch.ts",
|
||||
"src/memory-host-sdk/host/embeddings-remote-provider.ts",
|
||||
"src/memory-host-sdk/host/embeddings.ts",
|
||||
"src/memory-host-sdk/host/embeddings.types.ts",
|
||||
"src/memory-host-sdk/host/fs-utils.ts",
|
||||
"src/memory-host-sdk/host/hash.ts",
|
||||
"src/memory-host-sdk/host/internal.ts",
|
||||
"src/memory-host-sdk/host/memory-schema.ts",
|
||||
"src/memory-host-sdk/host/multimodal.ts",
|
||||
"src/memory-host-sdk/host/node-llama.ts",
|
||||
"src/memory-host-sdk/host/post-json.ts",
|
||||
"src/memory-host-sdk/host/qmd-process.ts",
|
||||
"src/memory-host-sdk/host/qmd-query-parser.ts",
|
||||
"src/memory-host-sdk/host/qmd-scope.ts",
|
||||
"src/memory-host-sdk/host/query-expansion.ts",
|
||||
"src/memory-host-sdk/host/read-file-shared.ts",
|
||||
"src/memory-host-sdk/host/read-file.ts",
|
||||
"src/memory-host-sdk/host/remote-http.ts",
|
||||
"src/memory-host-sdk/host/secret-input.ts",
|
||||
"src/memory-host-sdk/host/session-files.ts",
|
||||
"src/memory-host-sdk/host/sqlite-vec.ts",
|
||||
"src/memory-host-sdk/host/sqlite.ts",
|
||||
"src/memory-host-sdk/host/status-format.ts",
|
||||
"src/memory-host-sdk/runtime-cli.ts",
|
||||
"src/memory-host-sdk/runtime-core.ts",
|
||||
"src/memory-host-sdk/runtime-files.ts",
|
||||
"src/memory-host-sdk/runtime.ts",
|
||||
"src/plugins/build-smoke-entry.ts",
|
||||
"src/plugins/contracts/host-hook-fixture.ts",
|
||||
"src/plugins/contracts/rootdir-boundary-canary.ts",
|
||||
"src/plugins/contracts/tts-contract-suites.ts",
|
||||
"src/plugins/runtime-sidecar-paths-baseline.ts",
|
||||
"src/tasks/task-registry-control.runtime.ts",
|
||||
];
|
||||
@@ -230,6 +230,11 @@ const TOOLING_SOURCE_TEST_TARGETS = new Map([
|
||||
["scripts/github/barnacle-auto-response.mjs", ["test/scripts/barnacle-auto-response.test.ts"]],
|
||||
["scripts/changed-lanes.mjs", ["test/scripts/changed-lanes.test.ts"]],
|
||||
["scripts/check-changed.mjs", ["test/scripts/changed-lanes.test.ts"]],
|
||||
["scripts/check-deadcode-unused-files.mjs", ["test/scripts/check-deadcode-unused-files.test.ts"]],
|
||||
[
|
||||
"scripts/deadcode-unused-files.allowlist.mjs",
|
||||
["test/scripts/check-deadcode-unused-files.test.ts"],
|
||||
],
|
||||
["scripts/lib/live-docker-stage.sh", ["test/scripts/live-docker-stage.test.ts"]],
|
||||
["scripts/lib/openclaw-test-state.mjs", ["test/scripts/openclaw-test-state.test.ts"]],
|
||||
["scripts/lib/vitest-local-scheduling.mjs", ["test/scripts/vitest-local-scheduling.test.ts"]],
|
||||
@@ -274,6 +279,10 @@ const TOOLING_SOURCE_TEST_TARGETS = new Map([
|
||||
const TOOLING_TEST_TARGETS = new Map([
|
||||
["test/scripts/barnacle-auto-response.test.ts", ["test/scripts/barnacle-auto-response.test.ts"]],
|
||||
["test/scripts/changed-lanes.test.ts", ["test/scripts/changed-lanes.test.ts"]],
|
||||
[
|
||||
"test/scripts/check-deadcode-unused-files.test.ts",
|
||||
["test/scripts/check-deadcode-unused-files.test.ts"],
|
||||
],
|
||||
["test/scripts/live-docker-stage.test.ts", ["test/scripts/live-docker-stage.test.ts"]],
|
||||
["test/scripts/openclaw-test-state.test.ts", ["test/scripts/openclaw-test-state.test.ts"]],
|
||||
[
|
||||
|
||||
Reference in New Issue
Block a user