read-pkg-up

read-pkg-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-pkg-up

Usage

import {readPackageUp} from 'read-pkg-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
• pkg-up - Find the closest package.json file
• find-up - Find a file by walking up parent directories
• pkg-conf - Get namespaced config from the closest package.json

Similar packages

Other packages similar to read-pkg-up

read-pkg

read-pkg is similar to read-pkg-up but does not search upwards from the current directory. It simply reads the package.json file from the specified directory or the current directory if no directory is specified. It is less flexible when you need to find package.json files in parent directories.

pkg-up

pkg-up is another package that finds the closest package.json file by searching upwards from a given directory. It is similar to read-pkg-up but does not read or parse the package.json file, it only returns the path to it. This package is useful if you only need the path and not the contents.

find-up

find-up is a more general tool that can be used to find files or directories by searching upwards from a given directory. While it is not limited to package.json files, it can be used for a similar purpose as read-pkg-up. However, it requires additional work to read and parse the package.json file after finding it.