Big news!Introducing Socket AI - ChatGPT-Powered Threat Analysis.Learn more
Socket
Socket

read-pkg-up

Package Overview
Dependencies
3
Maintainers
1
Versions
11
Issues
File Explorer

Advanced tools

read-pkg-up

Read the closest package.json file

    9.1.0latest
    GitHub
    npm

Version published
Maintainers
1
Weekly downloads
32,679,699
decreased by-4.73%

Weekly downloads

Readme

Source

read-pkg-up

Read the closest package.json file

Why

  • Finds the closest package.json
  • Throws more helpful JSON errors
  • Normalizes the data

Install

npm install read-pkg-up

Usage

import {readPackageUp} from 'read-pkg-up'; console.log(await readPackageUp()); /* { packageJson: { name: 'awesome-package', version: '1.0.0', … }, path: '/Users/sindresorhus/dev/awesome-package/package.json' } */

API

readPackageUp(options?)

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

readPackageUpSync(options?)

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

options

Type: object

cwd

Type: URL | string
Default: process.cwd()

The 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

Keywords

FAQs

Last updated on 08 Feb 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
Socket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc