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.

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

Current Tags

10.1.0 ... latest (a year ago)