PHPyeoman-generator 入门教程

PHP 1

摘要


乘势 Web 2.0 和 HTML 5 的风靡,现在的 Web
应用所能提供的效能和相互能力比从前传统的 Web
应用要强硬很多。应用的成百上千落到实处逻辑被更换来了浏览器端来兑现。浏览器不再只提供单纯的数量接收和彰显功效,而是提供越多的用户交互能力。浏览器端所蕴藏的
HTML、CSS 和 JavaScript
代码也变得愈加错综复杂。对于日益复杂的前端代码,需求有更好的流水线和工具来管理支出的各种方面,包蕴伊始的代码结构、开发流程和自动化测试等。yeoman
是一个新兴的工具。它构成了 Yo、Grunt 和 Bower
等工具,组成了一个完好无缺的工具集合,提供各个 Web
应用开发中所需的实用功能。

正文


1. yeoman

Yeoman可以支持大家创设新的付出项目,为大家提供更好的工具来使大家的体系更各类化。

2. yeoman-generator

Generators是yeoman生态系统的积木,是因而yo命令运行而为终端用户生产文件的插件。

3. 创设创设和谐的generator

1. 创建 node module

在您须要成立generator的地点创立一个目录,目录要以generator-name命名(name替换成你要创建的generator名称)。命名规则很重点,因为yeoman会通过文件系统来查找可以运用的generator。
在地方创设的目录下开创一个package.json文件,该文件是一个Node.js项目标的模块清单.相关介绍请看官网。你可以透过在命令行运行
npm init 来创设package.json文件,当然你也可以手动填写那些文件:

  {
    "name": "generator-name",
    "version": "0.1.0",
    "description": "",
    "files": [
      "app",
      "router"
    ],
    "keywords": ["yeoman-generator"],
    "dependencies": {
      "yeoman-generator": "^0.20.2"
    }
  }

其中 name 属性必须以generator-前缀。keywords
属性必须带有”yeoman-generator” 并且repo必须有一个引用generators
page
目录的描述。

您不能不确保引用了新星版本的yeoman-generator 模块作为看重.可以因而
npm install --save yeoman-generator来实现。

files属性必须是一个在你的generator里面用到的文本和目录的数组。

2.目录树

yeoman是深浅信赖你团队的文件目录文件系统,每一个子generator都有谈得来的文本夹。

generator默认把app作为默许的子generator,当您使用yo name
调用的是app子generator。因而你的generator必须包涵app/目录。你能够经过yo name:subcommand命令来调用子generator,他会调用与subcommand完全等同的文件夹即子generator。

上面是现身说法项目的文本夹结构

 ├───package.json
 ├───app/
 │   └───index.js
 └───router/
     └───index.js

通过命令 yo nameyo name:router 可以显得出来generator。

若果你不想把富有的文件都置身根目录上面,很幸运的是yeoman帮衬二种区其余目录结构./
generators/ ,yeoman会从他们中间注册可用的generators。

所在此从前一个演示的布局也可用定义成如下:

    ├───package.json
    └───generators/
        ├───app/
        │   └───index.js
        └───router/
            └───index.js

假定您利用那种目录结构,请保管package.json 文件内的 files
属性定义了子generator在generators目录下:

     {
       "files": [
         "generators/app",
         "generators/router"
       ]
     }

3. 扩展generator

当到了这一步你就可用去完结generator的具体内容了

yeoman提供了一个基础的generator让大家增加使用以促成自己的目的.基础的generator提供了绝一大半的听从来缓解你的任务量。

上边是增加基础generator的方法:

    var generators = require('yeoman-generator');
    module.exports = generators.Base.extend();

extend
允许你在基础的class上扩充新的协调想要的prototype规范.他的机能是由此Class-extend模块得来的。假设您用过backbone,你会以为他很熟知。在生态系统中,大家指定扩展的generator使用module.export来让其立竿见影,就如在nodeJs使用export
module一样

4. 重写constructor方法

稍微generator方法唯有定义在构造方法内才能被调用到.那个特其余主意可以做的有的重点的操作等,而那几个操作可能在布局之外不能正常运行。

    module.exports = generators.Base.extend({
      // The name `constructor` is important here
      constructor: function () {
        // Calling the super constructor is important so our generator is correctly set up
        generators.Base.apply(this, arguments);

        // Next, add your custom code
        this.option('coffee'); // This method adds support for a `--coffee` flag
      }
    });

