zod-package-json

zod-package-json

Zod schema for the package.json file format.

This package exports a zod schema (and a TypeScript type) named PackageJson that can parse most well-formed package.json files.

The schema includes all currently supported properties listed in the npm docs as well as additional well-known properties specific to TypeScript and Node.js.

The schema also preserves unknown properties, which can be accessed by indexing the parsed data with the desired string keys.

The schema only validates the listed properties against the expected type but does not do any additional normalization such as merging similar properties. If necessary, that can be done by extending the schema with zod methods such as .transform() or .refine().

Useful resources

• Explore the API on jsDocs.io
• View package contents on unpkg
• View repository on GitHub
• Read the changelog on GitHub

Install

Using npm:

npm add zod-package-json

Using yarn:

yarn add zod-package-json

Using pnpm:

pnpm add zod-package-json

Using bun:

bun add zod-package-json

Usage examples

import { PackageJson } from "zod-package-json";

// Parse data from a `package.json` file.
const packageJson = PackageJson.parse({
	name: "foo",
	version: "1.0.0",
	unknownProp: "who knows",
});

// Access a known property.
packageJson.name; // "foo"

// Access an unknown property.
packageJson["unknownProp"]; // "who knows"

License

MIT

Copyright (c) 2024 Edoardo Scibona

See LICENSE file.

Changelog

[1.0.3] - 2024-06-12

Changed

• Type of sideEffects changed from boolean | undefined to boolean | string[] | undefined (See https://github.com/velut/zod-package-json/issues/5) (Thanks @Sec-ant)
• Upgraded dependencies