madoos-yo-helper
v0.0.2
Published
Allows abstract writing of templates for yeoman generators.
Downloads
2
Readme
madoos-yo-helper
Allows abstract writing of templates for yeoman generators.
Features
- Add the directory tree that is inside templates
- Gets the prompt vars and passes them as arguments to the templates
Considerations
- Transforms all files with
_
in their name to.
, for example_gitignore
to.gitignore
Functions
.prompts
.fileWriter
Getting Started
To install:
npm i --save madoos-yo-helper
In the generator index:
const yeoman = require('yeoman-generator');
const generatorName = 'some-generator-name';
const questions = [{type: 'input', name: 'name',message: 'Your project name',default: null}];
const templatePath = require('path').join(__dirname, './templates');
// require module
const yoHelper = require('madoos-yo-helper')(generatorName, questions, templatePath);
module.exports = yeoman.Base.extend({
prompting: yoHelper.prompts,
writing: yoHelper.fileWriter,
install: function () {
this.installDependencies();
}
});
If you want to use the yeoman context to get props:
const yeoman = require('yeoman-generator');
const generatorName = 'some-generator-name';
// Now questions is a function that allows to obtain the context of yeoman
const questions = function(){
const moduleName = {type: 'input', name: 'name',message: 'Your project name',default: this.appname}
return [moduleName];
};
const templatePath = require('path').join(__dirname, './templates');
// require module
const yoHelper = require('madoos-yo-helper')(generatorName, questions, templatePath);
module.exports = yeoman.Base.extend({
prompting: yoHelper.prompts,
writing: yoHelper.fileWriter,
install: function () {
this.installDependencies();
}
});