5. 添加自定义方法

当generator被调用时,常常状态下里面定义的方法会依照顺序执行,但是大家将在下一节中看看的,一些奇异的点子名称将触及特定的运转秩序。

上面的一段代码是创设两个自定义的措施

    module.exports = generators.Base.extend({
      method1: function () {
        console.log('method 1 just ran');
      },
      method2: function () {
        console.log('method 2 just ran');
      }
    });

当运行generator 你见面到会用log打印出来。

6. 运行generator

当在该地目录内形成地点的创制后,generator还无法被用作全局的npm module
,大家可以透过在generator-name/目录下运行 npm link
来落成generator的全局化。

7.找到工程根目录

当使用yo命令来运作generator的活着,yeoman会把
.yo-rc.json文本所在的目录作为工程的根目录,之后Yeoman将如今文件目录跳转到根目录下运作请求的生成器。当我们选取this.config.save()的时候,storage模块会创制它。借使.yo-rc.json
不在当前的做事目录,请确保他也不在其余的品类目录里。

4. 完善generator

1.创办用户交互

俺们推荐在prompting 方法内来定义prompt与用户交互,定义方法如下:

   module.exports = generators.Base.extend({
     prompting: function () {
       return this.prompt([{
         type    : 'input',
         name    : 'name',
         message : 'Your project name',
         default : this.appname // Default to current folder name
       }, {
         type    : 'confirm',
         name    : 'cool',
         message : 'Would you like to enable the Cool feature?'
       }]).then(function (answers) {
         this.log('app name', answers.name);
         this.log('cool feature', answers.cool);
       }.bind(this));
     }
   })

2. 运行上下文

在generator内,所有的静态方法都会被作为action而自定执行,当然generator也提供了可以声明不自动执行的辅助函数,generator提供了三种可以创建辅助函数的方法.

1 通过下划线早先定义函数,如:CopyFiles
2 使用实例函数注明:

    generators.Base.extend({
        constructor: function () {
          this.helperMethod = function () {
            console.log('won\'t be called automatically');
          };
        }
      });

3 继承一个父级generator:

      var MyBase = generators.Base.extend({
        helper: function () {
          console.log('methods on the parent generator won\'t be called automatically');
        }
      });

      module.exports = MyBase.extend({
        exec: function () {
          this.helper();
        }
      });

3.运转顺序

运作顺序

Yeoman是依据优先级依次依次执行所定义的法门。当你定义的函数名字是Yeoman定义的先期级函数名时,会自动将该函数列入到随地优先级队列中,否则就会列入到
default 优先层级队列中。

几乎执行的依次如下:
initializing

prompting

configuring

default

writing

conflicts

install

end

4.generator Arguments

Arguments是在命令行中直接传送的。 如:yo webapp
my-project,接受键值对的口径。

desc:描述argument

required:定义是或不是必须

optional:是或不是可选择的

type:参数类型,帮衬的连串有String Number Array Object

defaults: argument默认值

banner:字符串彰显的接纳表明(那是默许提供)

专注:参数必须的定义在construct函数内,否则当您利用generator调用命令(如:yo webapp --help)的时候,不能出口相关的帮带新闻。

示例:

    var _ = require('lodash');

    module.exports = generators.Base.extend({
      // note: arguments and options should be defined in the constructor.
      constructor: function () {
        generators.Base.apply(this, arguments);

        // This makes `appname` a required argument.
        this.argument('appname', { type: String, required: true });
        // And you can then access it later on this way; e.g. CamelCased
        this.appname = _.camelCase(this.appname);
      }
    });

5. Options

option和argument很相像,可是option是作为命令行标识应用的,如yo webapp --coffee

咱俩可可以通过generator.option()添加option。

示例:

 module.exports = generators.Base.extend({
   // note: arguments and options should be defined in the constructor.
   constructor: function () {
     generators.Base.apply(this, arguments);

     // This method adds support for a `--coffee` flag
     this.option('coffee');
     // And you can then access it later on this way; e.g.
     this.scriptSuffix = (this.options.coffee ? ".coffee": ".js");
   }
 });

6. 输出新闻

输出新闻是通过generator.log模块来拍卖落成的。不提出利用console.log输出命令。

示例:

    module.exports = generators.Base.extend({
      myAction: function () {
        this.log('Something has gone wrong!');
      }
    });

