Skip to content

Detect which package manager you're using (yarn or pnpm or npm)

License

Notifications You must be signed in to change notification settings

ndelangen/detect-package-manager

 
 

Repository files navigation

detect-package-manager

NPM version NPM downloads CircleCI donate

How does this work?

  1. When there's yarn.lock, package-lock.json, pnpm-lock.yaml, or bun.lockb in current working directory, it will skip other operations and directly resolve yarn, npm, pnpm, or bun.
  2. When there's no lockfile found, it checks if yarn, pnpm, or bun command exists. If so, it resolves yarn, pnpm, or bun otherwise npm.
  3. Results are cached.

Install

yarn add detect-package-manager

Usage

const { detect } = require("detect-package-manager");

detect().then((pm) => {
  console.log(pm);
  //=> 'yarn', 'npm', or 'pnpm', 'bun'
});

API

detect([opts])

  • Arguments:
    • opts.cwd: string Optional, defaults to ., the directory to look up yarn.lock, package-lock.json, or pnpm-lock.yaml.
    • opts.includeGlobalBun: boolean Optional, defaults to false, whether to check if bun exists in PATH.
  • Returns: Promise<PM>

It returns a Promise resolving the name of package manager, could be npm, yarn, or pnpm, bun.

getNpmVersion([pm])

  • Arguments:
    • pm: string Optional, defaults to npm, could be npm, yarn, or pnpm, bun
  • Returns: Promise<string>

It returns a Promise resolving the version of npm or the package manager you specified.

clearCache()

  • Returns: void

Clear cache.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

detect-package-manager © EGOIST, Released under the MIT License.
Authored and maintained by EGOIST with help from contributors (list).

github.com/egoist · GitHub @EGOIST · Twitter @_egoistlily

About

Detect which package manager you're using (yarn or pnpm or npm)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 100.0%