1. module plop
   1. object plop.console_out
2. module plop.console_out
   1. function plop.console_out.chooseOptionFromList (plopList)
   2. function plop.console_out.createInitPlopfile (cwd, callback)
   3. function plop.console_out.displayHelpScreen ()

module plop

module plop.console_out

function plop.console_out.chooseOptionFromList (plopList)

• description and source-code

  function chooseOptionFromList(plopList) {
  		const plop = nodePlop();
  		const generator = plop.setGenerator('choose', {
  			prompts: [{
  				type: 'list',
  				name: 'generator',
  				message: '[PLOP]'.blue + ' Please choose a generator.',
  				choices: plopList.map(function (p) {
  					return {
  						name: p.name + chalk.gray(!!p.description ? ' - ' + p.description : ''),
  						value: p.name
  					};
  				})
  			}]
  		});
  		return generator.runPrompts().then(results => results.generator);
  	}

• example usage

  ...
  		process.exit(1);
  	}
  
  	// set the default base path to the plopfile directory
  	plop = nodePlop(plopfilePath);
  	generators = plop.getGeneratorList();
  	if (!generator) {
  		out.chooseOptionFromList(generators).then(function (generatorName) {
  			doThePlop(plop.getGenerator(generatorName));
  		});
  	} else if (generators.map(function (v) { return v.name; }).indexOf(generator) > -1) {
  		doThePlop(plop.getGenerator(generator));
  	} else {
  		console.error(chalk.red('[PLOP] ') + 'Generator "' + generator + '" not found in plopfile&#
  x27;);
  		process.exit(1);
  ...

function plop.console_out.createInitPlopfile (cwd, callback)

• description and source-code

  function createInitPlopfile(cwd, callback){
  		var initString = 'module.exports = function (plop) {\n\n' +
  			'\tplop.setGenerator(\'basics\', {\n' +
  			'\t\tdescription: \'this is a skeleton plopfile\',\n' +
  			'\t\tprompts: [],\n' +
  			'\t\tactions: []\n' +
  			'\t});\n\n' +
  			'};';
  
  		fs.writeFile(cwd + '/plopfile.js', initString, callback);
  	}

• example usage

  ...
  	if (argv.help || argv.h) {
  		out.displayHelpScreen();
  		process.exit(0);
  	}
  
  	// handle request for initializing a new plopfile
  	if (argv.init || argv.i) {
  		return out.createInitPlopfile(env.cwd, function(err){
  			if (err){
  				console.log(err);
  				process.exit(1);
  			}
  			process.exit(0);
  		});
  	}
  ...

function plop.console_out.displayHelpScreen ()

• description and source-code

  function displayHelpScreen() {
  		console.log(
  			'\n' +
  			'USAGE:\n' +
  			'  $ plop\t\tSelect from a list of available generators\n' +
  			'  $ plop <name>\t\tRun a generator registered under that name\n' +
  
  			'\n' +
  			'OPTIONS:\n' +
  			'  -h, --help\t\tShow this help display\n' +
  			'  -i, --init\t\tGenerate a basic plopfile.js\n' +
  			'  -v, --version\t\tPrint current version\n'
  		);
  	}

• example usage

  ...
  }, run);
  
  function run(env) {
  	var generators, plopfilePath, plop;
  
  	// handle request for usage and options
  	if (argv.help || argv.h) {
  		out.displayHelpScreen();
  		process.exit(0);
  	}
  
  	// handle request for initializing a new plopfile
  	if (argv.init || argv.i) {
  		return out.createInitPlopfile(env.cwd, function(err){
  			if (err){
  ...