JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 60713021
  • Score
    100M100P100Q14862F
  • License MIT

Read the closest package.json file

Package Exports

  • read-pkg-up

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (read-pkg-up) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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.

  • 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