Global

Methods

checkInstall(packageToCheck, isGlobal) → {boolean}

Check whether or not the given package is installed

Parameters:
Name Type Description
packageToCheck String

Name of the package to check
isGlobal boolean

Is the package supposed to be installed globally?
Source:
Returns:

Whether or not the package is installed

Type
boolean

configureDocumentation(answers)

Configure the documentation packages and gh-pages

Parameters:
Name Type Description
answers Object

Answer values from the setup questions
Source:

configureGitAlias(runner, docs, ghpages) → {Promise}

Configure the custom git script

Parameters:
Name Type Description
runner String

Selected task-runner
docs String

Selected documentation generator
ghpages String

Selected gh-pages script
Source:
Returns:

Promise object that is resolved after Inquirer and custom script creation completes

Type
Promise

configureGrunt(runner, docs, ghpages)

Configure grunt templates

Parameters:
Name Type Description
runner String

Selected task-runner
docs String

Selected documentation generator
ghpages String

Selected gh-pages script
Source:

configureGulp(runner, docs, ghpages)

Configure gulp templates

Parameters:
Name Type Description
runner String

Selected task-runner
docs String

Selected documentation generator
ghpages String

Selected gh-pages script
Source:

init(answers)

Start setup after questions have been answered

Parameters:
Name Type Description
answers Object

Answer values from the setup questions
Source:

installGrunt(answers)

Install grunt as the task-runner

Parameters:
Name Type Description
answers Object

Answer values from the setup questions
Source:

installGulp(answers)

Install gulp as the task-runner

Parameters:
Name Type Description
answers Object

Answer values from the setup questions
Source:

installPackage(packageToInstall, isGlobal, isSudo, doSave)

Install the given package

Parameters:
Name Type Description
packageToInstall String

Name of the package to install
isGlobal boolean

Should the package be installed globally?
isSudo boolean

Should the package be installed using sudo?
doSave String

Should the package be saved in package.json? ['save', 'save-dev']
Source: