| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444 |
1
1
1
1
1
1
1
1
1
1
1
1
1
1
154
154
154
154
154
154
154
154
154
154
154
1
1
1
7
7
3
1
490
1
489
489
1
157
157
70
70
87
87
87
87
1
2
2
2
2
2
4
4
4
4
2
4
4
4
4
4
2
1
123
123
123
123
123
123
123
1
220
1
219
1
218
218
1
16
1
1
1
71
68
1
39
39
39
39
38
38
38
38
1
37
37
37
37
37
1
10
10
3
3
10
1
1
1
10
10
10
10
10
10
1
9
5
9
9
9
9
3
9
9
9
1
131
131
131
131
393
131
131
131
1
123
27
123
123
1
96
1
96
| 'use strict';
var fs = require('fs');
var util = require('util');
var path = require('path');
var events = require('events');
var spawn = require('child_process').spawn;
var chalk = require('chalk');
var _ = require('lodash');
var debug = require('debug')('generators:environment');
var Base = require('../base');
var Store = require('./store');
var resolver = require('./resolver');
var TerminalAdapter = require('./adapter');
var win32 = process.platform === 'win32';
/**
* `Environment` object is responsible of handling the lifecyle and bootstrap
* of generators in a specific environment (your app).
*
* It provides a high-level API to create and run generators, as well as further
* tuning where and how a generator is resolved.
*
* An environment is created using a list of `arguments` and a Hash of
* `options`. Usually, this is the list of arguments you get back from your CLI
* options parser.
*
* An optional adapter can be passed to provide interaction in non-CLI environment
* (e.g. IDE plugins), otherwise a `TerminalAdapter` is instantiated by default
*
*
* @param {String|Array} args
* @param {Object} opts
* @param {Adapter} adaper
*/
var Environment = module.exports = function Environment(args, opts, adapter) {
events.EventEmitter.call(this);
args = args || [];
this.arguments = Array.isArray(args) ? args : args.split(' ');
this.options = opts || {};
this.adapter = adapter || new TerminalAdapter();
this.cwd = this.options.cwd || process.cwd();
this.store = new Store();
this.lookups = ['.', 'generators', 'lib/generators'];
this.aliases = [];
this.paths = [];
this.appendDefaultPaths();
};
util.inherits(Environment, events.EventEmitter);
_.extend(Environment.prototype, resolver);
/**
* 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.
*
* @param {Object} err
* @return {Error} err
*/
Environment.prototype.error = function error(err) {
err = err instanceof Error ? err : new Error(err);
Iif (!this.emit('error', err)) {
throw err;
}
return err;
};
/**
* Appends a `filepath` to the list of loadpaths.
*
* @param {String} filepath
*/
Environment.prototype.appendPath = function appendPath(filepath) {
if (!filepath) {
return this.error(new Error('Missing filepath.'));
}
this.paths.push(path.resolve(filepath));
return this;
};
/**
* Appends the defaults node modules paths to the Environment load paths.
*/
Environment.prototype.appendDefaultPaths = function () {
this.appendPath(process.cwd());
// We tried using NPM to get the global modules path, but it haven't work out
// because of bugs in the parseable implementation of `ls` command and mostly
// performance issues. So, we go with our best bet for now.
if (process.env.NODE_PATH) {
_.compact(process.env.NODE_PATH.split(win32 ? ';' : ':')).forEach(this.appendPath, this);
return;
}
// global node_modules should be 5 directory up this one (most of the time)
this.appendPath(path.join(__dirname, '../../../../..'));
// adds support for generator resolving when yeoman-generator has been linked
this.appendPath(path.join(path.dirname(process.argv[1]), '../..'));
// Default paths for each system
Iif (win32) {
this.appendPath(path.join(process.env.APPDATA, 'npm/node_modules'));
} else {
this.appendPath('/usr/lib/node_modules');
}
};
/**
* Outputs the general help and usage. Optionally, if generators have been
* registered, the list of available generators is also displayed.
*
* @param {String} name
*/
Environment.prototype.help = function help(name) {
name = name || 'init';
var out = [
'Usage: :binary: GENERATOR [args] [options]',
'',
'General options:',
' -h, --help # Print generator\'s options and usage',
' -f, --force # Overwrite files that already exist',
'',
'Please choose a generator below.',
''
];
var ns = this.namespaces();
var groups = {};
ns.forEach(function (namespace) {
var base = namespace.split(':')[0];
Eif (!groups[base]) {
groups[base] = [];
}
groups[base].push(namespace);
});
Object.keys(groups).sort().forEach(function (key) {
var group = groups[key];
Eif (group.length >= 1) {
out.push('', key.charAt(0).toUpperCase() + key.slice(1));
}
groups[key].forEach(function (ns) {
out.push(' ' + ns);
});
});
return out.join('\n').replace(/:binary:/g, name);
};
/**
* Registers a specific `generator` to this environment. This generator is stored under
* provided namespace, or a default namespace format if none if available.
*
* @param {String} name - Filepath to the a generator or a NPM module name
* @param {String} namespace - Namespace under which register the generator (optionnal)
* @return {this}
*/
Environment.prototype.register = function register(name, namespace) {
Iif (!_.isString(name)) {
return this.error(new Error('You must provide a generator name to register.'));
}
var modulePath = this.resolveModulePath(name);
namespace = namespace || this.namespace(modulePath);
Iif (!namespace) {
return this.error(new Error('Unable to determine namespace.'));
}
this.store.add(namespace, modulePath);
debug('Registered %s (%s)', namespace, modulePath);
return this;
};
/**
* 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.
*
* @param {Function} Generator - A Generator constructor or a simple function
* @param {String} namespace - Namespace under which register the generator
* @return {this}
*/
Environment.prototype.registerStub = function registerStub(Generator, namespace) {
if (!_.isFunction(Generator)) {
return this.error(new Error('You must provide a stub function to register.'));
}
if (!_.isString(namespace)) {
return this.error(new Error('You must provide a namespace to register.'));
}
this.store.add(namespace, Generator);
return this;
};
/**
* Returns the list of registered namespace.
* @return {Array}
*/
Environment.prototype.namespaces = function namespaces() {
return this.store.namespaces();
};
/**
* Returns stored generators meta
* @return {Object}
*/
Environment.prototype.getGeneratorsMeta = function getGeneratorsMeta() {
return this.store.getGeneratorsMeta();
};
/**
* 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).
*
* @param {String} namespace
* @return {Generator} - the generator registered under the namespace
*/
Environment.prototype.get = function get(namespace) {
// Stop the recursive search if nothing is left
if (!namespace) return;
return this.store.get(namespace) ||
this.store.get(this.alias(namespace)) ||
this.get(namespace.split(':').slice(0, -1).join(':'));
};
/**
* 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.
*
* @param {String} namespace
* @param {Object} options
*/
Environment.prototype.create = function create(namespace, options) {
options = options || {};
var names = namespace.split(':');
var name = names.slice(-1)[0];
var Generator = this.get(namespace);
var args = options.arguments || options.args || _.clone(this.arguments);
args = Array.isArray(args) ? args : args.split(' ');
var opts = options.options || _.clone(this.options);
if (!Generator) {
return this.error(
new Error(
'You don\'t seem to have a generator with the name ' + namespace + ' installed.\n' +
chalk.bold('You can see available generators with ' + 'npm search yeoman-generator') +
chalk.bold(' and then install them with ' + 'npm install [name]') + '.\n' +
'To see the ' + this.namespaces().length + ' registered generators run yo with the `--help` option.'
)
);
}
opts.env = this;
opts.name = name;
opts.resolved = Generator.resolved;
opts.namespace = namespace;
return new Generator(args, opts);
};
/**
* 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.
*
* @param {String|Array} args
* @param {Object} options
* @param {Function} done
*/
Environment.prototype.run = function run(args, options, done) {
args = args || this.arguments;
if (typeof options === 'function') {
done = options;
options = this.options;
}
if (typeof args === 'function') {
done = args;
options = this.options;
args = this.arguments;
}
args = Array.isArray(args) ? args : args.split(' ');
options = options || this.options;
var name = args.shift();
Iif (!name) {
return this.error(new Error('Must provide at least one argument, the generator namespace to invoke.'));
}
var generator = this.create(name, {
args: args,
options: options
});
if (generator instanceof Error) {
return generator;
}
if (typeof done === 'function') {
generator.on('end', done);
}
Iif (options.help) {
return console.log(generator.help());
}
generator.on('start', this.emit.bind(this, 'generators:start'));
generator.on('start', this.emit.bind(this, name + ':start'));
generator.on('method', function (method) {
this.emit(name + ':' + method);
}.bind(this));
generator.on('end', this.emit.bind(this, name + ':end'));
generator.on('end', this.emit.bind(this, 'generators:end'));
return generator.run();
};
/**
* 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
*
* @param {String} filepath
*/
Environment.prototype.namespace = function namespace(filepath) {
Iif (!filepath) {
throw new Error('Missing namespace');
}
// cleanup extension and normalize path for differents OS
var ns = path.normalize(filepath.replace(path.extname(filepath), ''));
// Sort lookups by length so biggest are removed first
var lookups = _(this.lookups).map(path.normalize).sortBy('length').value().reverse();
// if `ns` contain a lookup dir in it's path, remove it.
ns = lookups.reduce(function (ns, lookup) {
return ns.replace(lookup, '');
}, ns);
// cleanup `ns` from unwanted parts and then normalize slashes to `:`
ns = ns
.replace(/(.*generator-)/, '') // remove before `generator-`
.replace(/[\/\\](index|main)$/, '') // remove `/index` or `/main`
.replace(/\.+/g, '') // remove `.`
.replace(/^[\/\\]+/, '') // remove leading `/`
.replace(/[\/\\]+/g, ':'); // replace slashes by `:`
debug('Resolve namespaces for %s: %s', filepath, ns);
return ns;
};
/**
* Resolve a module path
* @param {String} moduleId - Filepath or module name
* @return {String} - The resolved path leading to the module
*/
Environment.prototype.resolveModulePath = function resolveModulePath(moduleId) {
if (moduleId[0] === '.') {
moduleId = path.resolve(moduleId);
}
Iif (moduleId[0] === '~') {
moduleId = process.env[process.platform === 'win32' ? 'USERPROFILE' : 'HOME'] + moduleId.slice(1);
}
return require.resolve(moduleId);
};
/**
* Make sure the Environment present expected methods if an old version is
* passed to a Generator.
* @param {Environment} env
* @return {Environment} The updated env
*/
Environment.enforceUpdate = function (env) {
if (!env.adapter) {
env.adapter = new TerminalAdapter();
}
return env;
};
|