History

Cyryl Płotnicki 2f946d6200 Add .vscode		2016-09-11 10:29:13 +02:00
..
index.js	Add .vscode	2016-09-11 10:29:13 +02:00
license	Add .vscode	2016-09-11 10:29:13 +02:00
package.json	Add .vscode	2016-09-11 10:29:13 +02:00
readme.md	Add .vscode	2016-09-11 10:29:13 +02:00

readme.md

read-pkg-up

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