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.
2.3 KiB
2.3 KiB
read-pkg-up 
Read the closest package.json file
Why
- Finds the closest package.json
- Gracefully handles filesystem issues
- 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());
/*
{
packageJson: {
name: 'awesome-package',
version: '1.0.0',
…
},
path: '/Users/sindresorhus/dev/awesome-package/package.json'
}
*/
})();
API
readPkgUp(options?)
Returns a Promise<object> or Promise<undefined> if no package.json was found.
readPkgUp.sync(options?)
Returns the result object or undefined if no package.json was found.
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.
read-pkg-up for enterprise
Available as part of the Tidelift Subscription.
The maintainers of read-pkg-up and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.