read-pkg

Read a package.json file

Why

Gracefully handles filesystem issues
Strips UTF-8 BOM
Throws more helpful JSON errors
Normalizes the data

Install

$ npm install read-pkg

Usage

const readPkg = require('read-pkg');
readPkg().then(pkg => {
console.log(pkg);
//=> {name: 'read-pkg', ...}
});
readPkg(__dirname).then(pkg => {
console.log(pkg);
//=> {name: 'read-pkg', ...}
});
readPkg(path.join('unicorn', 'package.json')).then(pkg => {
console.log(pkg);
//=> {name: 'read-pkg', ...}
});

API

readPkg([path], [options])

Returns a Promise for the parsed JSON.

readPkg.sync([path], [options])

Returns the parsed JSON.

path

Type: string
Default: process.cwd()

Path to a package.json file or its directory.

options

normalize

Type: boolean
Default: true

Normalize the package data.

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

1.6 KiB Raw Blame History