Socket
Socket
Sign inDemoInstall

pkg-up

Package Overview
Dependencies
6
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    pkg-up

Find the closest package.json file


Version published
Maintainers
1
Install size
52.9 kB
Created

Package description

What is pkg-up?

The pkg-up npm package is used to find the closest package.json file in the directory tree, starting from a given directory. It is useful for Node.js projects where you need to locate the package.json file of the current project or a related package.

What are pkg-up's main functionalities?

Find the closest package.json

This feature allows you to asynchronously find the nearest package.json file from the current directory.

const pkgUp = require('pkg-up');

(async () => {
  const filePath = await pkgUp();
  console.log(filePath);
  //=> '/Users/sindresorhus/foo/package.json'
})();

Find the closest package.json synchronously

This feature provides a synchronous method to find the nearest package.json file.

const pkgUp = require('pkg-up');

const filePath = pkgUp.sync();
console.log(filePath);
//=> '/Users/sindresorhus/foo/package.json'

Find package.json from a specific directory

This feature allows you to find the nearest package.json file starting from a specific directory.

const pkgUp = require('pkg-up');

(async () => {
  const filePath = await pkgUp({cwd: 'some/subdirectory'});
  console.log(filePath);
  //=> '/Users/sindresorhus/foo/package.json'
})();

Other packages similar to pkg-up

Readme

Source

pkg-up

Find the closest package.json file

Install

npm install pkg-up

Usage

/
└── Users
    └── sindresorhus
        └── foo
            ├── package.json
            └── bar
                ├── baz
                └── example.js
// example.js
import {pkgUp} from 'pkg-up';

console.log(await pkgUp());
//=> '/Users/sindresorhus/foo/package.json'

API

pkgUp(options?)

Returns a Promise<string> for the file path, or Promise<undefined> if it could not be found.

pkgUpSync(options?)

Returns the file path, or undefined if it could not be found.

options

Type: object

cwd

Type: string
Default: process.cwd()

The directory to start from.

  • read-pkg-up - Read the closest package.json file
  • pkg-dir - Find the root directory of an npm package
  • find-up - Find a file by walking up parent directories

Keywords

FAQs

Last updated on 04 Nov 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • 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