sindresorhus

read-pkg

import * as normalize from 'normalize-package-data';

	[Normalize](https://github.com/npm/normalize-package-data#what-normalization-currently-entails) the package data.

export interface NormalizeOptions extends Options {

export type NormalizedPackageJson = PackageJson & normalize.Package;

export type PackageJson = typeFest.PackageJson;

console.log(await readPackage({cwd: 'some-other-directory'});

export function readPackage(options?: NormalizeOptions): Promise<NormalizedPackageJson>;

export function readPackage(options: Options): Promise<PackageJson>;

import {readPackageSync} from 'read-pkg';

console.log(readPackageSync({cwd: 'some-other-directory'});

export function readPackageSync(options?: NormalizeOptions): NormalizedPackageJson;

export function readPackageSync(options: Options): PackageJson;

import fs, {promises as fsPromises} from 'node:fs';

import normalizePackageData from 'normalize-package-data';

export async function readPackage({cwd = process.cwd(), normalize = true} = {}) {

const toPath = urlOrPath => urlOrPath instanceof URL ? fileURLToPath(urlOrPath) : urlOrPath;

export async function readPackage({cwd, normalize = true} = {}) {

	const filePath = path.resolve(cwd, 'package.json');

	const json = parseJson(await fsPromises.readFile(filePath, 'utf8'));

export function readPackageSync({cwd = process.cwd(), normalize = true} = {}) {

export function readPackageSync({cwd, normalize = true} = {}) {

	const json = parseJson(fs.readFileSync(filePath, 'utf8'));

	"description": "Read a package.json file",

	"funding": "https://github.com/sponsors/sindresorhus",

		"@types/normalize-package-data": "^2.4.1",

- [Throws more helpful JSON errors](https://github.com/sindresorhus/parse-json)

- [Normalizes the data](https://github.com/npm/normalize-package-data#what-normalization-currently-entails)

console.log(await readPackage({cwd: 'some-other-directory'}));

Returns a `Promise<object>` with the parsed JSON.

[Normalize](https://github.com/npm/normalize-package-data#what-normalization-currently-entails) the package data.

- [read-pkg-up](https://github.com/sindresorhus/read-pkg-up) - Read the closest package.json file

- [write-pkg](https://github.com/sindresorhus/write-pkg) - Write a `package.json` file

- [load-json-file](https://github.com/sindresorhus/load-json-file) - Read and parse a JSON file

		<a href="https://tidelift.com/subscription/pkg/npm-read-pkg?utm_source=npm-read-pkg&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>

		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.

		@@ -10,3 +10,3 @@ import * as typeFest from 'type-fest';
		*/
		readonly cwd?: string;
		readonly cwd?: URL \| string;

		@@ -13,0 +13,0 @@ /**

		{
		"name": "read-pkg",
		"version": "7.0.0",
		"version": "7.1.0",
		"description": "Read a package.json file",
		@@ -5,0 +5,0 @@ "license": "MIT",

		@@ -44,3 +44,3 @@ # read-pkg

		Type: `string`\
		Type: `URL \| string`\
		Default: `process.cwd()`
		@@ -47,0 +47,0 @@

		import process from 'node:process';
		import fs, {promises as fsPromises} from 'node:fs';
		import path from 'node:path';
		import {fileURLToPath} from 'node:url';
		import parseJson from 'parse-json';
		import normalizePackageData from 'normalize-package-data';

		export async function readPackage({cwd = process.cwd(), normalize = true} = {}) {
		const toPath = urlOrPath => urlOrPath instanceof URL ? fileURLToPath(urlOrPath) : urlOrPath;

		export async function readPackage({cwd, normalize = true} = {}) {
		cwd = toPath(cwd) \|\| process.cwd();
		const filePath = path.resolve(cwd, 'package.json');
		@@ -18,3 +22,4 @@ const json = parseJson(await fsPromises.readFile(filePath, 'utf8'));

		export function readPackageSync({cwd = process.cwd(), normalize = true} = {}) {
		export function readPackageSync({cwd, normalize = true} = {}) {
		cwd = toPath(cwd) \|\| process.cwd();
		const filePath = path.resolve(cwd, 'package.json');
		@@ -21,0 +26,0 @@ const json = parseJson(fs.readFileSync(filePath, 'utf8'));

Improved metrics