odin-default-js-exercises/node_modules/read-pkg-up
Cody Loyd 834d78b8b2 remove timer and simon 2017-12-15 12:56:14 -06:00
..
node_modules/find-up remove timer and simon 2017-12-15 12:56:14 -06:00
index.js remove timer and simon 2017-12-15 12:56:14 -06:00
license remove timer and simon 2017-12-15 12:56:14 -06:00
package.json remove timer and simon 2017-12-15 12:56:14 -06:00
readme.md remove timer and simon 2017-12-15 12:56:14 -06:00

readme.md

read-pkg-up Build Status

Read the closest package.json file

Why

Install

$ npm install --save read-pkg-up

Usage

const readPkgUp = require('read-pkg-up');

readPkgUp().then(result => {
	console.log(result);
	/*
	{
		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

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
  • 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