Methods

async() → {function}

run-context.js, line 79

Hold the execution until the returned callback is triggered

Returns:

function -

Callback to notify the normal execution can resume

build() → {RunContext}

run-context.js, line 180

Build the generator and the environment.

Returns:

RunContext -

this

catch() → {Promise}

run-context.js, line 243

Promise .catch() duck typing

Returns:

Promise

cd(dirPath) → {this}

run-context.js, line 298

Change directory without deleting directory content.

Parameters:

Name	Type	Description
dirPath	String	Directory path (relative to CWD). Prefer passing an absolute file path for predictable results

Returns:

this -

run context instance

cleanTestDirectory()

run-context.js, line 354

Clean the directory used for tests inside inDir/inTmpDir

doInDir(cbopt) → {this}

run-context.js, line 287

Register an callback to prepare the destination folder.

Parameters:

Name	Type	Attributes	Description
cb	function	<optional>	callback who'll receive the folder path as argument

Returns:

this -

run context instance

inDir(dirPath, cbopt) → {this}

run-context.js, line 275

Clean the provided directory, then change directory into it

Parameters:

Name	Type	Attributes	Description
dirPath	String		Directory path (relative to CWD). Prefer passing an absolute file path for predictable results
cb	function	<optional>	callback who'll receive the folder path as argument

Returns:

this -

run context instance

inTmpDir(cbopt) → {this}

run-context.js, line 320

Cleanup a temporary directy and change the CWD into it

This method is called automatically when creating a RunContext. Only use it if you need to use the callback.

Parameters:

Name	Type	Attributes	Description
cb	function	<optional>	callback who'll receive the folder path as argument

Returns:

this -

run context instance

run() → {Promise}

run-context.js, line 192

Run the generator on the environment and returns the promise.

Returns:

Promise -

Promise

then() → {Promise}

run-context.js, line 234

Promise .then() duck typing

Returns:

Promise

toPromise() → {Promise}

run-context.js, line 212

Return a promise representing the generator run process

Returns:

Promise -

Promise resolved on end or rejected on error

withArguments(args) → {this}

run-context.js, line 370

Provide arguments to the run context

Parameters:

Name	Type	Description
args	String | Array	command line arguments as Array or space separated string

Returns:

this

withEnvironment(cbopt) → {this}

run-context.js, line 334

Create an environment

This method is called automatically when creating a RunContext. Only use it if you need to use the callback.

Parameters:

Name	Type	Attributes	Description
cb	function	<optional>	callback who'll receive the folder path as argument

Returns:

this -

run context instance

withGenerators(dependencies) → {this}

run-context.js, line 427

Provide dependent generators

Parameters:

Name	Type	Description
dependencies	Array	paths to the generators dependencies

Returns:

this

Example

var angular = new RunContext('../../app');
angular.withGenerators([
  '../../common',
  '../../controller',
  '../../main',
  [helpers.createDummyGenerator(), 'testacular:app']
]);
angular.on('end', function () {
  // assert something
});

withLocalConfig(localConfig) → {this}

run-context.js, line 438

Mock the local configuration with the provided config

Parameters:

Name	Type	Description
localConfig	Object	should look just like if called config.getAll()

Returns:

this

withLookups(lookupsopt) → {this}

run-context.js, line 345

Run lookup on the environment.

Parameters:

Name	Type	Attributes	Description
lookups	Object | Array	<optional>	lookup to run.

Returns:

this -

run context instance.

withOptions(options) → {this}

run-context.js, line 386

Provide options to the run context

Parameters:

Name	Type	Description
options	Object	command line options (e.g. --opt-one=foo)

Returns:

this

withPrompts(answers) → {this}

run-context.js, line 404

Mock the prompt with dummy answers

Parameters:

Name	Type	Description
answers	Object	Answers to the prompt questions

Returns:

this