FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

sindresorhus/package-directory: Find the root directory of a Node.js project or npm package · GitHub

package-directory

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

Install

npm install package-directory

Usage

/
└── Users
    └── sindresorhus
        └── foo
            ├── package.json
            └── bar
                ├── baz
                └── example.js
// example.js
import {packageDirectory} from 'package-directory';

console.log(await packageDirectory());
//=> '/Users/sindresorhus/foo'

API

packageDirectory(option?)

Returns a Promise for either the project root path or undefined if it could not be found.

packageDirectorySync(options?)

Returns the project root path or undefined if it could not be found.

options

Type: object

cwd

Type: string
Default: process.cwd()

The directory to start searching from.

ignoreTypeOnlyPackageJson

Type: boolean
Default: false

Ignore package.json files that only contain the type field.

This treats {"type":"module"} files as ESM scope markers instead of package roots.

Related

About

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

Resources

Code of conduct

Contributing

Security policy

Stars

254 stars

Watchers

5 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages


Back | FazBrowse Home | New Git URL