Yeoman

起因

因为做事中遇见了急需成立新的Koajs项目,但在Yeoman上找了一圈,发现采取的Koa的generator更新实在太少太慢,用的不在少数模块都太老,不是很合乎。公司内部还处在Copy的形式,没有3个合并保管的底子项目。于是就想到了和谐去弄个
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模版中的数据读取出来,作出肯定修改写成新的文本。

说到底选择mkdirpthis.fs.copy创设工程目录结构和将有些永不改动的配备文件copy到指定目录。

到此大家的代码工作就截至了,只剩最终颁发啦~

发布

首先须求贰个npm账号,假使没有得以利用npm adduser创立;假若有则运行npm login登陆。然后到工程根目录下,运转npm publish就足以宣布了。

因为npm的repo下载很慢,我们广大时候用的taobao的repo。所以宣布的时候要求切回到npm的repo。

祝成功!

(全文完)

相关文章

网站地图xml地图