feat(tools): update check-imports & readme gen

thi-ng · Jul 20, 2024 · f2c2a2d · f2c2a2d
1 parent 4c60cfd
commit f2c2a2d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/tools/src/check-imports.ts b/tools/src/check-imports.ts
@@ -51,7 +51,12 @@ const updateImports = (root: string, latest = false, exitOnFail = true) => {
 	const pairs: [string, string][] = [];
 	for (let d of mergedDeps) {
 		if (!d.startsWith("@thi.ng")) {
-			if (d.startsWith("node:") || d.startsWith("bun:") || d === "tslib")
+			if (
+				d.startsWith("@types") ||
+				d.startsWith("node:") ||
+				d.startsWith("bun:") ||
+				d === "tslib"
+			)
 				continue;
 			if (deps.has(d) && !pkg.dependencies[d]) {
 				LOGGER.warn("missing 3rd party dependency:", d);

diff --git a/tools/src/partials/package.ts b/tools/src/partials/package.ts
@@ -88,7 +88,12 @@ export const packageDeps = (config: Config, pkg: Package) => {
 	const deps = Object.keys(pkg.dependencies || {})
 		.sort()
 		.map((x) => pkgLink(config, x));
-	return deps.length ? list(deps) : "None";
+	let res = deps.length ? list(deps) : "None";
+	if (pkg.dependencies?.["@thi.ng/api"]) {
+		res +=
+			"\n\nNote: @thi.ng/api is in _most_ cases a type-only import (not used at runtime)";
+	}
+	return res;
 };
 
 export const packageStatus = (