Members

static util

environment.js, line 1305

Expose the utilities on the module

See:

• env/util

Methods

static createEnv(optionsopt, adapteropt) → {Environment}

environment.js, line 183

Factory method to create an environment instance. Take same parameters as the Environment constructor.

Parameters:

Name	Type	Attributes	Description
options	object	<optional>	Environment options.
adapter	Adapter	<optional>	Terminal adapter.

Returns:

Environment -

a new Environment instance

Deprecated:

• @param {string[]} [args] - arguments.

async, static createEnvWithVersion(version, …args) → {Environment}

environment.js, line 199

Factory method to create an environment instance. Take same parameters as the Environment constructor.

Parameters:

Name	Type	Attributes	Description
version	String		Version of the Environment
args	any	<repeatable>	Same arguments as Environment#createEnv.

Returns:

Environment -

a new Environment instance

static enforceUpdate(env) → {Environment}

environment.js, line 115

Make sure the Environment present expected methods if an old version is passed to a Generator.

Parameters:

Name	Type	Description
env	Environment

Returns:

Environment -

The updated env

static lookupGenerator(namespace, optionsopt) → {String}

environment.js, line 231

Lookup for a specific generator.

Parameters:

Name	Type	Attributes	Description
namespace	String
options	Object	<optional>	Properties Name Type Attributes Default Description localOnly Boolean <optional> false Set true to skip lookups of globally-installed generators. packagePath Boolean <optional> false Set true to return the package path instead of generators file. singleResult Boolean <optional> true Set false to return multiple values.

Returns:

String -

generator

static namespaceToName(namespace) → {String}

environment.js, line 215

Convert a generators namespace to its name

Parameters:

Name	Type	Description
namespace	String

Returns:

String

static prepareCommand(GeneratorClass) → {Command}

environment.js, line 141

Prepare a commander instance for cli support.

Parameters:

Name	Type	Description
GeneratorClass	Class	Generator to create Command

Returns:

Command -

Return a Command instance

static prepareGeneratorCommand(command, GeneratorClass) → {Command}

environment.js, line 153

Prepare a commander instance for cli support.

Parameters:

Name	Type	Description
command	Command	Command to be prepared
GeneratorClass	Class	Generator to create Command

Returns:

Command -

return command

alias(match, value)

resolver.js, line 400

Get or create an alias.

Alias allows the get() and lookup() methods to search in alternate filepath for a given namespaces. It's used for example to map generator-* npm package to their namespace equivalent (without the generator- prefix), or to default a single namespace like angular to angular:app or angular:all.

Given a single argument, this method acts as a getter. When both name and value are provided, acts as a setter and registers that new alias.

If multiple alias are defined, then the replacement is recursive, replacing each alias in reverse order.

An alias can be a single String or a Regular Expression. The finding is done based on .match().

Parameters:

Name	Type	Description
match	String | RegExp
value	String

Mixes In:

• env/resolver.alias

Example

env.alias(/^([a-zA-Z0-9:\*]+)$/, 'generator-$1');
    env.alias(/^([^:]+)$/, '$1:app');
    env.alias(/^([^:]+)$/, '$1:all');
    env.alias('foo');
    // => generator-foo:all

applyTransforms(transformStreams, streamopt) → {Promise}

environment.js, line 1181

Apply transform streams to file in MemFs.

Parameters:

Name	Type	Attributes	Description
transformStreams	Array.<Transform>		transform streams to be applied.
stream	Stream	<optional>	files stream, defaults to this.sharedFs.stream().

Returns:

Promise

commitSharedFs(streamopt) → {Promise}

environment.js, line 1221

Commits the MemFs to the disc.

Parameters:

Name	Type	Attributes	Description
stream	Stream	<optional>	files stream, defaults to this.sharedFs.stream().

Returns:

Promise

composeWith(namespaceOrPath, argsopt, optionsopt, scheduleopt) → {Generator}

environment.js, line 818

Compose with the generator.

Parameters:

Name	Type	Attributes	Description
namespaceOrPath	String
args	Array	<optional>
options	Object	<optional>
schedule	Boolean	<optional>

Returns:

Generator -

The instantiated generator or the singleton instance.

create(namespaceOrPath, argsopt, optionsopt) → {Generator}

environment.js, line 718

Create is the Generator factory. It takes a namespace to lookup and optional hash of options, that lets you define arguments and options to instantiate the generator with.

