Extends the base-npm plugin with prompts for intalling dependencies as a part of a build-workflow.
Install
Install with npm:
$ npm install base-npm-prompt --save
Usage
var prompt = ;var npm ;var Base = ;var app = ; // register the `base-npm` plugin firstapp; // register the `base-npm-prompt` pluginapp;
Note that if you use base directly you will also need to let the plugin know that it is being registered on a Base "application" (since Base
can be used to create anything, like views
, collections
etc.).
var Base = ;var app = isApp: true; // <=var prompt = ;var npm = ; // register the `base-npm` plugin firstapp; // register the `base-npm-prompt` pluginapp; appnpmprompt'dependencies' { if err return ; appnpmprompt'devDependencies' cb;};
API
.npm.prompt
Prompts the user to ask if they want to install the packages listed on app.cache.install.dependencies
or app.cache.install.devDependencies
based on the given type
.
Params
type
{String}: dependency type to install (dependencies or devDependencies)options
{Object}cb
{Function}: Callback
Example
appnpmprompt'dependencies' { if err return console:};
.npm.askInstall
Prompts the user to ask if they want to install the given package(s). Requires the base-questions plugin to be registered first.
Params
names
{String|Array}: One or more package names.options
{Object}cb
{Function}: Callback
Example
appnpm;
.npm.checkInstall
Prompts the user to ask if they want to check if the given package(s) exist on npm, then install the ones that do exist. Requires the base-questions plugin to be registered first.
Params
names
{String|Array}: One or more package names.options
{Object}cb
{Function}: Callback
Example
appnpm;
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs
Generate readme and API documentation with verb:
$ npm install verb && npm run docs
Or, if verb is installed globally:
$ verb
Running tests
Install dev dependencies:
$ npm install -d && npm test
Author
Jon Schlinkert
License
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb, v0.9.0, on June 16, 2016.