@effected/package-json 0.1.0

package/index.js

@@ -0,0 +1,12 @@
+import { Dependency, isUnresolvedDependency } from "./Dependency.js";
+import { DevEngine, DevEngineOrArray, DevEnginesSchema } from "./DevEngines.js";
+import { InvalidSpdxLicenseError, SpdxLicense, isValidSpdx } from "./License.js";
+import { PackageManager } from "./PackageManager.js";
+import { InvalidPackageNameError, PackageName, ScopedPackageName, UnscopedPackageName } from "./PackageName.js";
+import { Person } from "./Person.js";
+import { BinField, DependencyMapField, ExportsField, Package, PackageDecodeError, PeerDependenciesMetaField, PublishConfigField, RepositoryField, StringMapField } from "./Package.js";
+import { PackageJsonFile, PackageJsonNotFoundError, PackageJsonParseError, PackageJsonReadError, PackageJsonWriteError } from "./PackageJsonFile.js";
+import { PackageValidationError, PackageValidator, defaultRules, noLocalDepsRule, noUnresolvedDepsRule } from "./PackageValidator.js";
+import { DependencySpecifier, InvalidDependencySpecifierError, isValidDependencySpecifier } from "@effected/npm";
+
+export { BinField, Dependency, DependencyMapField, DependencySpecifier, DevEngine, DevEngineOrArray, DevEnginesSchema, ExportsField, InvalidDependencySpecifierError, InvalidPackageNameError, InvalidSpdxLicenseError, Package, PackageDecodeError, PackageJsonFile, PackageJsonNotFoundError, PackageJsonParseError, PackageJsonReadError, PackageJsonWriteError, PackageManager, PackageName, PackageValidationError, PackageValidator, PeerDependenciesMetaField, Person, PublishConfigField, RepositoryField, ScopedPackageName, SpdxLicense, StringMapField, UnscopedPackageName, defaultRules, isUnresolvedDependency, isValidDependencySpecifier, isValidSpdx, noLocalDepsRule, noUnresolvedDepsRule };

package/internal/format.js

@@ -0,0 +1,106 @@
+//#region src/internal/format.ts
+const KEY_INDEX = new Map([
+	"$schema",
+	"name",
+	"version",
+	"private",
+	"description",
+	"keywords",
+	"homepage",
+	"bugs",
+	"repository",
+	"funding",
+	"license",
+	"author",
+	"contributors",
+	"type",
+	"imports",
+	"exports",
+	"main",
+	"module",
+	"browser",
+	"bin",
+	"man",
+	"files",
+	"directories",
+	"workspaces",
+	"scripts",
+	"config",
+	"dependencies",
+	"devDependencies",
+	"peerDependencies",
+	"peerDependenciesMeta",
+	"optionalDependencies",
+	"bundleDependencies",
+	"overrides",
+	"engines",
+	"devEngines",
+	"os",
+	"cpu",
+	"publishConfig",
+	"packageManager"
+].map((k, i) => [k, i]));
+/**
+* Deterministic, locale-independent string comparison by code point. A bare
+* `localeCompare` sorts differently across ICU builds/locales; package.json key
+* order must be stable everywhere.
+*/
+const byCodePoint = (a, b) => a < b ? -1 : a > b ? 1 : 0;
+const DEPENDENCY_KEYS = /* @__PURE__ */ new Set([
+	"dependencies",
+	"devDependencies",
+	"peerDependencies",
+	"optionalDependencies",
+	"bundleDependencies"
+]);
+/** Alphabetize the entries of a plain-object dependency map. */
+const sortDependencyMap = (value) => {
+	const result = {};
+	for (const key of Object.keys(value).sort(byCodePoint)) result[key] = value[key];
+	return result;
+};
+const isPlainObject = (value) => value !== null && typeof value === "object" && !Array.isArray(value);
+/**
+* Order top-level keys canonically (known keys by {@link KEY_ORDER}, the rest
+* alphabetically) and alphabetize dependency-map entries.
+*/
+const sortKeys = (obj) => {
+	const known = [];
+	const rest = [];
+	for (const key of Object.keys(obj)) if (KEY_INDEX.has(key)) known.push([key, obj[key]]);
+	else rest.push([key, obj[key]]);
+	known.sort((a, b) => KEY_INDEX.get(a[0]) - KEY_INDEX.get(b[0]));
+	rest.sort((a, b) => byCodePoint(a[0], b[0]));
+	const result = {};
+	for (const [key, value] of [...known, ...rest]) result[key] = DEPENDENCY_KEYS.has(key) && isPlainObject(value) ? sortDependencyMap(value) : value;
+	return result;
+};
+const DEPENDENCY_MAP_KEYS = [
+	"dependencies",
+	"devDependencies",
+	"peerDependencies",
+	"optionalDependencies"
+];
+/** Remove dependency-map keys whose value is an empty object. */
+const stripEmptyDependencyMaps = (raw) => {
+	const result = { ...raw };
+	for (const key of DEPENDENCY_MAP_KEYS) {
+		const value = result[key];
+		if (isPlainObject(value) && Object.keys(value).length === 0) delete result[key];
+	}
+	return result;
+};
+/**
+* Render an already-encoded package.json record to a JSON string, applying the
+* empty-map strip, canonical key ordering and a trailing newline unless the
+* corresponding options opt out.
+*/
+const renderJson = (raw, options) => {
+	let record = options.stripEmpty ? stripEmptyDependencyMaps(raw) : raw;
+	if (options.sort) record = sortKeys(record);
+	const json = JSON.stringify(record, null, options.indent);
+	return options.newline ? `${json}\n` : json;
+};
+
+//#endregion
+export { renderJson, sortKeys, stripEmptyDependencyMaps };

package/package.json

@@ -0,0 +1,50 @@
+{
+	"name": "@effected/package-json",
+	"version": "0.1.0",
+	"private": false,
+	"description": "package.json parsing, editing, validation and file IO as Effect schemas.",
+	"keywords": [
+		"package.json",
+		"npm",
+		"manifest",
+		"effect",
+		"schema",
+		"validation",
+		"effected"
+	],
+	"homepage": "https://github.com/spencerbeggs/effected/tree/main/packages/package-json#readme",
+	"bugs": {
+		"url": "https://github.com/spencerbeggs/effected/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/spencerbeggs/effected.git",
+		"directory": "packages/package-json"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "C. Spencer Beggs",
+		"email": "spencer@beggs.codes",
+		"url": "https://spencerbeg.gs"
+	},
+	"sideEffects": false,
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./index.d.ts",
+			"import": "./index.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"dependencies": {
+		"@effected/npm": "0.1.0",
+		"@effected/semver": "0.1.0",
+		"spdx-expression-parse": "^4.0.0"
+	},
+	"peerDependencies": {
+		"effect": "4.0.0-beta.98"
+	},
+	"engines": {
+		"node": ">=24.11.0"
+	}
+}

package/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.58.9"
+    }
+  ]
+}