mirror of
https://github.com/thangisme/notes.git
synced 2024-09-07 06:14:24 -04:00
.. | ||
index.js | ||
license | ||
package.json | ||
readme.md |
read-pkg-up ![Build Status](https://travis-ci.org/sindresorhus/read-pkg-up.svg?branch=master)
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 --save read-pkg-up
Usage
var readPkgUp = require('read-pkg-up');
readPkgUp().then(function (result) {
console.log(result);
/*
{
pkg: {
name: 'awesome-package',
version: '1.0.0',
...
},
path: '/Users/sindresorhus/dev/awesome-package'
}
*/
});
API
readPkgUp([options])
Returns a promise that resolves to a result object.
readPkgUp.sync([options])
Returns a result object.
options
cwd
Type: string
Default: .
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
- find-up - Find a file by walking up parent directories
- pkg-conf - Get namespaced config from the closest package.json
License
MIT © Sindre Sorhus