7. 处理倚重关系

貌似当您运行你的generator的时候,你平日要求通过
npm
Bower来设置一些generator用到的借助模块。而这个职责是很是麻烦的,为了有利于,yeoman将这一部分职责抽离了出来。

npm

您只要求调用generator.npmInstall()
命令就能够举办npm安装命令,yeoman确保了npm install只进行了一次,即使他被多个generator调用。

比如说你想安装lodash作为dev dependency:

   generators.Base.extend({
     installingLodash: function() {
       this.npmInstall(['lodash'], { 'saveDev': true });
     }
   });

地方代码等同于调用了npm install lodash –save-dev命令。

Bower

您只必要调用generator.bowerInstall()即可启动安装命令。yeoman确保了bower install只举办了四遍,即便他被多个generator调用。

npm && Bower

调用enerator.installDependencies()即可同时运行npm 和 bower。

其他tools

yeoman抽离了spawn命令,那么些抽离保障了我们得以在Linux ,mac
以及windows系统上得以很好的运转。

如若你是一个PHP狂热爱好者,你想运行composer指令,你能够如此做:

    generators.Base.extend({
      install: function () {
        this.spawnCommand('composer', ['install']);
      }
    });

请确保面spawn命令在install队列里。因为您的用户不情愿等待在当时直到安装命令已毕。

8. 上下文路径

为了便于文件流的输入输出,Yeoman使用两种职位环境。

1. 对象上下文

对象上下文定义为当前工作目录或含.yo-rc.json文件最相仿的父文件夹。该.yo-rc.json文件定义了一个generator项指标根目录。该文件允许用户在子目录中运作命令,并让她们在类型中能够运行。那确保了用户作为的一模一样。

您可以因此generator.destinationRoot()指令获取目的路径,也足以透过generator.destinationPath('sub/path')来拼一个路线:

    // Given destination root is ~/projects
    generators.Base.extend({
      paths: function () {
        this.destinationRoot();
        // returns '~/projects'

        this.destinationPath('index.js');
        // returns '~/projects/index.js'
      }
    });

2. 模板上下文

模板上下文是你保存模板文件的目录,他一般是你要读取和复制的目录。模板上下文一般是默许是概念在./templates/目录的.你可以透过generator.sourceRoot('new/template/path')命令来重写。你可以通过generator.sourceRoot()或者generator.templatePath('app/index.js').来得到路径。

    generators.Base.extend({
      paths: function () {
        this.sourceRoot();
        // returns './templates'

        this.templatePath('index.js');
        // returns './templates/index.js'
      }
});

3. “内存”文件系统

当提到到覆盖用户的文本的时候,yeoman非凡的兢兢业业,基本上,每一个write动作都是一个为已经存在的文书解决争论的历程。协助用户严重需求覆盖的始末。

4. 文书工具

generator的this.fs暴光出所有的文本措施,通过mem-fs
editor
.

任何连锁介绍请看官网

9.完全示例

    'use strict';

    var generators = require('yeoman-generator');
    var mkdirp = require('mkdirp');
    var yosay = require('yosay');
    var chalk = require('chalk');
    module.exports = generators.Base.extend({

        constructor: function() {
            generators.Base.apply(this, arguments);
            this.option('coffee');
            this.scriptSuffix = (this.options.coffee ? ".coffee": ".js");
        },

        initializing: function() {
            var message = chalk.bgBlack.bold('\nWelcome to webApp\n') + chalk.underline('webApp.github.io\n');
            this.log(yosay(message));
        },

        prompting: function() {
             var prompts = [{
                type:'input',
                name: 'appName',
                message: 'input app name .',
                default: 'webApp'
            }];
            this.prompt(prompts, function (answers) {
                this.log(answers);
            }.bind(this));
        },

        configuring: function() {
            this.config.save();
        },

        selfFunction: function () {
            this.log("执行了自定义方法");
        },

        writing: function() {
           this.fs.copyTpl(
             this.templatePath('index.html'),
             this.destinationPath('public/index.html'),
             { title: 'Templating with Yeoman' }
           );
        },

    });

作者音信

初稿链接:http://yeoman.io/authoring/
翻译自力谱宿云 LeapCloud 团队_UX成员:Jerry Zhang
普通话翻译先发地址:https://blog.maxleap.cn/archives/951

相关文章