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

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

    2.0.0 • Public • Published

    read-pkg-up Build Status

    Read the closest package.json file

    Why

    Install

    $ npm install --save read-pkg-up
    

    Usage

    const readPkgUp = require('read-pkg-up');
     
    readPkgUp().then(result => {
        console.log(result);
        /*
        {
            pkg: {
                name: 'awesome-package',
                version: '1.0.0',
                ...
            },
            path: '/Users/sindresorhus/dev/awesome-package/package.json'
        }
        */
    });

    API

    readPkgUp([options])

    Returns a Promise for the result object.

    readPkgUp.sync([options])

    Returns the result object.

    options

    cwd

    Type: string
    Default: .

    Directory to start looking for a package.json file.

    normalize

    Type: boolean
    Default: true

    Normalize the package data.

    Related

    • read-pkg - Read a package.json file
    • pkg-up - Find the closest package.json file
    • find-up - Find a file by walking up parent directories
    • pkg-conf - Get namespaced config from the closest package.json

    License

    MIT © Sindre Sorhus