Methods

create(GeneratorOrNamespace) → {RunContext}

index.js, line 324

Prepare a run context

Parameters:

Name	Type	Description
GeneratorOrNamespace	String | function	Generator constructor or namespace

Returns:

RunContext

createDummyGenerator()

index.js, line 178

Create a simple, dummy generator

createEnv(…args) → {Object}

index.js, line 253

Shortcut to the Environment's createEnv.

Parameters:

Name	Type	Attributes	Description
args	any	<repeatable>	environment constructor arguments.

Returns:

Object -

environment instance

Use to test with specific Environment version: let createEnv; before(() => { createEnv = stub(helper, 'createEnv').callsFake(Environment.creatEnv); }); after(() => { createEnv.restore(); });

createGenerator(name, dependencies, args, options, localConfigOnlyopt)

index.js, line 207

Create a generator, using the given dependencies and controller arguments Dependecies can be path (autodiscovery) or an array [{generator}, {name}]

Parameters:

Name	Type	Attributes	Default	Description
name	String			the name of the generator
dependencies	Array			paths to the generators dependencies
args	Array | String			arguments to the generator; if String, will be split on spaces to create an Array
options	Object			configuration for the generator
localConfigOnly	Boolean	<optional>	true	passes localConfigOnly to the generators

Example

var deps = ['../../app',
             '../../common',
             '../../controller',
             '../../main',
             [createDummyGenerator(), 'testacular:app']
           ];
var angular = createGenerator('angular:app', deps);

createMockedGenerator()

index.js, line 160

Create a mocked generator

createTestEnv(envContructor, optionsopt) → {Object}

index.js, line 266

Creates a test environment.

Parameters:

Name	Type	Attributes	Description
envContructor	function		environment constructor method.
options	Object	<optional>	Options to be passed to the environment

Returns:

Object -

environment instance const env = createTestEnv(require('yeoman-environment').createEnv);

gruntfile(options, done)

index.js, line 56

Generates a new Gruntfile.js in the current working directory based on options hash passed in.

Parameters:

Name	Type	Description
options	Object	Grunt configuration
done	function	callback to call on completion

Example

before(helpers.gruntfile({
  foo: {
    bar: '<config.baz>'
  }
}));

mockLocalConfig(generator, localConfig)

index.js, line 152

Provide mocked values to the config

Parameters:

Name	Type	Description
generator	Generator	a Yeoman generator
localConfig	Object	localConfig - should look just like if called config.getAll()

mockPrompt(generator, answers, options)

index.js, line 117

Answer prompt questions for the passed-in generator

Parameters:

Name	Type	Description
generator	Generator | Environment	a Yeoman generator or environment
answers	Object	an object where keys are the generators prompt names and values are the answers to the prompt questions
options	function | Object	Options or callback

Example

mockPrompt(angular, {'bootstrap': 'Y', 'compassBoostrap': 'Y'});

registerDependencies(dependencies)

index.js, line 227

Register a list of dependent generators into the provided env. Dependecies can be path (autodiscovery) or an array [{generator}, {name}]

Parameters:

Name	Type	Description
dependencies	Array	paths to the generators dependencies

restorePrompt(generator)

index.js, line 142

Restore defaults prompts on a generator.

Parameters:

Name	Type	Description
generator	Generator | Environment	or environment

run(GeneratorOrNamespace) → {RunContext}

index.js, line 302

Run the provided Generator

Parameters:

Name	Type	Description
GeneratorOrNamespace	String | function	Generator constructor or namespace

Returns:

RunContext

setUpTestDirectory(dir) → {function}

index.js, line 32

Create a function that will clean up the test directory, cd into it, and create a dummy gruntfile inside. Intended for use as a callback for the mocha before hook.

Parameters:

Name	Type	Description
dir	String	path to the test directory

Returns:

function -

mocha callback

testDirectory(dir, cb)

index.js, line 82

Clean-up the test directory and cd into it. Call given callback after entering the test directory.

Parameters:

Name	Type	Description
dir	String	path to the test directory
cb	function	callback executed after setting working directory to dir

Example

testDirectory(path.join(__dirname, './temp'), function () {
  fs.writeFileSync('testfile', 'Roses are red.');
});