@dbarrett24/tsdown-config 1.1.0 → 1.1.1

package/dist/index.js

@@ -1,5 +1,6 @@
 import { readWantedLockfile } from "@pnpm/lockfile-file";
 import { merge } from "es-toolkit";
+import * as fs$1 from "fs";
 import fs from "fs";
 import path from "path";
 import { defineConfig } from "tsdown";
@@ -85,6 +86,50 @@ const writeEntryManifest = (packageName, entries, clientEntries = {}, targetDir
 	fs.writeFileSync(path.join(targetDir, ENTRY_MANIFEST_FILENAME), `${JSON.stringify(manifest, null, 4)}\n`);
 };
 //#endregion
+//#region json-file.ts
+/**
+* The one way this repo turns JSON text into a typed value.
+*
+* A bare `JSON.parse(...)` returns `any`, so `JSON.parse(text).name` compiles whether or not the
+* file has a `name` — which is how the entry manifest once shipped `package: undefined` (PR #55).
+* The caller states the shape it relies on as a type guard, and a mismatch throws an error naming
+* the file and the failed expectation.
+*
+* This is the single generic core (`isJsonObject`, `parseJson`, `readJsonFile`). `scripts/lib/json-file.ts`
+* imports it and adds only the guards scripts/ itself needs; do not copy it. Kept in its own
+* dependency-free module (like `workspace-specifier.ts`) so it unit-tests without loading tsdown.
+*
+* `pnpm check-json-parse` fails on a bare `JSON.parse` anywhere in scope, and exempts this file
+* because it is where the one permitted `JSON.parse` lives.
+*/
+const isJsonObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+const isString = (value) => typeof value === "string";
+const isOptional = (value, guard) => value === void 0 || guard(value);
+const isStringRecord = (value) => isJsonObject(value) && Object.values(value).every(isString);
+const isSourceManifest = (value) => isJsonObject(value) && isString(value.name) && isString(value.version) && isOptional(value.dependencies, isStringRecord) && isOptional(value.peerDependencies, isStringRecord) && isOptional(value.publishConfig, (v) => isJsonObject(v) && isOptional(v.access, isString)) && isOptional(value.bin, isStringRecord) && isOptional(value.scripts, (v) => isJsonObject(v) && isOptional(v.postinstall, isString));
+/** A manifest that declares a string `version`, which is all a workspace dependency lookup needs. */
+const hasStringVersion = (value) => isJsonObject(value) && isString(value.version);
+/**
+* Parse JSON text and check it against `guard`.
+*
+* @param source what the text came from (a path, or a description such as `WebSocket frame`); it
+*   leads the error message
+* @param expectation what the guard checks, for the error message (e.g. `a package.json object`)
+*/
+const parseJson = (text, source, guard, expectation = "the expected shape") => {
+	let parsed;
+	try {
+		parsed = JSON.parse(text);
+	} catch (error) {
+		const reason = error instanceof Error ? error.message : String(error);
+		throw new Error(`${source}: not valid JSON (${reason})`);
+	}
+	if (!guard(parsed)) throw new Error(`${source}: parsed JSON is not ${expectation}`);
+	return parsed;
+};
+/** Read `filePath` as UTF-8 JSON and check it against `guard`; errors name `filePath`. */
+const readJsonFile = (filePath, guard, expectation = "the expected shape") => parseJson(fs$1.readFileSync(filePath, "utf-8"), filePath, guard, expectation);
+//#endregion
 //#region workspace-specifier.ts
 /**
 * Resolution of pnpm workspace protocol specifiers for the emitted `dist/package.json`.
@@ -120,7 +165,7 @@ const makeConfig = (entries, clientEntries, optionOverrides) => {
 	return defineConfig(makeConfigObject(entries, clientEntries, optionOverrides));
 };
 const copyPackageJson = async () => {
-	const packageJSON = JSON.parse(fs.readFileSync("package.json").toString());
+	const packageJSON = readJsonFile("package.json", isSourceManifest, "a package.json manifest");
 	const newPackageJSON = {};
 	newPackageJSON.name = packageJSON.name;
 	newPackageJSON.dependencies = packageJSON.dependencies;
@@ -177,21 +222,13 @@ const copyPackageJson = async () => {
 	const packageName = process.cwd().split(path.sep).slice(-2).join("/");
 	const lockfile_package_list = (await readWantedLockfile("../..", { ignoreIncompatible: true }))?.importers?.[packageName];
 	const merged_deps = merge(lockfile_package_list?.dependencies ?? {}, lockfile_package_list?.devDependencies ?? {});
-	for (const item of Object.entries(newPackageJSON.peerDependencies)) {
-		const [dep, version] = item;
-		if (isWorkspaceSpecifier(version)) {
-			const package_path = merged_deps?.[dep].version.replace(/(?:link:|\/dist)/g, "") + "/package.json";
-			const packageJSON = JSON.parse(fs.readFileSync(package_path).toString());
-			newPackageJSON.peerDependencies[dep] = resolveWorkspaceSpecifier(version, packageJSON.version);
-		}
+	for (const [dep, version] of Object.entries(packageJSON.peerDependencies ?? {})) if (isWorkspaceSpecifier(version)) {
+		const packageJSON = readJsonFile(merged_deps?.[dep].version.replace(/(?:link:|\/dist)/g, "") + "/package.json", hasStringVersion, "a package.json with a string \"version\"");
+		newPackageJSON.peerDependencies[dep] = resolveWorkspaceSpecifier(version, packageJSON.version);
 	}
-	for (const item of Object.entries(newPackageJSON.dependencies ?? {})) {
-		const [dep, version] = item;
-		if (isWorkspaceSpecifier(version)) {
-			const package_path = merged_deps?.[dep].version.replace(/(?:link:|\/dist)/g, "") + "/package.json";
-			const packageJSON = JSON.parse(fs.readFileSync(package_path).toString());
-			newPackageJSON.dependencies[dep] = resolveWorkspaceSpecifier(version, packageJSON.version);
-		}
+	for (const [dep, version] of Object.entries(packageJSON.dependencies ?? {})) if (isWorkspaceSpecifier(version)) {
+		const packageJSON = readJsonFile(merged_deps?.[dep].version.replace(/(?:link:|\/dist)/g, "") + "/package.json", hasStringVersion, "a package.json with a string \"version\"");
+		newPackageJSON.dependencies[dep] = resolveWorkspaceSpecifier(version, packageJSON.version);
 	}
 	fs.writeFileSync("dist/package.json", formatEmittedPackageJson(newPackageJSON));
 };
@@ -245,7 +282,7 @@ const makeConfigObject = (entries, clientEntries = {}, optionOverrides = {}) =>
 		...optionOverrides,
 		onSuccess: async (config, signal) => {
 			if (typeof optionOverrides.onSuccess === "function") await optionOverrides.onSuccess(config, signal);
-			const packageName = JSON.parse(fs.readFileSync("package.json").toString()).name;
+			const packageName = readJsonFile("package.json", isJsonObject, "a package.json object").name;
 			if (typeof packageName !== "string" || packageName.length === 0) throw new Error("tsdown-config: package.json has no \"name\" to write into the entry manifest");
 			await copyPackageJson();
 			copySources("src", "dist/src");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbarrett24/tsdown-config",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Shared tsdown configuration for building component libraries (publish-from-dist with generated wildcard exports)",
   "type": "module",
   "module": "dist/index.js",
@@ -55,8 +55,8 @@
     "lint-fix": "pnpm lint-oxlint-fix && pnpm lint-oxfmt-fix",
     "lint-oxfmt": "oxfmt --config ../../.oxfmtrc.json --check \"*.ts\"",
     "lint-oxfmt-fix": "oxfmt --config ../../.oxfmtrc.json --write \"*.ts\"",
-    "lint-oxlint": "oxlint index.ts tsdown.config.ts workspace-specifier.ts",
-    "lint-oxlint-fix": "oxlint --fix index.ts tsdown.config.ts workspace-specifier.ts",
+    "lint-oxlint": "oxlint index.ts json-file.ts tsdown.config.ts workspace-specifier.ts",
+    "lint-oxlint-fix": "oxlint --fix index.ts json-file.ts tsdown.config.ts workspace-specifier.ts",
     "ts-check": "tsc --noEmit",
     "test": "jest --passWithNoTests"
   }