read-pkg

Read a package.json file

Why

• Gracefully handles filesystem issues
• Throws more helpful JSON errors
• Normalizes the data

Install

$ npm install read-pkg

Usage

const readPkg = require('read-pkg');

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

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

API

readPkg(options?)

Returns a Promise<object> with the parsed JSON.

readPkg.sync(options?)

Returns the parsed JSON.

options

Type: object

cwd

Type: string
Default: process.cwd()

Current working directory.

normalize

Type: boolean
Default: true

Normalize the package data.

Related

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

---