Git Product home page Git Product logo

detect-package-manager's Introduction

detect-package-manager

NPM version NPM downloads CircleCI donate

How does this work?

  1. When there's yarn.lock, package-lock.json, or pnpm-lock.yaml in current working directory, it will skip other operations and directly resolve yarn, npm, or pnpm.
  2. When there's no lockfile found, it checks if yarn and pnpm command exists. If so, it resolves yarn or pnpm 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'
  })

API

detect([opts])

  • Arguments:
    • opts.cwd: string Optional, defaults to ., the directory to look up yarn.lock, package-lock.json, or pnpm-lock.yaml.
  • Returns: Promise<PM>

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

getNpmVersion([pm])

  • Arguments:
    • pm: string Optional, defaults to npm, could be npm, yarn, or pnpm
  • 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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.