documentit/node_modules/read-pkg-up
2018-01-05 10:48:13 -08:00
..
index.js installed electron 2018-01-05 10:48:13 -08:00
license installed electron 2018-01-05 10:48:13 -08:00
package.json installed electron 2018-01-05 10:48:13 -08:00
readme.md installed electron 2018-01-05 10:48:13 -08:00

read-pkg-up Build Status

Read the closest package.json file

Why

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.

  • 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