actions/install

Methods

static bowerInstall(cmpntopt, optionsopt, cbopt, spawnOptionsopt)

Receives a list of components and an options object to install through bower.

The installation will automatically run during the run loop install phase.

Parameters:
Name Type Attributes Description
cmpnt String | Array <optional>

Components to install

options Object <optional>

Options to pass to dargs as arguments

cb function <optional>
spawnOptions Object <optional>

Options to pass child_process.spawn.

static installDependencies(optionsopt)

Runs npm and bower, in sequence, in the generated directory and prints a message to let the user know.

Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Default Description
npm Boolean <optional>
true

whether to run npm install

bower Boolean <optional>
true

whether to run bower install

yarn Boolean <optional>
false

whether to run yarn install

skipMessage Boolean <optional>
false

whether to log the used commands

callback function <optional>

call once all commands have run

Example
this.installDependencies({
  bower: true,
  npm: true,
  callback: function () {
    console.log('Everything is ready!');
  }
});

static npmInstall(pkgsopt, optionsopt, cbopt, spawnOptionsopt)

Receives a list of packages and an options object to install through npm.

The installation will automatically run during the run loop install phase.

Parameters:
Name Type Attributes Description
pkgs String | Array <optional>

Packages to install

options Object <optional>

Options to pass to dargs as arguments

cb function <optional>
spawnOptions Object <optional>

Options to pass child_process.spawn.

static runInstall(installer, pathsopt, optionsopt, cbopt, spawnOptionsopt)

Combine package manager cmd line arguments and run the install command.

During the install step, every command will be scheduled to run once, on the run loop. (So don't combine the callback with this.async())

Parameters:
Name Type Attributes Description
installer String

Which package manager to use

paths String | Array <optional>

Packages to install. Use an empty string for npm install

options Object <optional>

Options to pass to dargs as arguments

cb function <optional>
spawnOptions Object <optional>

Options to pass child_process.spawn. ref https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options

static yarnInstall(pkgsopt, optionsopt, cbopt, spawnOptionsopt)

Receives a list of packages and an options object to install through npm.

The installation will automatically run during the run loop install phase.

Parameters:
Name Type Attributes Description
pkgs String | Array <optional>

Packages to install

options Object <optional>

Options to pass to dargs as arguments

cb function <optional>
spawnOptions Object <optional>

Options to pass child_process.spawn.