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.
1.8 KiB
1.8 KiB
read-pkg-up 
Read the closest package.json file
Why
- Finds the closest package.json
- Gracefully handles filesystem issues
- Strips UTF-8 BOM
- Throws more helpful JSON errors
- Normalizes the data
Install
$ npm install read-pkg-up
Usage
const readPkgUp = require('read-pkg-up');
(async () => {
console.log(await readPkgUp());
/*
{
pkg: {
name: 'awesome-package',
version: '1.0.0',
…
},
path: '/Users/sindresorhus/dev/awesome-package/package.json'
}
*/
})();
API
readPkgUp([options])
Returns a Promise for the result object.
readPkgUp.sync([options])
Returns the result object.
options
Type: Object
cwd
Type: string
Default: process.cwd()
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
- pkg-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
License
MIT © Sindre Sorhus