You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1.7 KiB

Raw Blame History

read-pkg-up

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.

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

1.7 KiB Raw Blame History