@tybys/find-npm-prefix
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

find-npm-prefix

Find the npm project directory associated with for a given directory

USAGE

const { findPrefix, findPrefixSync } = require('find-npm-prefix')

// sync
const prefix = findPrefixSync(process.cwd())

// async
findPrefix(process.cwd()).then(prefix => {
  // ...
})

findPrefix(dir: string): Promise<string>

This computes the npm prefix, that is, the directory that npm adds and removes modules from for a given path.

It takes a directory as an argument and returns a promise of the associated prefix directory.

findPrefixSync(dir: string): string

Sync version.

Algorithm

  1. If the directory is a node_modules folder, scan up the tree till you find a non-node_modules directory and return that.
  2. Else, look for the first parent directory that contains a node_modules or a package.json
  3. If one is found, that's the prefix.
  4. If none are found, return the original directory we were given

Readme

Keywords

none

Package Sidebar

Install

npm i @tybys/find-npm-prefix

Weekly Downloads

4

Version

2.0.0

License

ISC

Unpacked Size

5.06 kB

Total Files

4

Last publish

Collaborators

  • toyobayashi