Miss any of our Open RFC calls?Watch the recordings here! »

read-pkg-up

7.0.1 • Public • Published

read-pkg-up Build Status

Read the closest package.json file

Why

Install

$ npm install read-pkg-up

Usage

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

API

readPkgUp(options?)

Returns a Promise<object> or Promise<undefined> if no package.json was found.

readPkgUp.sync(options?)

Returns the result object or undefined if no package.json was found.

options

Type: object

cwd

Type: string
Default: process.cwd()

Directory to start looking for a package.json file.

normalize

Type: boolean
Default: true

Normalize the package data.

read-pkg-up for enterprise

Available as part of the Tidelift Subscription.

The maintainers of read-pkg-up and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

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

Install

npm i read-pkg-up

DownloadsWeekly Downloads

26,376,125

Version

7.0.1

License

MIT

Unpacked Size

6.73 kB

Total Files

5

Last publish

Collaborators

  • avatar