Skip to content

Programmatically install npm packages and corresponding peerDependencies.

License

Notifications You must be signed in to change notification settings

egoist/install-packages

Repository files navigation

install-packages NPM version NPM downloads Build Status

Programmatically install npm packages.

This is used by webpack-proxy, here's a preview:

preview

Install

yarn add install-packages

Usage

const install = require('install-packages')

install({
  packages: ['webpack', 'mocha']
})
//=> Promise

API

install(options)

options

packages

Type: string[]

You can omit this to install dependencies from package.json.

cwd

Type: string
Default: process.cwd()

The directory to install packages.

installPeers

Type: boolean
Default: true

Install peer dependencies for corresponding dependency.

peerFilter

Type: (name: string, version: string) => boolean

A function to filter peerDependencies, return true to install it, false otherwise.

saveDev

Type: boolean
Default: false

Install as dev dependencies.

packageManager

Type: string
Possible values: npm yarn

By default we automatically detect package manager.

install.determinePackageManager([cwd])

Determine package manager for specifc directory.

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

License

MIT © EGOIST

About

Programmatically install npm packages and corresponding peerDependencies.

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published