deep-slop 1.4.1

package/dist/config-lint-ph3vMUbg.js

@@ -0,0 +1,371 @@
+import { r as readFileContent } from "./file-utils-B_HFXhCs.js";
+import { basename, join } from "node:path";
+import { readdir, stat } from "node:fs/promises";
+
+//#region src/engines/config-lint/index.ts
+/** Create a config-lint diagnostic */
+function diag(overrides) {
+	return {
+		engine: "config-lint",
+		category: "config",
+		line: 1,
+		column: 1,
+		fixable: false,
+		help: "",
+		...overrides
+	};
+}
+/** Try to read and parse a JSON file; returns undefined if missing or invalid */
+async function readJsonFile(filePath) {
+	try {
+		const content = await readFileContent(filePath);
+		return JSON.parse(content);
+	} catch {
+		return;
+	}
+}
+/** Check whether a file exists */
+async function fileExists(filePath) {
+	try {
+		return (await stat(filePath)).isFile();
+	} catch {
+		return false;
+	}
+}
+/** Find the first file matching a set of candidate names in a directory */
+async function findFile(dir, candidates) {
+	for (const name of candidates) {
+		const fullPath = join(dir, name);
+		if (await fileExists(fullPath)) return fullPath;
+	}
+}
+/** Find all files matching a glob-like prefix pattern (e.g. ".eslintrc.*") */
+async function findFilesWithPrefix(dir, prefix) {
+	try {
+		return (await readdir(dir)).filter((e) => e.startsWith(prefix)).map((e) => join(dir, e));
+	} catch {
+		return [];
+	}
+}
+/** Find files matching a glob-like suffix pattern (e.g. "eslint.config.*") */
+async function findFilesWithName(dir, name) {
+	try {
+		return (await readdir(dir)).filter((e) => e === name || e.startsWith(name + ".")).map((e) => join(dir, e));
+	} catch {
+		return [];
+	}
+}
+async function checkTsconfigStrict(root) {
+	const diagnostics = [];
+	const tsconfigPath = await findFile(root, ["tsconfig.json"]);
+	if (!tsconfigPath) return diagnostics;
+	const tsconfig = await readJsonFile(tsconfigPath);
+	if (!tsconfig) return diagnostics;
+	const co = tsconfig.compilerOptions ?? {};
+	const relPath = "tsconfig.json";
+	if (co.strict !== true) diagnostics.push(diag({
+		filePath: relPath,
+		rule: "config-lint/tsconfig-strict",
+		severity: "info",
+		message: `compilerOptions.strict is not enabled (current: ${JSON.stringify(co.strict) ?? "unset"})`,
+		help: "Set \"strict\": true in compilerOptions to enable all strict type-checking options.",
+		detail: {
+			key: "strict",
+			current: co.strict ?? null,
+			recommended: true
+		}
+	}));
+	if (co.strict !== true) {
+		for (const { key, label } of [
+			{
+				key: "noImplicitAny",
+				label: "noImplicitAny"
+			},
+			{
+				key: "strictNullChecks",
+				label: "strictNullChecks"
+			},
+			{
+				key: "noUncheckedIndexedAccess",
+				label: "noUncheckedIndexedAccess"
+			}
+		]) if (co[key] !== true) diagnostics.push(diag({
+			filePath: relPath,
+			rule: "config-lint/tsconfig-strict",
+			severity: "info",
+			message: `compilerOptions.${label} is not enabled`,
+			help: `Set "${label}": true in compilerOptions to catch more type errors at compile time.`,
+			detail: {
+				key,
+				current: co[key] ?? null,
+				recommended: true
+			}
+		}));
+	}
+	return diagnostics;
+}
+const MODERN_TARGETS = new Set([
+	"es2022",
+	"es2023",
+	"esnext",
+	"es2024",
+	"es2025"
+]);
+const OLD_TARGETS = new Set([
+	"es3",
+	"es5",
+	"es6",
+	"es2015",
+	"es2016",
+	"es2017",
+	"es2018",
+	"es2019",
+	"es2020",
+	"es2021"
+]);
+async function checkTsconfigTarget(root) {
+	const diagnostics = [];
+	const tsconfigPath = await findFile(root, ["tsconfig.json"]);
+	if (!tsconfigPath) return diagnostics;
+	const tsconfig = await readJsonFile(tsconfigPath);
+	if (!tsconfig) return diagnostics;
+	const target = (tsconfig.compilerOptions?.target)?.toLowerCase();
+	const relPath = "tsconfig.json";
+	if (!target) diagnostics.push(diag({
+		filePath: relPath,
+		rule: "config-lint/tsconfig-target",
+		severity: "info",
+		message: "compilerOptions.target is not set (defaults to ES3)",
+		help: "Set \"target\": \"ES2022\" or later in compilerOptions for modern JavaScript output.",
+		detail: {
+			key: "target",
+			current: null,
+			recommended: "ES2022"
+		}
+	}));
+	else if (OLD_TARGETS.has(target)) diagnostics.push(diag({
+		filePath: relPath,
+		rule: "config-lint/tsconfig-target",
+		severity: "info",
+		message: `compilerOptions.target is set to "${target}", which is outdated`,
+		help: `Upgrade "target" to "ES2022" or later for modern JavaScript features and better optimization.`,
+		detail: {
+			key: "target",
+			current: target,
+			recommended: "ES2022"
+		}
+	}));
+	else if (!MODERN_TARGETS.has(target)) diagnostics.push(diag({
+		filePath: relPath,
+		rule: "config-lint/tsconfig-target",
+		severity: "info",
+		message: `compilerOptions.target is set to "${target}" — consider using ES2022+ for modern output`,
+		help: "Consider setting \"target\" to \"ES2022\" or \"ESNext\" for modern JavaScript output.",
+		detail: {
+			key: "target",
+			current: target,
+			recommended: "ES2022"
+		}
+	}));
+	return diagnostics;
+}
+async function checkMissingEslint(root) {
+	if ((await findFilesWithPrefix(root, ".eslintrc")).length > 0) return [];
+	if ((await findFilesWithName(root, "eslint.config")).length > 0) return [];
+	const pkgJson = await readJsonFile(join(root, "package.json"));
+	if (pkgJson && "eslintConfig" in pkgJson) return [];
+	return [diag({
+		filePath: "package.json",
+		rule: "config-lint/missing-eslint",
+		severity: "info",
+		message: "No ESLint configuration found in the project",
+		help: "Add ESLint for code quality enforcement. Run: npm init @eslint/config@latest or create an eslint.config.js file.",
+		detail: { checked: [
+			".eslintrc.*",
+			"eslint.config.*",
+			"package.json#eslintConfig"
+		] }
+	})];
+}
+const REQUIRED_SCRIPTS = [
+	"build",
+	"test",
+	"lint"
+];
+async function checkPackageJsonScripts(root) {
+	const diagnostics = [];
+	const pkgJson = await readJsonFile(join(root, "package.json"));
+	if (!pkgJson) return diagnostics;
+	const scripts = pkgJson.scripts ?? {};
+	const missing = [];
+	for (const name of REQUIRED_SCRIPTS) if (!scripts[name]) missing.push(name);
+	if (missing.length > 0) diagnostics.push(diag({
+		filePath: "package.json",
+		rule: "config-lint/package-json-scripts",
+		severity: "warning",
+		message: `Missing recommended scripts in package.json: ${missing.join(", ")}`,
+		help: `Add the following scripts to package.json: ${missing.map((s) => `"${s}"`).join(", ")}. Standard scripts improve CI/CD integration and developer experience.`,
+		detail: {
+			missing,
+			present: Object.keys(scripts)
+		}
+	}));
+	return diagnostics;
+}
+async function checkMissingPrettier(root) {
+	if ((await findFilesWithPrefix(root, ".prettierrc")).length > 0) return [];
+	if ((await findFilesWithName(root, "prettier.config")).length > 0) return [];
+	const pkgJson = await readJsonFile(join(root, "package.json"));
+	if (pkgJson && "prettier" in pkgJson) return [];
+	return [diag({
+		filePath: "package.json",
+		rule: "config-lint/missing-prettier",
+		severity: "info",
+		message: "No Prettier configuration found in the project",
+		help: "Add Prettier for consistent code formatting. Run: npm install --save-dev prettier && echo {} > .prettierrc",
+		detail: { checked: [
+			".prettierrc.*",
+			"prettier.config.*",
+			"package.json#prettier"
+		] }
+	})];
+}
+async function checkViteConfig(root) {
+	const diagnostics = [];
+	const viteConfigPath = await findFile(root, [
+		"vite.config.ts",
+		"vite.config.js",
+		"vite.config.mts",
+		"vite.config.mjs"
+	]);
+	if (!viteConfigPath) return diagnostics;
+	const relPath = basename(viteConfigPath);
+	const content = await readFileContent(viteConfigPath);
+	if (!(/build\s*:\s*\{[^}]*sourcemap\s*:/s.test(content) || /sourcemap\s*:\s*true/.test(content))) diagnostics.push(diag({
+		filePath: relPath,
+		rule: "config-lint/vite-config",
+		severity: "info",
+		message: `Vite config does not enable build.sourcemap`,
+		help: "Add `build: { sourcemap: true }` to your Vite config for better debugging with source maps.",
+		detail: {
+			key: "build.sourcemap",
+			current: null,
+			recommended: true
+		}
+	}));
+	if (!/server\s*:\s*\{[^}]*port\s*:/s.test(content)) diagnostics.push(diag({
+		filePath: relPath,
+		rule: "config-lint/vite-config",
+		severity: "info",
+		message: `Vite config does not set server.port`,
+		help: "Add `server: { port: 3000 }` (or your preferred port) to your Vite config for a consistent dev server port.",
+		detail: {
+			key: "server.port",
+			current: null,
+			recommended: 3e3
+		}
+	}));
+	return diagnostics;
+}
+async function checkNextConfig(root) {
+	const diagnostics = [];
+	const nextConfigPath = await findFile(root, [
+		"next.config.ts",
+		"next.config.js",
+		"next.config.mjs"
+	]);
+	if (!nextConfigPath) return diagnostics;
+	const relPath = basename(nextConfigPath);
+	const content = await readFileContent(nextConfigPath);
+	if (!/reactStrictMode\s*:\s*true/.test(content)) diagnostics.push(diag({
+		filePath: relPath,
+		rule: "config-lint/next-config",
+		severity: "info",
+		message: `Next.js config does not enable reactStrictMode`,
+		help: "Add `reactStrictMode: true` to your Next.js config. This helps identify unsafe lifecycle methods and deprecated patterns.",
+		detail: {
+			key: "reactStrictMode",
+			current: false,
+			recommended: true
+		}
+	}));
+	if (!/poweredByHeader\s*:\s*false/.test(content)) diagnostics.push(diag({
+		filePath: relPath,
+		rule: "config-lint/next-config",
+		severity: "info",
+		message: `Next.js config does not disable X-Powered-By header`,
+		help: "Add `poweredByHeader: false` to your Next.js config to hide the \"X-Powered-By: Next.js\" response header for security.",
+		detail: {
+			key: "poweredByHeader",
+			current: true,
+			recommended: false
+		}
+	}));
+	return diagnostics;
+}
+async function checkEditorconfig(root) {
+	if (await fileExists(join(root, ".editorconfig"))) return [];
+	return [diag({
+		filePath: ".editorconfig",
+		rule: "config-lint/editorconfig",
+		severity: "info",
+		message: "No .editorconfig file found in the project root",
+		help: "Add an .editorconfig file to enforce consistent coding style (indentation, charset, line endings) across editors and contributors.",
+		suggestion: {
+			type: "insert",
+			text: [
+				"root = true",
+				"",
+				"[*]",
+				"indent_style = space",
+				"indent_size = 2",
+				"end_of_line = lf",
+				"charset = utf-8",
+				"trim_trailing_whitespace = true",
+				"insert_final_newline = true",
+				"",
+				"[*.md]",
+				"trim_trailing_whitespace = false"
+			].join("\n"),
+			confidence: .9,
+			reason: "A standard .editorconfig ensures consistent formatting across all contributors and editors."
+		}
+	})];
+}
+const configLintEngine = {
+	name: "config-lint",
+	description: "Configuration validation: tsconfig strictness & target, ESLint/Prettier presence, package.json scripts, Vite/Next config checks, editorconfig",
+	supportedLanguages: ["typescript", "javascript"],
+	async run(context) {
+		const start = performance.now();
+		const diagnostics = [];
+		const root = context.rootDirectory;
+		if (!(context.languages.includes("typescript") || context.languages.includes("javascript"))) return {
+			engine: this.name,
+			diagnostics: [],
+			elapsed: performance.now() - start,
+			skipped: true,
+			skipReason: "No TypeScript or JavaScript detected in project"
+		};
+		const results = await Promise.all([
+			checkTsconfigStrict(root),
+			checkTsconfigTarget(root),
+			checkMissingEslint(root),
+			checkPackageJsonScripts(root),
+			checkMissingPrettier(root),
+			checkViteConfig(root),
+			checkNextConfig(root),
+			checkEditorconfig(root)
+		]);
+		for (const ruleDiagnostics of results) diagnostics.push(...ruleDiagnostics);
+		return {
+			engine: this.name,
+			diagnostics,
+			elapsed: performance.now() - start,
+			skipped: false
+		};
+	}
+};
+
+//#endregion
+export { configLintEngine };