Wondering what’s next for npm?Check out our public roadmap! »

    pkg-dir
    TypeScript icon, indicating that this package has built-in type declarations

    5.0.0 • Public • Published

    pkg-dir Build Status

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

    Install

    $ npm install pkg-dir
    

    Usage

    /
    └── Users
        └── sindresorhus
            └── foo
                ├── package.json
                └── bar
                    ├── baz
                    └── example.js
    
    // example.js
    const pkgDir = require('pkg-dir');
     
    (async () => {
        const rootDir = await pkgDir(__dirname);
     
        console.log(rootDir);
        //=> '/Users/sindresorhus/foo'
    })();

    API

    pkgDir(cwd?)

    Returns a Promise for either the project root path or undefined if it couldn't be found.

    pkgDir.sync(cwd?)

    Returns the project root path or undefined if it couldn't be found.

    cwd

    Type: string
    Default: process.cwd()

    Directory to start from.

    Related

    • pkg-dir-cli - CLI for this module
    • pkg-up - Find the closest package.json file
    • find-up - Find a file by walking up parent directories

    Get professional support for this package with a Tidelift subscription
    Tidelift helps make open source sustainable for maintainers while giving companies
    assurances about security, maintenance, and licensing for their dependencies.

    Install

    npm i pkg-dir

    DownloadsWeekly Downloads

    42,135,693

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    4.98 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar