#!/usr/bin/env node /** * For every absolute import in dist-cjs and dist-es, validates that the * dependency is declared in package.json (dependencies or peerDependencies). * * Usage: node imports-declared.js [...] */ const fs = require("node:fs"); const path = require("node:path"); const walk = require("../utils/walk"); const { NODE_BUILTINS, getPackageName, extractImports, getPackageDirs, summarizePackages, } = require("./validation-shared"); /** * @param packageDir - package root. * @param pkgJson - parsed package.json. * @param distName - "dist-cjs" or "dist-es". * @returns error messages for undeclared imports. */ async function validateDist(packageDir, pkgJson, distName) { const distDir = path.join(packageDir, distName); if (!fs.existsSync(distDir)) { return []; } const declared = new Set([ ...Object.keys(pkgJson.dependencies || {}), ...Object.keys(pkgJson.peerDependencies || {}), ]); const useRequireResolve = distName === "dist-cjs"; const errors = []; for await (const file of walk(distDir, ["node_modules"])) { if (!file.endsWith(".js")) { continue; } const code = fs.readFileSync(file, "utf-8"); for (const specifier of extractImports(code)) { if (specifier.startsWith(".") || specifier.startsWith("node:")) { continue; } if (NODE_BUILTINS.has(specifier)) { continue; } const pkg = getPackageName(specifier); if (pkg === pkgJson.name) { continue; } if (!declared.has(pkg) && !declared.has(`@types/${pkg}`)) { errors.push(`${pkg} imported but not declared in ${pkgJson.name} (${path.relative(packageDir, file)})`); } else if (useRequireResolve) { try { require.resolve(specifier, { paths: [path.dirname(file)] }); } catch { errors.push(`${specifier} does not resolve in ${pkgJson.name} (${path.relative(packageDir, file)})`); } } } } return errors; } // Packages exempt from undeclared import checks. const ALLOWLIST = new Set(["@smithy/util-test"]); /** * @param packageDir - package root. * @returns aggregated errors from both dist directories, or null if skipped. */ async function validate(packageDir) { const pkgJsonPath = path.join(packageDir, "package.json"); if (!fs.existsSync(pkgJsonPath)) { return null; } const pkgJson = JSON.parse(fs.readFileSync(pkgJsonPath, "utf-8")); if (pkgJson.private && ALLOWLIST.has(pkgJson.name)) { return null; } const errors = []; for (const dist of ["dist-cjs", "dist-es"]) { errors.push(...(await validateDist(packageDir, pkgJson, dist))); } return errors; } async function main() { const packages = getPackageDirs(); const validated = []; const errors = []; for (const pkg of packages) { const pkgErrors = await validate(pkg.dir); if (pkgErrors !== null) { validated.push(pkg); errors.push(...pkgErrors); } } if (errors.length) { console.error(`❌ ${errors.length} undeclared import(s):\n ${[...new Set(errors)].join("\n ")}`); process.exit(1); } console.log(`✅ All absolute imports are declared in package.json. (${summarizePackages(validated)})`); } main();