You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
rosh 459aece669 first commit 4 years ago
..
index.js first commit 4 years ago
license first commit 4 years ago
package.json first commit 4 years ago
readme.md first commit 4 years ago

readme.md

read-pkg Build Status

Read a package.json file

Why

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.

License

MIT © Sindre Sorhus