@lpm-registry/cli 0.57.0 → 0.59.0

package/lib/quality/checks.js

@@ -1,687 +0,0 @@
-/**
- * Quality check definitions for LPM packages.
- * Each check is a pure function that returns { passed, detail }.
- * Checks are grouped by category and scored out of 100 total points.
- *
- * Categories:
- *   - documentation: 22 points (6 checks)
- *   - code: 31 points (9 checks)
- *   - testing: 11 points (2 checks)
- *   - health: 36 points (11 checks)
- */
-
-const DEFAULT_TEST_SCRIPT = 'echo "Error: no test" && exit 1'
-
-// --- Documentation checks (22 points) ---
-
-const hasReadme = {
-	id: "has-readme",
-	category: "documentation",
-	label: "Has README",
-	max_points: 8,
-	run: ({ readme }) => ({
-		passed: !!readme && readme.length > 100,
-		detail: readme
-			? `README found (${readme.length.toLocaleString()} chars)`
-			: "No README found",
-	}),
-}
-
-const readmeHasInstall = {
-	id: "readme-install",
-	category: "documentation",
-	label: "README has install section",
-	max_points: 3,
-	run: ({ readme }) => {
-		if (!readme) return { passed: false, detail: "No README" }
-		const lower = readme.toLowerCase()
-		const hasSection =
-			lower.includes("## install") ||
-			lower.includes("## getting started") ||
-			lower.includes("## setup") ||
-			lower.includes("npm install") ||
-			lower.includes("lpm add") ||
-			lower.includes("lpm install")
-		return {
-			passed: hasSection,
-			detail: hasSection
-				? "Install instructions found"
-				: "No install section found in README",
-		}
-	},
-}
-
-const readmeHasUsage = {
-	id: "readme-usage",
-	category: "documentation",
-	label: "README has usage examples",
-	max_points: 3,
-	run: ({ readme }) => {
-		if (!readme) return { passed: false, detail: "No README" }
-		const lower = readme.toLowerCase()
-		const hasUsageSection =
-			lower.includes("## usage") || lower.includes("## example")
-		const codeBlockCount = (readme.match(/```/g) || []).length / 2
-		const hasCodeBlocks = codeBlockCount >= 2
-		const passed = hasUsageSection || hasCodeBlocks
-		return {
-			passed,
-			detail: passed
-				? `Usage examples found (${Math.floor(codeBlockCount)} code blocks)`
-				: "No usage examples found in README",
-		}
-	},
-}
-
-const readmeHasApi = {
-	id: "readme-api",
-	category: "documentation",
-	label: "README has API docs",
-	max_points: 2,
-	run: ({ readme }) => {
-		if (!readme) return { passed: false, detail: "No README" }
-		const lower = readme.toLowerCase()
-		const hasApiSection =
-			lower.includes("## api") ||
-			lower.includes("## reference") ||
-			lower.includes("## props") ||
-			lower.includes("## parameters") ||
-			lower.includes("## options")
-		return {
-			passed: hasApiSection,
-			detail: hasApiSection
-				? "API documentation found"
-				: "No API/reference section found in README",
-		}
-	},
-}
-
-const hasChangelog = {
-	id: "has-changelog",
-	category: "documentation",
-	label: "Has CHANGELOG",
-	max_points: 3,
-	run: ({ files }) => {
-		const changelogFiles = files.filter(f => {
-			const name = (f.path || f).toLowerCase()
-			return name.includes("changelog")
-		})
-		return {
-			passed: changelogFiles.length > 0,
-			detail:
-				changelogFiles.length > 0
-					? "CHANGELOG found"
-					: "No CHANGELOG file found",
-		}
-	},
-}
-
-const hasLicense = {
-	id: "has-license",
-	category: "documentation",
-	label: "Has LICENSE file",
-	max_points: 3,
-	run: ({ files, packageJson }) => {
-		const licenseFiles = files.filter(f => {
-			const name = (f.path || f).toLowerCase()
-			return name.includes("license") || name.includes("licence")
-		})
-		const hasLicenseField = !!packageJson.license
-		const passed = licenseFiles.length > 0 || hasLicenseField
-		return {
-			passed,
-			detail:
-				licenseFiles.length > 0
-					? "LICENSE file found"
-					: hasLicenseField
-						? `License field: ${packageJson.license}`
-						: "No LICENSE file or license field",
-		}
-	},
-}
-
-// --- Code Quality checks (31 points) ---
-
-const hasTypes = {
-	id: "has-types",
-	category: "code",
-	label: "Has TypeScript types",
-	max_points: 8,
-	run: ({ packageJson, files }) => {
-		const hasTypesField = !!(packageJson.types || packageJson.typings)
-		const hasDtsFiles = files.some(f => {
-			const name = f.path || f
-			return name.endsWith(".d.ts") || name.endsWith(".d.mts")
-		})
-		const passed = hasTypesField || hasDtsFiles
-		return {
-			passed,
-			detail: hasTypesField
-				? `Types field: ${packageJson.types || packageJson.typings}`
-				: hasDtsFiles
-					? ".d.ts files found"
-					: "No TypeScript type definitions found",
-		}
-	},
-}
-
-const intellisenseCoverage = {
-	id: "intellisense-coverage",
-	category: "code",
-	label: "Intellisense coverage",
-	max_points: 4,
-	run: ({ packageJson, files }) => {
-		// Full points if .d.ts files exist (complete intellisense)
-		const hasTypesField = !!(packageJson.types || packageJson.typings)
-		const hasDtsFiles = files.some(f => {
-			const name = f.path || f
-			return name.endsWith(".d.ts") || name.endsWith(".d.mts")
-		})
-		if (hasTypesField || hasDtsFiles) {
-			return {
-				passed: true,
-				detail: "TypeScript definitions provide full intellisense",
-			}
-		}
-		// Partial check: JSDoc detection runs server-side from tarball
-		// CLI assumes fail; server can upgrade if JSDoc found
-		return {
-			passed: false,
-			detail: "No .d.ts files or JSDoc detected for intellisense",
-			server_only: true,
-		}
-	},
-}
-
-const hasEsm = {
-	id: "esm-exports",
-	category: "code",
-	label: "ESM exports",
-	max_points: 3,
-	run: ({ packageJson }) => {
-		const isModule = packageJson.type === "module"
-		const hasModuleField = !!packageJson.module
-		const hasExportsField = !!packageJson.exports
-		const passed = isModule || hasModuleField || hasExportsField
-		return {
-			passed,
-			detail: isModule
-				? '"type": "module" detected'
-				: hasExportsField
-					? '"exports" field detected'
-					: hasModuleField
-						? '"module" field detected'
-						: "No ESM support detected",
-		}
-	},
-}
-
-const treeShakable = {
-	id: "tree-shakable",
-	category: "code",
-	label: "Tree-shakable",
-	max_points: 3,
-	run: ({ packageJson }) => {
-		const hasSideEffects = packageJson.sideEffects === false
-		const hasExportsField = !!packageJson.exports
-		const isModule = packageJson.type === "module"
-		const passed = hasSideEffects || (hasExportsField && isModule)
-		let detail
-		if (hasSideEffects) {
-			detail = '"sideEffects": false enables tree-shaking'
-		} else if (hasExportsField && isModule) {
-			detail = "ESM + exports map enables tree-shaking"
-		} else {
-			detail = 'No "sideEffects": false in package.json'
-		}
-		return { passed, detail }
-	},
-}
-
-const noEval = {
-	id: "no-eval",
-	category: "code",
-	label: "No eval/Function() patterns",
-	max_points: 3,
-	run: () => {
-		// This check runs server-side from tarball contents.
-		// CLI assumes pass; server overrides if eval detected.
-		return {
-			passed: true,
-			detail: "Full check runs server-side",
-			server_only: true,
-		}
-	},
-}
-
-const noLifecycleScripts = {
-	id: "no-lifecycle-scripts",
-	category: "health",
-	label: "No lifecycle scripts",
-	max_points: 2,
-	run: ({ packageJson }) => {
-		const lifecycleNames = [
-			"preinstall",
-			"install",
-			"postinstall",
-			"preuninstall",
-			"uninstall",
-			"postuninstall",
-		]
-		const scripts = packageJson.scripts || {}
-		const found = lifecycleNames.filter(name => scripts[name])
-		if (found.length === 0) {
-			return {
-				passed: true,
-				detail: "No lifecycle scripts detected",
-			}
-		}
-		return {
-			passed: false,
-			detail: `Lifecycle scripts found: ${found.join(", ")}`,
-		}
-	},
-}
-
-const hasEngines = {
-	id: "has-engines",
-	category: "code",
-	label: 'Has "engines" field',
-	max_points: 1,
-	run: ({ packageJson }) => {
-		const hasField = !!packageJson.engines?.node
-		return {
-			passed: hasField,
-			detail: hasField
-				? `engines.node: ${packageJson.engines.node}`
-				: 'No "engines" field in package.json',
-		}
-	},
-}
-
-const hasExportsMap = {
-	id: "has-exports-map",
-	category: "code",
-	label: 'Has "exports" map',
-	max_points: 3,
-	run: ({ packageJson }) => {
-		const hasField = !!packageJson.exports
-		return {
-			passed: hasField,
-			detail: hasField
-				? '"exports" map defined'
-				: 'No "exports" map in package.json',
-		}
-	},
-}
-
-const smallDeps = {
-	id: "small-deps",
-	category: "code",
-	label: "Small dependency footprint",
-	max_points: 3,
-	run: ({ packageJson }) => {
-		const deps = packageJson.dependencies
-			? Object.keys(packageJson.dependencies).length
-			: 0
-		let points
-		if (deps === 0) points = 3
-		else if (deps <= 3) points = 2
-		else if (deps <= 7) points = 1
-		else points = 0
-		return {
-			passed: points > 0,
-			points,
-			detail: `${deps} production ${deps === 1 ? "dependency" : "dependencies"}`,
-		}
-	},
-}
-
-const sourceMaps = {
-	id: "source-maps",
-	category: "code",
-	label: "Source maps included",
-	max_points: 1,
-	run: ({ files }) => {
-		const mapFiles = files.filter(f => {
-			const name = f.path || f
-			return name.endsWith(".js.map") || name.endsWith(".mjs.map")
-		})
-		return {
-			passed: mapFiles.length > 0,
-			detail:
-				mapFiles.length > 0
-					? `${mapFiles.length} source map${mapFiles.length !== 1 ? "s" : ""} found`
-					: "No source map files found",
-		}
-	},
-}
-
-// --- Testing checks (11 points) ---
-
-const hasTestFiles = {
-	id: "has-test-files",
-	category: "testing",
-	label: "Has test files",
-	max_points: 7,
-	run: ({ projectFiles, files }) => {
-		// Prefer projectFiles (local project scan) over files (tarball)
-		// so authors don't need to ship test files in the package
-		const fileList = projectFiles || files
-		const testFiles = fileList.filter(f => {
-			const name = (f.path || f).toLowerCase()
-			return (
-				name.includes(".test.") ||
-				name.includes(".spec.") ||
-				name.includes("__tests__/") ||
-				name.startsWith("test/") ||
-				name.startsWith("tests/")
-			)
-		})
-		return {
-			passed: testFiles.length > 0,
-			detail:
-				testFiles.length > 0
-					? `${testFiles.length} test file${testFiles.length !== 1 ? "s" : ""} found`
-					: "No test files found",
-		}
-	},
-}
-
-const hasTestScript = {
-	id: "has-test-script",
-	category: "testing",
-	label: "Has test script",
-	max_points: 4,
-	run: ({ packageJson }) => {
-		const testScript = packageJson.scripts?.test
-		const hasScript = !!testScript && !testScript.includes(DEFAULT_TEST_SCRIPT)
-		return {
-			passed: hasScript,
-			detail: hasScript
-				? `test script: ${testScript}`
-				: "No test script in package.json",
-		}
-	},
-}
-
-// --- Package Health checks (36 points) ---
-
-const hasDescription = {
-	id: "has-description",
-	category: "health",
-	label: "Has description",
-	max_points: 3,
-	run: ({ packageJson }) => {
-		const desc = packageJson.description
-		const passed = !!desc && desc.length > 10
-		return {
-			passed,
-			detail: passed
-				? `Description: "${desc.substring(0, 60)}${desc.length > 60 ? "..." : ""}"`
-				: "No meaningful description in package.json",
-		}
-	},
-}
-
-const hasKeywords = {
-	id: "has-keywords",
-	category: "health",
-	label: "Has keywords",
-	max_points: 1,
-	run: ({ packageJson }) => {
-		const keywords = packageJson.keywords
-		const passed = Array.isArray(keywords) && keywords.length > 0
-		return {
-			passed,
-			detail: passed
-				? `${keywords.length} keyword${keywords.length !== 1 ? "s" : ""}`
-				: "No keywords in package.json",
-		}
-	},
-}
-
-const hasRepository = {
-	id: "has-repository",
-	category: "health",
-	label: "Has repository URL",
-	max_points: 2,
-	run: ({ packageJson }) => {
-		const repo = packageJson.repository
-		const hasRepo = !!(
-			repo &&
-			(typeof repo === "string" || typeof repo?.url === "string")
-		)
-		return {
-			passed: hasRepo,
-			detail: hasRepo
-				? `Repository: ${typeof repo === "string" ? repo : repo.url}`
-				: "No repository field in package.json",
-		}
-	},
-}
-
-const hasHomepage = {
-	id: "has-homepage",
-	category: "health",
-	label: "Has homepage",
-	max_points: 1,
-	run: ({ packageJson }) => {
-		const passed = !!packageJson.homepage
-		return {
-			passed,
-			detail: passed
-				? `Homepage: ${packageJson.homepage}`
-				: "No homepage in package.json",
-		}
-	},
-}
-
-const reasonableSize = {
-	id: "reasonable-size",
-	category: "health",
-	label: "Reasonable bundle size",
-	max_points: 3,
-	run: ({ unpackedSize }) => {
-		if (!unpackedSize)
-			return { passed: true, points: 3, detail: "Size unknown" }
-		const kb = unpackedSize / 1024
-		const mb = kb / 1024
-		let points
-		if (mb < 0.1) points = 3
-		else if (mb < 0.5) points = 2
-		else if (mb < 1) points = 1
-		else points = 0
-
-		const sizeStr = mb >= 1 ? `${mb.toFixed(1)}MB` : `${Math.round(kb)}KB`
-		return {
-			passed: points > 0,
-			points,
-			detail: `Unpacked size: ${sizeStr}`,
-		}
-	},
-}
-
-const noVulnerabilities = {
-	id: "no-vulnerabilities",
-	category: "health",
-	label: "No known vulnerabilities",
-	max_points: 5,
-	run: () => {
-		// This check runs server-side with OSV scan results.
-		// CLI assumes pass; server overrides with actual results.
-		return {
-			passed: true,
-			detail: "Full check runs server-side",
-			server_only: true,
-		}
-	},
-}
-
-const maintenanceHealth = {
-	id: "maintenance-health",
-	category: "health",
-	label: "Active maintenance",
-	max_points: 4,
-	run: () => {
-		// Server-only: checks if last version was published within 90 days.
-		// CLI cannot know this — assumes pass.
-		return {
-			passed: true,
-			detail: "Full check runs server-side",
-			server_only: true,
-		}
-	},
-}
-
-const semverConsistency = {
-	id: "semver-consistency",
-	category: "health",
-	label: "SemVer consistency",
-	max_points: 4,
-	run: ({ packageJson }) => {
-		// CLI can check if the current version is valid semver
-		const version = packageJson.version
-		if (!version) return { passed: false, detail: "No version in package.json" }
-		// Basic semver regex (major.minor.patch with optional pre-release)
-		const semverRegex = /^\d+\.\d+\.\d+(-[\w.]+)?(\+[\w.]+)?$/
-		const isValid = semverRegex.test(version)
-		// Server can also check version history for wild jumps
-		return {
-			passed: isValid,
-			detail: isValid
-				? `Valid semver: ${version}`
-				: `Invalid semver format: ${version}`,
-			server_only: !isValid ? undefined : true,
-		}
-	},
-}
-
-const authorVerified = {
-	id: "author-verified",
-	category: "health",
-	label: "Verified author",
-	max_points: 3,
-	run: () => {
-		// Server-only: checks if the author has linked social accounts.
-		// CLI cannot know this — assumes pass.
-		return {
-			passed: true,
-			detail: "Full check runs server-side",
-			server_only: true,
-		}
-	},
-}
-
-// --- Agent Skills checks (10 points) ---
-
-const hasSkills = {
-	id: "has-skills",
-	category: "health",
-	label: "Has Agent Skills",
-	max_points: 7,
-	run: () => {
-		// Server-only: checks if package has approved skills.
-		// CLI cannot determine this — assumes fail.
-		return {
-			passed: false,
-			detail: "Full check runs server-side",
-			server_only: true,
-		}
-	},
-}
-
-const skillsComprehensive = {
-	id: "skills-comprehensive",
-	category: "health",
-	label: "Comprehensive Agent Skills",
-	max_points: 3,
-	run: () => {
-		// Server-only: checks if package has 3+ approved skills.
-		// CLI cannot determine this — assumes fail.
-		return {
-			passed: false,
-			detail: "Full check runs server-side",
-			server_only: true,
-		}
-	},
-}
-
-// --- Export all checks ---
-
-/** JS checks (default) */
-export const checks = [
-	// Documentation (22)
-	hasReadme,
-	readmeHasInstall,
-	readmeHasUsage,
-	readmeHasApi,
-	hasChangelog,
-	hasLicense,
-	// Code Quality (31)
-	hasTypes,
-	intellisenseCoverage,
-	hasEsm,
-	treeShakable,
-	noEval,
-	hasEngines,
-	hasExportsMap,
-	smallDeps,
-	sourceMaps,
-	// Testing (11)
-	hasTestFiles,
-	hasTestScript,
-	// Health (36)
-	hasDescription,
-	hasKeywords,
-	hasRepository,
-	hasHomepage,
-	reasonableSize,
-	noVulnerabilities,
-	noLifecycleScripts,
-	maintenanceHealth,
-	semverConsistency,
-	authorVerified,
-	hasSkills,
-	skillsComprehensive,
-]
-
-// Export individual universal checks for reuse by ecosystem-specific check sets
-export {
-	hasReadme,
-	readmeHasUsage,
-	readmeHasApi,
-	hasChangelog,
-	hasLicense,
-	hasDescription,
-	hasKeywords,
-	hasRepository,
-	hasHomepage,
-	reasonableSize,
-	noVulnerabilities,
-	noLifecycleScripts,
-	maintenanceHealth,
-	semverConsistency,
-	authorVerified,
-	hasSkills,
-	skillsComprehensive,
-}
-
-/**
- * Get source package informational badges (not scored)
- * @param {object} lpmConfig
- * @returns {object|null}
- */
-export function getSourcePackageInfo(lpmConfig) {
-	if (!lpmConfig) return null
-	return {
-		hasConfig: true,
-		hasDefaults: !!lpmConfig.defaultConfig,
-		optionCount: lpmConfig.configSchema
-			? Object.keys(lpmConfig.configSchema).length
-			: 0,
-		usesConditionalIncludes: (lpmConfig.files || []).some(
-			f => f.include === "when" && f.condition,
-		),
-	}
-}