https://github.com/jonschlinkert/find-pkg
Find the first directory with a package.json, recursing up, starting with the given directory. Similar to look-up but does not support globs and only searches for package.json. Async and sync.
https://github.com/jonschlinkert/find-pkg
file filepath find find-pkg-up find-up findup javascript jonschlinkert node nodejs package packagejson pkg resolve
Last synced: 5 months ago
JSON representation
Find the first directory with a package.json, recursing up, starting with the given directory. Similar to look-up but does not support globs and only searches for package.json. Async and sync.
- Host: GitHub
- URL: https://github.com/jonschlinkert/find-pkg
- Owner: jonschlinkert
- License: mit
- Created: 2015-11-28T03:09:51.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-03-28T05:59:37.000Z (over 7 years ago)
- Last Synced: 2025-03-31T10:51:25.426Z (7 months ago)
- Topics: file, filepath, find, find-pkg-up, find-up, findup, javascript, jonschlinkert, node, nodejs, package, packagejson, pkg, resolve
- Language: JavaScript
- Size: 17.6 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# find-pkg [](https://www.npmjs.com/package/find-pkg) [](https://npmjs.org/package/find-pkg) [](https://npmjs.org/package/find-pkg) [](https://travis-ci.org/jonschlinkert/find-pkg)
> Find the first directory with a package.json, recursing up, starting with the given directory. Similar to look-up but does not support globs and only searches for package.json. Async and sync.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save find-pkg
```
## Usage
```js
const findPkg = require('find-pkg');
```
**promise**
```js
findPkg('a/b/c/some/path')
.then(file => console.log(file)) //=> /User/jonschlinkert/dev/a/b/package.json
.catch(console.error);
```
**async-await**
```js
(async function() {
const file = await findPkg('a/b/c/some/path');
console.log(file);
//=> '/Users/jonschlinkert/dev/a/b/package.json'
})();
```
**callback**
```js
findPkg('a/b/c/some/path', function(err, file) {
if (err) throw err;
console.log(file);
//=> '/Users/jonschlinkert/dev/a/b/package.json'
});
```
**sync**
```js
const file = findPkg.sync('a/b/c/some/path');
//=> '/Users/jonschlinkert/dev/a/b/package.json'
```
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [find-file-up](https://www.npmjs.com/package/find-file-up): Find a file fast, by starting at the given cwd and recursing up one directory… [more](https://github.com/jonschlinkert/find-file-up) | [homepage](https://github.com/jonschlinkert/find-file-up "Find a file fast, by starting at the given cwd and recursing up one directory until the file is found or we run out of directories.")
* [findup-sync](https://www.npmjs.com/package/findup-sync): Find the first file matching a given pattern in the current directory or the nearest… [more](https://github.com/js-cli/node-findup-sync#readme) | [homepage](https://github.com/js-cli/node-findup-sync#readme "Find the first file matching a given pattern in the current directory or the nearest ancestor directory.")
* [global-modules](https://www.npmjs.com/package/global-modules): The directory used by npm for globally installed npm modules. | [homepage](https://github.com/jonschlinkert/global-modules "The directory used by npm for globally installed npm modules.")
### Author
**Jon Schlinkert**
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on March 28, 2018._