An error is raised on invalid namespace.

Parameters:

Name	Type	Attributes	Description
namespaceOrPath	String
args	Array	<optional>
options	Object	<optional>

Returns:

Generator -

The instantiated generator

error(err) → {Error}

environment.js, line 399

Parameters:

Name	Type	Description
err	Object

Returns:

Error -

err

Deprecated:

• Error handler taking `err` instance of Error. The `error` event is emitted with the error object, if no `error` listener is registered, then we throw the error.

get(namespaceOrPath) → {Generator|null}

environment.js, line 613

Get a single generator from the registered list of generators. The lookup is based on generator's namespace, "walking up" the namespaces until a matching is found. Eg. if an angular:common namespace is registered, and we try to get angular:common:all then we get angular:common as a fallback (unless an angular:common:all generator is registered).

Parameters:

Name	Type	Description
namespaceOrPath	String

Returns:

Generator | null -

• the generator registered under the namespace

getByPath(path) → {Generator|null}

environment.js, line 658

Get a generator by path instead of namespace.

Parameters:

Name	Type	Description
path	String

Returns:

Generator | null -

• the generator found at the location

getGeneratorNames() → {Array}

environment.js, line 554

Get registered generators names

Returns:

Array

getGeneratorsMeta() → {Object}

environment.js, line 545

Returns stored generators meta

Returns:

Object

getNpmPaths(optionsopt) → {Array}

resolver.js, line 241

Get the npm lookup directories (node_modules/)

Parameters:

Name	Type	Attributes	Description
options	boolean | Object	<optional>	Properties Name Type Attributes Default Description localOnly boolean <optional> false Set true to skip lookups of globally-installed generators. filterPaths boolean <optional> false Remove paths that don't ends with a supported path (don't touch at NODE_PATH paths).

Returns:

Array -

lookup paths

Mixes In:

• env/resolver.getNpmPaths

Deprecated:

• Yes

getPackagePath(namespace) → {String}

environment.js, line 583

Get last added path for a namespace

Parameters:

Name	Type	Description
namespace	String	namespace

Returns:

String -

• path of the package

getPackagePaths(namespace) → {Array}

environment.js, line 598

Get paths for a namespace

Parameters:

Name	Type	Description
namespace	String	namespace

Returns:

Array -

• array of paths.

getRegisteredPackages() → {Array}

environment.js, line 573

Get all registered packages namespaces.

Returns:

Array -

• array of namespaces.

getVersion(packageName) → {String}

environment.js, line 530

Returns the environment or dependency version.

Parameters:

Name	Type	Description
packageName	String	Module to get version.

Returns:

String -

Environment version.

help(name)

environment.js, line 409

Outputs the general help and usage. Optionally, if generators have been registered, the list of available generators is also displayed.

Parameters:

Name	Type	Default	Description
name	String	init

installLocalGenerators(packages) → {Boolean}

composability.js, line 29

Install generators at the custom local repository and register.

Parameters:

Name	Type	Description
packages	Object	packages to install key(packageName): value(versionRange).

Returns:

Boolean -

• true if the install succeeded.

Mixes In:

• env/composability.installLocalGenerators

instantiate(generator, argsopt, optionsopt) → {Generator}

environment.js, line 777

Instantiate a Generator with metadatas

Parameters:

Name	Type	Attributes	Description
generator	Class.<Generator>		Generator class
args	Array	<optional>	Arguments to pass the instance
options	Object	<optional>	Options to pass the instance

Returns:

Generator -

The instantiated generator

isPackageRegistered(packageNSopt) → {boolean}

environment.js, line 564

Verify if a package namespace already have been registered.

Parameters:

Name	Type	Attributes	Description
packageNS	String	<optional>	namespace of the package.

Returns:

boolean -

• true if any generator of the package has been registered

loadEnvironmentOptions(options)

environment.js, line 361

Load options passed to the Generator that should be used by the Environment.

Parameters:

Name	Type	Description
options	Object

loadSharedOptions(options)

environment.js, line 375

Load options passed to the Environment that should be forwarded to the Generator.

Parameters:

Name	Type	Description
options	Object

lookup(optionsopt) → {Array.<Object>}

resolver.js, line 56

Search for generators and their sub generators.

A generator is a :lookup/:name/index.js file placed inside an npm package.

Defaults lookups are:

• ./
• generators/
• lib/generators/

So this index file node_modules/generator-dummy/lib/generators/yo/index.js would be registered as dummy:yo generator.

