chore(repo): forbid tracked generated artifacts

This commit is contained in:
James
2026-07-11 01:20:22 -07:00
parent 2aadf450e7
commit 585aa9f6b2
8 changed files with 98 additions and 3 deletions
+48
View File
@@ -0,0 +1,48 @@
import { spawnSync } from "node:child_process";
import { resolve } from "node:path";
import { fileURLToPath } from "node:url";
const FORBIDDEN_BASENAMES = new Set([".DS_Store"]);
export function isForbiddenTrackedPath(filePath) {
const normalized = filePath.replaceAll("\\", "/");
const segments = normalized.split("/");
return segments.includes("node_modules") || FORBIDDEN_BASENAMES.has(segments.at(-1));
}
export function findForbiddenTrackedPaths(filePaths) {
return filePaths.filter(isForbiddenTrackedPath).sort();
}
export function readTrackedPaths(cwd = process.cwd()) {
const result = spawnSync("git", ["ls-files", "-z"], {
cwd,
encoding: "utf8",
maxBuffer: 16 * 1024 * 1024,
});
if (result.error) throw result.error;
if (result.status !== 0) {
throw new Error(result.stderr.trim() || `git ls-files exited with status ${result.status}`);
}
return result.stdout.split("\0").filter(Boolean);
}
export function checkTrackedArtifacts(cwd = process.cwd()) {
return findForbiddenTrackedPaths(readTrackedPaths(cwd));
}
function main() {
const forbidden = checkTrackedArtifacts();
if (forbidden.length === 0) {
console.log("Tracked artifact check passed.");
return;
}
console.error("Forbidden generated artifacts are tracked by Git:");
for (const filePath of forbidden) console.error(`- ${filePath}`);
console.error("Remove these paths from the index; .gitignore already excludes them.");
process.exitCode = 1;
}
const entryPath = process.argv[1] ? resolve(process.argv[1]) : null;
if (entryPath === fileURLToPath(import.meta.url)) main();
+32
View File
@@ -0,0 +1,32 @@
import assert from "node:assert/strict";
import { describe, it } from "node:test";
import { findForbiddenTrackedPaths, isForbiddenTrackedPath } from "./check-tracked-artifacts.mjs";
describe("tracked artifact check", () => {
it("rejects node_modules at any directory depth", () => {
assert.equal(isForbiddenTrackedPath("node_modules/pkg/index.js"), true);
assert.equal(isForbiddenTrackedPath("packages/producer/node_modules/pkg"), true);
assert.equal(isForbiddenTrackedPath("packages\\producer\\node_modules\\pkg"), true);
});
it("rejects platform metadata by basename", () => {
assert.equal(isForbiddenTrackedPath(".DS_Store"), true);
assert.equal(isForbiddenTrackedPath("packages/producer/tests/.DS_Store"), true);
});
it("does not reject similarly named source paths", () => {
assert.equal(isForbiddenTrackedPath("docs/node_modules-policy.md"), false);
assert.equal(isForbiddenTrackedPath("packages/producer/src/DS_Store.ts"), false);
});
it("returns a deterministic sorted list", () => {
assert.deepEqual(
findForbiddenTrackedPaths([
"packages/z/.DS_Store",
"packages/producer/src/index.ts",
"packages/a/node_modules/pkg",
]),
["packages/a/node_modules/pkg", "packages/z/.DS_Store"],
);
});
});