Yeoman

起因

坐工作受到遇见了需创造新的Koajs项目,但在Yeoman及找寻了平环,发现采用的Koa的generator更新实在太少太慢,用底好多模块都极其老,不是可怜抱。公司里还地处Copy的模式,没有一个联合管理之功底项目。于是就想开了祥和失去下手个
yeoman
generator
。一凡学习了初的东西,二来确实相当有益,新建工程爽爽的。所以说吧非到底教程,只是自己成功抓定generator的笔触,欢迎大家指教。

generator地址:generator-koa-sudiyi

修外话:Koa 比由 Express 实在好用极端多。

账号准备

  • npmjs
    账号,用于publish到npm。
  • Github
    账号,npm中形你的源码,同时方便Yeoman官网中能搜到公的generator。正而该叙述的:

Your generator must have a GitHub repository description, the
yeoman-generator keyword and a description in package.json to
be listed.

下载安装yo和generator-generator

以已经出装好node和npm的前提下,需要全局安装yogenerator-generator

npm install -g yo
npm install -g generator-generator

以后运行generator-generator来创造我们好欲之generator的功底框架

yo generator

当同等系列设置问题之后

install generator

咱俩得了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

初始走

未雨绸缪模版

首先自己是准备了自家快要变化基础工程的有的模板文件,放在 templates
文件夹着,删掉了默认生成的
dummyfile.txt。这是Yeoman默认的放模版文件的文本夹,当然你也可透过templatePath失掉装任何文件夹。这里我哪怕非抓复杂了,详情可参考官网的API文档,欢迎并追。

盖自身待的基础工程就是一个大概的koajs,并促成rest就执行,所以需要建立的模版不是专门复杂,我不怕偷懒放在一个文书夹下了。(详细内容可错过我之Github
Repo上去看)

folder structure

编辑index.js

连通下去开始编制index.js文件,我们的generator如何好成什么的功底工程,目录结构,是否自动装依赖模块等等都是当就同步成功。先贴上代码,后面再管重点的地方重点征。

'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));

咱用经过问题的法子收集用户建工程的数据。promts大凡题材集合,在调用this.promt设该当运作yo的时候提出来,最后以用户输入的数码在this.props受到,以有益后面调用。

default

mkdirp(this.props.projectName);

this.destinationRoot(this.destinationPath(this.props.projectName));

mkdirp大凡咱们引用的模块,用来创造文件夹。this.destinationRoot虽说是安装要开创的工程的到底目录。

writing

使用_.template(lodash的template功能)和this.fs.write拿模版中的严重性字替换为用户之输入项。

this.fs.readJSONthis.fs.writeJSON,则是用package.json模版中的多寡读取出来,作出一定修改写成新的文件json。

末尾采取mkdirpthis.fs.copy构建工程目录结构及拿部分毫不改动的布置文件copy到指定目录。

及是我们的代码工作就是寿终正寝了,只留最后宣布啦~

发布

先是需一个npm账号,如果没得使用npm adduser开创;如果产生则运行npm login登陆。然后到工程根目录下,运行npm publish就是可以颁发了。

盖npm的repo下充斥很缓慢,我们多时用之taobao的repo。所以发布的时候用切回到npm的repo。

祝成功!

(全文完)

相关文章

网站地图xml地图