read-package-up

read-package-up

Read the closest package.json file

Why

• Finds the closest package.json
• Throws more helpful JSON errors
• Normalizes the data

Install

npm install read-package-up

Usage

import {readPackageUp} from 'read-package-up';

console.log(await readPackageUp());
/*
{
	packageJson: {
		name: 'awesome-package',
		version: '1.0.0',
		…
	},
	path: '/Users/sindresorhus/dev/awesome-package/package.json'
}
*/

API

readPackageUp(options?)

Returns a Promise<object>, or Promise<undefined> if no package.json was found.

readPackageUpSync(options?)

Returns the result object, or undefined if no package.json was found.

options

Type: object

cwd

Type: URL | string
Default: process.cwd()

The directory to start looking for a package.json file.

normalize

Type: boolean
Default: true

Normalize the package data.

Related

• read-pkg - Read a package.json file
• package-up - Find the closest package.json file
• find-up - Find a file by walking up parent directories
• package-config - Get namespaced config from the closest package.json

Similar packages

Other packages similar to read-package-up

find-up

The 'find-up' package is a utility for finding a file or directory by walking up parent directories. It is more general-purpose compared to 'read-package-up' as it can be used to find any file, not just package.json. However, it requires additional steps to read and parse the package.json file.

pkg-up

The 'pkg-up' package is similar to 'read-package-up' in that it finds the closest package.json file by traversing upwards. However, it only returns the path to the package.json file and does not read its contents. You would need to use another package like 'fs' to read the file.

read-pkg

The 'read-pkg' package reads the package.json file from a specified path. Unlike 'read-package-up', it does not traverse upwards to find the closest package.json file. It is useful when you already know the exact path to the package.json file you want to read.