npmpackage.info

find-pkg-dir

Find the root directory of a Node.js project from a given path

2.0.0

ISC

JavaScript

1.29 kB

303,056 1.7

Installations

npm install find-pkg-dir

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

12.3.1

NPM Version

6.9.0 Score

65.1

Supply Chain

88.8

Quality

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

JavaScript

JavaScript (100%)

Developer

shinnn

Download Statistics

Total Downloads

303,056

Last Day

147

Last Week

538

Last Month

1,713

Last Year

30,787

GitHub Statistics

3 Stars

19 Commits

1 Forks

1 Watching

1 Branches

1 Contributors

Bundle Size

3.36 kB

Minified

1.29 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.0.0

Package Id

find-pkg-dir@2.0.0

Size

2.42 kB

NPM Version

6.9.0

Node Version

12.3.1

Publised On

31 May 2019

Total Downloads

Cumulative downloads

Total Downloads

303,056

Last day

113%

147

Compared to previous day

Last week

4.1%

538

Compared to previous week

Last month

20.5%

1,713

Compared to previous month

Last year

-42.8%

30,787

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

inspect-with-kind

Dev Dependencies

@shinnn/eslint-config coverage eslint find-pkg find-root lodash pkg-dir rmfr tape

Versions

find-pkg-dir

Find the root directory of a Node.js project from a given path

1const findPkgDir = require('find-pkg-dir');
2
3// When the /Users/shinnn/foo directory contains a package.json file:
4
5findPkgDir('/Users/shinnn/foo'); //=> '/Users/shinnn/foo'
6findPkgDir('/Users/shinnn/foo/bar'); //=> '/Users/shinnn/foo'
7findPkgDir('/Users/shinnn/foo/bar/baz'); //=> '/Users/shinnn/foo'

Unlike the prior arts,

It uses InternalModuleStat through require.resolve() as it's faster than fs.statSync().
It checks if a path is file or directory, to avoid mistaking a package.json directory as a package.json file.
It automatically resolves symbolic links.

Installation

Use npm.

npm install find-pkg-dir

API

1const findPkgDir = require('find-pkg-dir');

findPkgDir(path)

path: string (a path to start searching from)
Return: string (absolute path) or null

It finds the first directory containing a package.json file, recursively looking up, starting with the given path.

When it cannot find any package.json files finally, returns null.

1findPkgDir('path/of/non/nodejs/project'); //=> null

Benchmark

find-pkg-dir (this project):
Find from the current directory          6.514971999917179 ms/op avg.
Find from the deep directory           301.970978999976069 ms/op avg.
Resolve symlinks                         4.765490400046110 ms/op avg.
Find from the `package.json` directory  33.653173299971968 ms/op avg.

find-pkg + path.dirname():
Find from the current directory          7.597467000037431 ms/op avg.
Find from the deep directory           421.827792199980479 ms/op avg.
Resolve symlinks                               N/A (operation failed)
Find from the `package.json` directory         N/A (operation failed)

find-root:
Find from the current directory          8.991230100020767 ms/op avg.
Find from the deep directory           479.851285400055360 ms/op avg.
Resolve symlinks                               N/A (operation failed)
Find from the `package.json` directory         N/A (operation failed)

pkg-dir:
Find from the current directory          9.322520200069993 ms/op avg.
Find from the deep directory           505.923578500002634 ms/op avg.
Resolve symlinks                               N/A (operation failed)
Find from the `package.json` directory         N/A (operation failed)

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to find-pkg-dir

pkg-dir

8.0.0

Find the root directory of a Node.js project or npm package

@visulima/package

3.4.6

One Package to rule them all, finds your root-dir, monorepo, or package manager.

top-pkg-dir

0.0.3

Find top most root directory of a Node.js project or npm package.

root-pkg-dir

1.0.0

Find the highest directory with a package.json, starting from from the current working directory.