egoist / get-npm-client

Get npm client for a project.

get-npm-client

How does it work

• Check if yarn.lock exists in the directory, yes then it's using yarn
• Check if package-lock.json exists in the directory, yes then it's using npm
• None of above is fulfilled, then the npm version is <=3, a.k.a. npm-legacy

Install

yarn add get-npm-client

Usage

const getNpmClient = require('get-npm-client')

// async method
getNpmClient()
  .then(npmClient => {
    console.log(npmClient) //=> "npm" or "yarn" or "npm-legacy"
    // result is cached by path
  })

// sync method
const npmClient = getNpmClient.sync()

// specify cwd
getNpmClient('../that/project')

API

getNpmClient(cwd?)

cwd

Type: string
Default: process.cwd()

getNpmClient.sync(cwd?)

Like getNpmClient but sync.

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

get-npm-client © egoist, Released under the MIT License.
Authored and maintained by egoist with help from contributors (list).

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

get-npm-client's Issues

Always return "npm" when yarn.lock is not found

Maybe we can already ignore the use of npm 3 or lower.