Read a package.json file

• Throws more helpful JSON errors
• Normalizes the data

npm install read-pkg

import {readPackage} from 'read-pkg';

console.log(await readPackage());
//=> {name: 'read-pkg', …}

console.log(await readPackage({cwd: 'some-other-directory'}));
//=> {name: 'unicorn', …}

Returns a Promise<object> with the parsed JSON.

Returns the parsed JSON.

Type: object

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

Current working directory.

Type: boolean
Default: true

Normalize the package data.

Parses an object or string into JSON.

Type: object | string

An object or a stringified object to be parsed as a package.json.

Type: object

Type: boolean
Default: true

Normalize the package data.

• read-package-up - Read the closest package.json file
• write-package - Write a package.json file
• load-json-file - Read and parse a JSON file