load-pkg

Loads package.json, by finding the first directory with a package.json, recursing up, starting with the given directory.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

1$ npm install --save load-pkg

Usage

async

By default, if no callback is passed a promise is returned.

The following examples assume the code is inside an async function:

1const load = require('load-pkg');
2
3// get the package.json from the cwd
4const pkg = await load();
5
6// specify the starting directory to search from
7const pkg = await load('foo/bar');

async callback

1const load = require('load-pkg');
2
3// get the package.json from the cwd
4load((err, pkg) => {
5  console.log(pkg); 
6});
7
8// specify the starting directory to search from
9load('foo/bar', (err, pkg) => {
10  console.log(pkg); 
11});

sync

Loads the package.json in process.cwd() by default:

1const load = require('load-pkg');
2
3// the following are equivalent
4const pkg = load.sync(process.cwd());
5const pkg = load.sync();

Specify a cwd or filepath to start from:

1const pkg = require('load-pkg').sync('a/b/c');

Release history

v3.0.0

• The main export now returns a promise if no callback is passed. There should not be any breaking changes.

v2.0.0

Breaking changes

• The main export is now a function that must be called.

About

1$ npm install && npm test

1$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• cwd: Easily get the CWD (current working directory) of a project based on package.json, optionally starting… more | homepage
• find-pkg: Find the first directory with a package.json, recursing up, starting with the given directory. Similar… more | homepage
• look-up: Faster drop-in replacement for find-up and findup-sync. | homepage

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on June 27, 2018.