read-package-up

Read the closest package.json file

Why

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

Install

1npm install @smushytaco/read-package-up

Usage

1import {readPackageUp} from '@smushytaco/read-package-up';
2
3console.log(await readPackageUp());
4/*
5{
6	packageJson: {
7		name: 'awesome-package',
8		version: '1.0.0',
9		…
10	},
11	path: '/Users/sindresorhus/dev/awesome-package/package.json'
12}
13*/

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
• pkg-conf - Get namespaced config from the closest package.json