起因
因為工作中遇到了需要創(chuàng)建新的Koajs項目卡乾，但在Yeoman上找了一圈，發(fā)現(xiàn)使用的Koa的generator更新實在太少太慢缚够，用的好多模塊都太老幔妨，不是很適合。公司內(nèi)部還處于Copy的模式谍椅，沒有一個統(tǒng)一管理的基礎(chǔ)項目误堡。于是就想到了自己去弄個 yeoman generator。一是學(xué)習(xí)了新的東西雏吭，二來確實相當方便锁施，新建工程爽爽的。所以說也不算是教程杖们，只是自己成功搞定generator的思路悉抵，歡迎大家指教。
generator地址：generator-koa-sudiyi
題外話：Koa 比起 Express 實在好用太多摘完。
賬號準備
Your generator must have a GitHub repository description, the yeoman-generator keyword and a description in package.json to be listed.
下載安裝yo和generator-generator
在已經(jīng)有裝好node和npm的前提下荆秦，需要全局安裝yo和generator-generator
npm install -g yo
npm install -g generator-generator
之后運行generator-generator來創(chuàng)建我們自己需要的generator的基礎(chǔ)框架
yo generator
在一系列設(shè)置問題之后
我們得到了generator的目錄：
.
├── generators/
│ └── app/
│ ├── index.js
│ └── templates/
│ └── dummyfile.txt
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .eslintrc
├── .travis.yml
├── .yo-rc.json
├── package.json
├── gulpfile.js
├── README.md
├── LICENSE
└── test/
└── app.js
開始行動
準備模版
首先我是準備了我將要生成基礎(chǔ)工程的一些模版文件篱竭，放在 templates 文件夾中，刪掉了默認生成的 dummyfile.txt步绸。這是Yeoman默認的放模版文件的文件夾掺逼，當然你也可以通過templatePath去設(shè)置其他文件夾。這里我就不弄復(fù)雜了瓤介，詳情可以參考官網(wǎng)的API文檔吕喘，歡迎一起探討。
因為我需要的基礎(chǔ)工程只是一個簡單的koajs刑桑，并實現(xiàn)rest就行氯质，所以需要建立的模版不是特別復(fù)雜，我就偷懶放在一個文件夾下了祠斧。（詳細內(nèi)容可以去我的Github Repo上去看）
編輯index.js
接下來開始編輯index.js文件闻察，我們的generator如何生成什么樣的基礎(chǔ)工程，目錄結(jié)構(gòu)，是否自動安裝依賴模塊等等都是在這一步完成辕漂。先貼上代碼呢灶，后面再把重要的地方重點說明。
'use strict';
var yeoman = require('yeoman-generator');
var chalk = require('chalk');
var yosay = require('yosay');
var path = require('path');
var _ = require('lodash');
var extend = require('deep-extend');
var mkdirp = require('mkdirp');
module.exports = yeoman.generators.Base.extend({
initializing: function () {
this.props = {};
},
prompting: function () {
var done = this.async();
// Have Yeoman greet the user.
this.log(yosay(
'Welcome to the luminous ' + chalk.red('generator-koa-sudiyi') + ' generator!'
));
var prompts = [
{
type: 'input',
name: 'projectName',
message: 'Please input project name (sudiyi_app):',
default: 'sudiyi_app'
},
{
type: 'input',
name: 'projectDesc',
message: 'Please input project description:'
},
{
type: 'input',
name: 'projectMain',
message: 'Main file (app.js):',
default: 'app.js'
},
{
type: 'input',
name: 'projectAuthor',
message: 'Author (sudiyi):',
default: 'sudiyi'
},
{
type: 'list',
name: 'projectLicense',
message: 'Please choose license:',
choices: ['MIT', 'ISC', 'Apache-2.0', 'AGPL-3.0']
}
];
this.prompt(prompts, function (props) {
this.props = props;
// To access props later use this.props.someOption;
done();
}.bind(this));
},
defaults: function () {
if (path.basename(this.destinationPath()) !== this.props.projectName) {
this.log(
'Your generator must be inside a folder named ' + this.props.projectName + '\n' +
'I\'ll automatically create this folder.'
);
mkdirp(this.props.projectName);
this.destinationRoot(this.destinationPath(this.props.projectName));
}
},
writing: function () {
var readmeTpl = _.template(this.fs.read(this.templatePath('README.md')));
this.fs.write(this.destinationPath('README.md'), readmeTpl({
generatorName: 'generator-koa-sudiyi',
yoName: 'koa-sudiyi'
}));
var pkg = this.fs.readJSON(this.templatePath('package_tmpl.json'), {});
extend(pkg, {
dependencies: {
'aliyun-sdk': '^1.6.3',
'bluebird': '^3.0.6',
'co': '^4.6.0',
'co-body': '^4.0.0',
'co-busboy': '^1.3.1',
'co-foreach': '^1.1.1',
'co-redis': '^2.0.0',
'co-request': '^1.0.0',
'co-views': '^0.2.0',
'cron': '^1.1.0',
'kcors': '^1.0.1',
'koa': '^1.1.2',
'koa-bodyparser': '^2.0.1',
'koa-compress': '^1.0.8',
'koa-jwt': '^1.1.1',
'koa-logger': '^1.3.0',
'koa-route': '^2.4.2',
'koa-router': '^5.3.0',
'koa-static': '^1.5.2',
'lodash': '^3.10.1',
'log4js': '^0.6.29',
'moment': '^2.10.6',
'node-uuid': '^1.4.7',
'nodemailer': '^1.10.0',
'redis': '^2.4.2',
'sequelize': '^3.14.2',
'sequelize-cli': '^2.2.1',
'socket.io': '^1.3.7',
'swig': '^1.4.2',
'thunkify-wrap': '^1.0.4',
'async': '^1.5.0',
'koa-body-parser': '^1.1.2',
'koa-generic-session': '^1.10.0',
'koa-redis': '^1.0.1',
'mysql': '^2.9.0',
'request': '^2.67.0'
},
devDependencies: {
'mocha': '^2.3.3',
'chai': '^3.4.1',
'gulp': '^3.9.0',
'faker': '^3.0.1',
'minimist': '^1.2.0',
'co-mocha': '^1.1.2'
}
});
pkg.keywords = pkg.keywords || [];
pkg.keywords.push('generator-koa-sudiyi');
pkg.name = this.props.projectName;
pkg.description = this.props.projectDesc;
pkg.main = this.props.projectMain;
pkg.author = this.props.projectAuthor;
pkg.license = this.props.projectLicense;
this.fs.writeJSON(this.destinationPath('package.json'), pkg);
mkdirp('lib/controllers');
mkdirp('lib/middlewares');
mkdirp('lib/middlewares/common');
mkdirp('lib/models');
mkdirp('lib/db');
mkdirp('lib/logger');
mkdirp('lib/routes');
mkdirp('lib/utils');
mkdirp('public');
this.fs.copy(
this.templatePath('gitignore_tmpl'),
this.destinationPath('.gitignore')
);
this.fs.copy(
this.templatePath('jshintrc_tmpl'),
this.destinationPath('.jshintrc')
);
this.fs.copy(
this.templatePath('app_tmpl.js'),
this.destinationPath('app.js')
);
this.fs.copy(
this.templatePath('index_tmpl.js'),
'lib/index.js'
);
this.fs.copy(
this.templatePath('request_id_tmpl.js'),
'lib/middlewares/common/request_id.js'
);
},
install: function () {
this.installDependencies({bower: false});
}
});
promoting塊
var prompts = [...];
this.prompt(prompts, function (props) {
this.props = props;
// To access props later use this.props.someOption;
done();
}.bind(this));
我們需要通過問題的方式采集用戶建立工程的數(shù)據(jù)钉嘹。promts是問題集合鸯乃，在調(diào)用this.promt使其在運行yo的時候提出來，最后將用戶輸入的數(shù)據(jù)存在this.props中跋涣，以方便后面調(diào)用缨睡。
default
mkdirp(this.props.projectName);
this.destinationRoot(this.destinationPath(this.props.projectName));
mkdirp是我們引用的模塊，用來創(chuàng)建文件夾仆潮。this.destinationRoot則是設(shè)置要創(chuàng)建的工程的根目錄宏蛉。
writing
使用_.template(lodash的template功能)和this.fs.write將模版中的關(guān)鍵字替換為用戶的輸入項。
this.fs.readJSON和this.fs.writeJSON性置，則是將package.json模版中的數(shù)據(jù)讀取出來，作出一定修改寫成新的文件揍堰。
最后使用mkdirp和this.fs.copy構(gòu)建工程目錄結(jié)構(gòu)和將一些不要修改的配置文件copy到指定目錄鹏浅。
到此我們的代碼工作就結(jié)束了，只剩最后發(fā)布啦~
發(fā)布
首先需要一個npm賬號屏歹，如果沒有可以使用npm adduser創(chuàng)建隐砸；如果有則運行npm login登陸。然后到工程根目錄下蝙眶，運行npm publish就可以發(fā)布了季希。
因為npm的repo下載很慢，我們很多時候用的taobao的repo幽纷。所以發(fā)布的時候需要切回到npm的repo式塌。
祝成功！
（全文完）
