packageDir

Type:Function
Status:beta
Since:1.0.0
Platform:node
@blackbyte.sugar.node.package

This function simply take a package name as parameter, and return the corresponding package direcory path

Params

  1. nameOrPath”process.cwd()“String

    the package name or path wanted

  2. settings{}TPackageDirSettings

    Some settings to configure your process

Return

  1. -String

    The package path

Example

import { packageDir } from '@blackbyte/sugar/package`;
packageDir('lodash');

Settings

  1. cwdprocess.cwd()String

    The directory in which you want to start the research

  2. monorepofalseBoolean

    Specify if you are in a monorepo context

  3. checkExistencetrueBoolean

    Specify if you want to check if the vendor dir exists

Todo

  • Implement a cache strategy to avoid making same process again and againnormal