import fs from "node:fs";import path from "node:path"; type FindingLevel = "error" | "warning"; interface Finding { level: FindingLevel; rule: string; path: string; detail: string;} interface AuditStats { directories: number; files: number;} const SRC_DIR = path.resolve(process.cwd(), "src");const MAX_FILES_PER_DIR = Number.parseInt(process.env["MAX_FILES_PER_DIR"] ?? "20", 10);const MAX_SUBDIRS_PER_DIR = Number.parseInt(process.env["MAX_SUBDIRS_PER_DIR"] ?? "8", 10);const STRUCTURE_COUNT_EXCLUDED_DIRS = new Set(["tests"]); const findings: Finding[] = [];const stats: AuditStats = { directories: 0, files: 0,};const modulesRoot = path.join(SRC_DIR, "modules"); const kebabCase = /^[a-z0-9-]+(\.[a-z0-9-]+)*$/; /** Scan a source directory and collect structural findings. */function scanDirectory(dir: string): void { const entries = fs.readdirSync(dir, { withFileTypes: true }); const directFiles = entries.filter((entry) => entry.isFile()); const directDirectories = entries.filter( (entry) => entry.isDirectory() && !entry.name.startsWith(".") && !STRUCTURE_COUNT_EXCLUDED_DIRS.has(entry.name) ); stats.directories += 1; stats.files += directFiles.length; if (directFiles.length > MAX_FILES_PER_DIR) { findings.push({ level: "error", rule: "directory-file-limit", path: dir, detail: `${directFiles.length} files (limit ${MAX_FILES_PER_DIR})`, }); } if (dir !== modulesRoot && directDirectories.length > MAX_SUBDIRS_PER_DIR) { findings.push({ level: "error", rule: "directory-subdir-limit", path: dir, detail: `${directDirectories.length} subdirectories (limit ${MAX_SUBDIRS_PER_DIR})`, }); } for (const entry of entries) { const fullPath = path.join(dir, entry.name); if (entry.name.startsWith(".")) { continue; } if (entry.isDirectory() && !kebabCase.test(entry.name)) { findings.push({ level: "warning", rule: "kebab-case", path: fullPath, detail: `Name "${entry.name}" is not kebab-case`, }); } if (entry.isDirectory()) { scanDirectory(fullPath); } }} function printSummary(): void { const errors = findings.filter((f) => f.level === "error"); const warnings = findings.filter((f) => f.level === "warning"); console.log("=== Controller Standards Audit ==="); console.log(`Directories scanned: ${stats.directories}`); console.log(`Direct file entries scanned: ${stats.files}`); console.log(`Errors: ${errors.length}`); console.log(`Warnings: ${warnings.length}`); console.log(""); const sortedFindings = findings.sort((a, b) => { if (a.level !== b.level) { return a.level === "error" ? -1 : 1; } return a.path.localeCompare(b.path); }); for (const finding of sortedFindings) { const emoji = finding.level === "error" ? "[ERR]" : "[WARN]"; console.log(`${emoji} ${finding.rule} | ${finding.path}`); console.log(` ${finding.detail}`); }} function run(): number { if (!fs.existsSync(SRC_DIR)) { console.error("ERROR: src directory not found"); return 1; } scanDirectory(SRC_DIR); printSummary(); const hasErrors = findings.some((finding) => finding.level === "error"); return hasErrors ? 1 : 0;} process.exit(run());
import fs from "node:fs";
import path from "node:path";
type FindingLevel = "error" | "warning";
interface Finding {
level: FindingLevel;
rule: string;
path: string;
detail: string;
}
interface AuditStats {
directories: number;
files: number;
}
const SRC_DIR = path.resolve(process.cwd(), "src");
const MAX_FILES_PER_DIR = Number.parseInt(process.env["MAX_FILES_PER_DIR"] ?? "20", 10);
const MAX_SUBDIRS_PER_DIR = Number.parseInt(process.env["MAX_SUBDIRS_PER_DIR"] ?? "8", 10);
const STRUCTURE_COUNT_EXCLUDED_DIRS = new Set(["tests"]);
const findings: Finding[] = [];
const stats: AuditStats = {
directories: 0,
files: 0,
};
const modulesRoot = path.join(SRC_DIR, "modules");
const kebabCase = /^[a-z0-9-]+(\.[a-z0-9-]+)*$/;
/** Scan a source directory and collect structural findings. */
function scanDirectory(dir: string): void {
const entries = fs.readdirSync(dir, { withFileTypes: true });
const directFiles = entries.filter((entry) => entry.isFile());
const directDirectories = entries.filter(
(entry) =>
entry.isDirectory() &&
!entry.name.startsWith(".") &&
!STRUCTURE_COUNT_EXCLUDED_DIRS.has(entry.name)
);
stats.directories += 1;
stats.files += directFiles.length;
if (directFiles.length > MAX_FILES_PER_DIR) {
findings.push({
level: "error",
rule: "directory-file-limit",
path: dir,
detail: `${directFiles.length} files (limit ${MAX_FILES_PER_DIR})`,
});
}
if (dir !== modulesRoot && directDirectories.length > MAX_SUBDIRS_PER_DIR) {
findings.push({
level: "error",
rule: "directory-subdir-limit",
path: dir,
detail: `${directDirectories.length} subdirectories (limit ${MAX_SUBDIRS_PER_DIR})`,
});
}
for (const entry of entries) {
const fullPath = path.join(dir, entry.name);
if (entry.name.startsWith(".")) {
continue;
}
if (entry.isDirectory() && !kebabCase.test(entry.name)) {
findings.push({
level: "warning",
rule: "kebab-case",
path: fullPath,
detail: `Name "${entry.name}" is not kebab-case`,
});
}
if (entry.isDirectory()) {
scanDirectory(fullPath);
}
}
}
function printSummary(): void {
const errors = findings.filter((f) => f.level === "error");
const warnings = findings.filter((f) => f.level === "warning");
console.log("=== Controller Standards Audit ===");
console.log(`Directories scanned: ${stats.directories}`);
console.log(`Direct file entries scanned: ${stats.files}`);
console.log(`Errors: ${errors.length}`);
console.log(`Warnings: ${warnings.length}`);
console.log("");
const sortedFindings = findings.sort((a, b) => {
if (a.level !== b.level) {
return a.level === "error" ? -1 : 1;
}
return a.path.localeCompare(b.path);
});
for (const finding of sortedFindings) {
const emoji = finding.level === "error" ? "[ERR]" : "[WARN]";
console.log(`${emoji} ${finding.rule} | ${finding.path}`);
console.log(` ${finding.detail}`);
}
}
function run(): number {
if (!fs.existsSync(SRC_DIR)) {
console.error("ERROR: src directory not found");
return 1;
}
scanDirectory(SRC_DIR);
printSummary();
const hasErrors = findings.some((finding) => finding.level === "error");
return hasErrors ? 1 : 0;
}
process.exit(run());