Parameters:

Name	Type	Attributes	Description
options	boolean | Object	<optional>	Properties Name Type Attributes Default Description localOnly boolean <optional> false Set true to skip lookups of globally-installed generators. packagePaths string | Array <optional> Paths to look for generators. npmPaths string | Array <optional> Repository paths to look for generators packages. filePatterns string | Array <optional> '*\/index.js' File pattern to look for. packagePatterns string | Array <optional> 'generator-*' Package pattern to look for. singleResult boolean <optional> false Set true to stop lookup on the first match. globbyDeep Number <optional> Deep option to be passed to globby.

Returns:

Array.<Object> -

List of generators

Mixes In:

• env/resolver.lookup

lookupLocalPackages(packagesToLookupopt)

composability.js, line 51

Lookup and register generators from the custom local repository.

Parameters:

Name	Type	Attributes	Default	Description
packagesToLookup	Array.<String>	<optional>	'generator-*'	packages to lookup.

Mixes In:

• env/composability.lookupLocalPackages

namespace(filepath, lookups)

environment.js, line 1110

Given a String filepath, tries to figure out the relative namespace.

Examples:

this.namespace('backbone/all/index.js');
// => backbone:all

this.namespace('generator-backbone/model');
// => backbone:model

this.namespace('backbone.js');
// => backbone

this.namespace('generator-mocha/backbone/model/index.js');
// => mocha:backbone:model

Parameters:

Name	Type	Description
filepath	String
lookups	Array	paths

namespaces() → {Array}

environment.js, line 521

Returns the list of registered namespace.

Returns:

Array

queueConflicter()

environment.js, line 1250

Queue environment's commit task.

queueGenerator(generator, scheduleopt) → {Generator}

environment.js, line 883

Queue generator run (queue itself tasks).

Parameters:

Name	Type	Attributes	Default	Description
generator	Generator			Generator instance
schedule	boolean	<optional>	false	Whether to schedule the generator run.

Returns:

Generator -

The generator or singleton instance.

queuePackageManagerInstall()

environment.js, line 1286

Queue environment's package manager install task.

register(name, namespace, packagePath) → {Object}

environment.js, line 458

Registers a specific generator to this environment. This generator is stored under provided namespace, or a default namespace format if none if available.

Parameters:

Name	Type	Description
name	String	Filepath to the a generator or a npm package name
namespace	String	Namespace under which register the generator (optional)
packagePath	String	PackagePath to the generator npm package (optional)

Returns:

Object -

environment - This environment

registerStub(Generator, namespace, resolvedopt, packagePathopt) → {this}

environment.js, line 497

Register a stubbed generator to this environment. This method allow to register raw functions under the provided namespace. registerStub will enforce the function passed to extend the Base generator automatically.

Parameters:

Name	Type	Attributes	Description
Generator	function		A Generator constructor or a simple function
namespace	String		Namespace under which register the generator
resolved	String	<optional>	The file path to the generator
packagePath	String	<optional>	The generator's package path

Returns:

this

resolveModulePath(moduleId) → {String}

environment.js, line 1152

Resolve a module path

Parameters:

Name	Type	Description
moduleId	String	Filepath or module name

Returns:

String -

• The resolved path leading to the module

resolvePackage(packageName, packageVersionopt, Array)

composability.js, line 62

Resolve a package name with version.

Parameters:

Name	Type	Attributes	Description
packageName	string		package to resolve.
packageVersion	string	<optional>	version or range to resolve.
Array	Array.<string>		of key, value pairs.

Mixes In:

• env/composability.resolvePackage

rootGenerator() → {Generator}

environment.js, line 1086

Get the first generator that was queued to run in this environment.

Returns:

Generator -

generator queued to run in this environment.

async run(args, optionsopt)

environment.js, line 963

Tries to locate and run a specific generator. The lookup is done depending on the provided arguments, options and the list of registered generators.

When the environment was unable to resolve a generator, an error is raised.

Parameters:

Name	Type	Attributes	Description
args	String | Array
options	Object	<optional>

async runGenerator(generator)

environment.js, line 1067

Convenience method to run the generator with callbackWrapper. See https://github.com/yeoman/environment/pull/101

Parameters:

Name	Type	Description
generator	Object

start(options)

environment.js, line 1003

Start Environment queue

Parameters:

Name	Type	Description
options	Object	Conflicter options.