@docker-doctor/cli 0.5.3 → 0.6.0

package/README.md

@@ -14,7 +14,7 @@
 
 Your Dockerfiles are probably wrong. Docker Doctor finds out why.
 
-Docker Doctor is an opinionated static analysis tool for Dockerfile and Docker Compose files. It scans your project, runs 31 rules across security, performance, best practices, Compose, and image size — then gives you a health score and fix guidance.
+Docker Doctor is an opinionated static analysis tool for Dockerfile and Docker Compose files. It scans your project, runs 33 rules across security, performance, best practices, Compose, and image size — then gives you a health score and fix guidance.
 
 Works with any project that uses Docker.
 

package/dist/cli.cjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-const require_src = require('./src-D4rVJg36.cjs');
+const require_src = require('./src-BpAv-H0Z.cjs');
 let node_fs_promises = require("node:fs/promises");
 node_fs_promises = require_src.__toESM(node_fs_promises, 1);
 let node_path = require("node:path");
@@ -587,6 +587,10 @@ const writeDiagnosticsDirectory = async (diagnostics, report, rootDir) => {
 			...d,
 			file: sanitizePath(d.file),
 			message: sanitizeMessage(d.message)
+		})),
+		failures: report.failures.map((failure) => ({
+			file: sanitizePath(failure.file),
+			message: sanitizeMessage(failure.message)
 		}))
 	};
 	await node_fs_promises.default.writeFile(node_path.default.join(dir, "diagnostics.json"), JSON.stringify({
@@ -797,13 +801,24 @@ const printDiagnostics = (diagnostics, verbose, fileContents, categoryIssueCount
 			console.log(`  ${cat} › ${chalk.dim(issueLabel)}`);
 		}
 		console.log(`\n  Run ${chalk.cyan("docker-doctor --verbose")} to list every error and warning`);
-		const ruleCounts = {};
-		for (const d of diagnostics) ruleCounts[d.rule] = (ruleCounts[d.rule] || 0) + 1;
-		const migrationRules = Object.entries(ruleCounts).filter(([, count]) => count >= 5);
+		const findingsByRule = /* @__PURE__ */ new Map();
+		for (const d of diagnostics) {
+			const findings = findingsByRule.get(d.rule) ?? {
+				count: 0,
+				files: /* @__PURE__ */ new Set()
+			};
+			findings.count += 1;
+			findings.files.add(d.file);
+			findingsByRule.set(d.rule, findings);
+		}
+		const migrationRules = [...findingsByRule].filter(([, { count }]) => count >= 5);
 		if (migrationRules.length > 0) {
 			console.log();
 			console.log(`  ${chalk.yellow("⚠ Migration-scale change: sample before you sweep")}`);
-			for (const [rule, count] of migrationRules) console.log(`    ${chalk.cyan(rule)} ×${count} across ${count} files`);
+			for (const [rule, { count, files }] of migrationRules) {
+				const fileWord = files.size === 1 ? "file" : "files";
+				console.log(`    ${chalk.cyan(rule)} ×${count} across ${files.size} ${fileWord}`);
+			}
 			console.log(`    Fixing all of them at once is hard to review and prone to`);
 			console.log(`    subtle mistakes across the whole repo. Fix a representative`);
 			console.log(`    few first and confirm the recipe holds. Then get the code`);
@@ -858,7 +873,7 @@ const getWhaleMascot = (score, border) => {
 	];
 };
 const easeOutCubic = (x) => 1 - (1 - x) ** 3;
-const printScoreBox = async (score, label, categoryIssueCounts, warningsCount, errorsCount) => {
+const printScoreBox = async (score, label, warningsCount, errorsCount) => {
 	const { isTTY } = process.stdout;
 	const shouldAnimate = isTTY && !process.env.CI && !process.env.NO_ANIMATION && process.env.TERM !== "dumb" && process.env.NODE_ENV !== "test";
 	let scoreColor = chalk.red.bold;
@@ -932,7 +947,7 @@ const formatTerminal = async (diagnostics, score, label, project, verbose = fals
 		else if (d.severity === "error") errorsCount += 1;
 	}
 	printDiagnostics(diagnostics, verbose, fileContents, categoryIssueCounts);
-	await printScoreBox(score, label, categoryIssueCounts, warningsCount, errorsCount);
+	await printScoreBox(score, label, warningsCount, errorsCount);
 };
 
 //#endregion
@@ -958,11 +973,12 @@ permissions:
   contents: read
   pull-requests: write
   issues: write
+  statuses: write
 jobs:
   docker-doctor:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v7
       - uses: ${options.actionRef}
 `;
 	await node_fs_promises.default.mkdir(workflowDir, { recursive: true });
@@ -1267,6 +1283,31 @@ const reportScanFailures = (failures) => {
 	console.error(`Docker Doctor could not analyze ${failures.length} ${fileWord}; the score below covers only the files that were analyzed.`);
 	for (const failure of failures) console.error(`  - ${failure.file}: ${flattenMessage(failure.message)}`);
 };
+const pathExists = async (filePath) => {
+	try {
+		await node_fs_promises.default.access(filePath);
+		return true;
+	} catch {
+		return false;
+	}
+};
+const resolveConfigPath = async (configOption, rootDir) => {
+	if (!configOption) return;
+	const fromCwd = node_path.default.resolve(process.cwd(), configOption);
+	if (await pathExists(fromCwd)) return fromCwd;
+	const fromRoot = node_path.default.resolve(rootDir, configOption);
+	if (fromRoot !== fromCwd && await pathExists(fromRoot)) {
+		console.error(`Warning: --config ${configOption} was found relative to the scanned directory, not the current directory. Pass a path relative to the current directory or an absolute path.`);
+		return fromRoot;
+	}
+	return fromCwd;
+};
+const findScanTargetProblem = async (rootDir) => {
+	const rootStat = await node_fs_promises.default.stat(rootDir).catch(() => null);
+	if (rootStat === null) return `Directory not found: ${rootDir}`;
+	if (!rootStat.isDirectory()) return `${rootDir} is not a directory. Pass the directory that contains your Dockerfile or Compose file.`;
+	return null;
+};
 const program = new commander.Command();
 program.name("docker-doctor").description("Static analysis for Dockerfile and Docker Compose files").version(require_src.version, "-V, --version", "display the version number");
 program.argument("[dir]", "directory to scan", ".").option("-v, --verbose", "show verbose diagnostics description", false).option("-s, --score", "only output numeric health score", false).option("-j, --json", "output results as JSON report", false).option("-c, --config <path>", "custom config file path").action(async (dir, options) => {
@@ -1285,6 +1326,12 @@ program.argument("[dir]", "directory to scan", ".").option("-v, --verbose", "sho
 	});
 	try {
 		const rootDir = node_path.default.resolve(dir);
+		const scanTargetProblem = await findScanTargetProblem(rootDir);
+		if (scanTargetProblem !== null) {
+			console.error(`Error: ${scanTargetProblem}`);
+			process.exitCode = 1;
+			return;
+		}
 		const startTime = Date.now();
 		let statusText = "Discovering workspace...";
 		const spinnerFrames = [
@@ -1315,11 +1362,17 @@ program.argument("[dir]", "directory to scan", ".").option("-v, --verbose", "sho
 		try {
 			if (process.stdout.isTTY && !isSilent) await (0, node_timers_promises.setTimeout)(150);
 			setStatus("Loading configuration...");
-			const config = await require_src.loadConfig(rootDir, options.config, (message) => {
+			const configPath = await resolveConfigPath(options.config, rootDir);
+			const config = await require_src.loadConfig(rootDir, configPath, (message) => {
 				console.error(`Warning: ${message}`);
 			});
 			setStatus("Scanning workspace files...");
-			const project = await require_src.discoverProject(rootDir, { ignoreFiles: config.ignore?.files });
+			const project = await require_src.discoverProject(rootDir, {
+				ignoreFiles: config.ignore?.files,
+				onSkippedDirectory: (skippedDir) => {
+					console.error(`Warning: skipped unreadable directory ${skippedDir} (permission denied)`);
+				}
+			});
 			const fileContents = {};
 			const projectFilesList = [
 				...project.dockerfiles,
@@ -1344,7 +1397,7 @@ program.argument("[dir]", "directory to scan", ".").option("-v, --verbose", "sho
 				process.exitCode = scanExitCode(scanIncomplete, hasErrors);
 				return;
 			} else if (options.json) {
-				const report = require_src.toJsonReport(diagnostics, score, label, project);
+				const report = require_src.toJsonReport(diagnostics, score, label, project, failures);
 				console.log(JSON.stringify(report, null, 2));
 				process.exitCode = scanExitCode(scanIncomplete, hasErrors);
 				return;
@@ -1353,7 +1406,7 @@ program.argument("[dir]", "directory to scan", ".").option("-v, --verbose", "sho
 			let wizardOk = true;
 			if (process.stdout.isTTY && process.stdin.isTTY) wizardOk = await runInteractiveWizard({
 				diagnostics,
-				report: require_src.toJsonReport(diagnostics, score, label, project),
+				report: require_src.toJsonReport(diagnostics, score, label, project, failures),
 				rootDir
 			});
 			const exitCode = scanExitCode(scanIncomplete, hasErrors);
@@ -1441,7 +1494,7 @@ rules.command("list").description("list all available rules").action(() => {
 	}
 });
 rules.command("explain <rule>").description("explain a specific rule in detail").action((ruleKey) => {
-	const rule = require_src.findRule(ruleKey);
+	const rule = require_src.findRule(ruleKey) ?? require_src.findRule(`docker-doctor/${ruleKey}`);
 	if (!rule) {
 		console.error(`Rule '${ruleKey}' not found.`);
 		process.exitCode = 1;