Generators是Yeoman生态系统的一部分,它们是通过yo命令为最终用户生成文件的插件。

组织你的generators

设置为一个node模块

generator实质上是一个node.js的模块

1.创立一个空文件夹用来写你本人的generator。这个文件夹必须命名为generator-name(name是你本人的generator名字)。这一点很重要,因为Yeoman依赖文件系统来查找可用的generator。

进入你的generator文件当前,创立一个package.json文件。这个文件是一个node module的manifest。你能够用npm init 这个命令初始化这个文件。

{  "name": "generator-name",//必须蕴含generator  "version": "0.1.0",  "description": "",  "files": [    "generators"  ],  "keywords": ["yeoman-generator"],//必须蕴含yeoman-generator  "dependencies": {    "yeoman-generator": "^1.0.0"  }}

必须放弃yeoman-generator的最新版本做为依赖,装置命令

npm install --save yeoman-generator

文件构造树

Yeoman的性能取决于如何构建目录树。每个Sub-generators都蕴含在其本人的文件夹中。

调用yo name时应用的默认生成器是app generator。它必须蕴含在app/目录中。

在输出 yo name:subcommand, 会调用Sub-generators ,Sub-generators存储在名为与子命令完全相同的文件夹中。

eg:

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

这个generator会暴露出 yo name 和 yo name:router命令

Yeoman容许两种不同的目录构造。它将在./和generators/中注册可用的generator。

之前的例子也能够依照上面的构造组织

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

如果你用这种构造,保障你在package.json中的files中指定

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

扩大generator

一旦有了这个构造,就能够编写理论的generator了。

Yeoman提供了一个base generator,你能够通过继承它来取得大部分的根底行为

index.jsvar Generator = require('yeoman-generator');module.exports = class extends Generator {};

重写构造函数

module.exports = class extends Generator {  // The name `constructor` is important here  constructor(args, opts) {    // Calling the super constructor is important so our generator is correctly set up    super(args, opts);    // Next, add your custom code    this.option('babel'); // This method adds support for a `--babel` flag  }};

加上本人的函数

每次调用生成器后,增加到原型中的每个办法都会运行,并且通常是按程序运行的。然而,正如咱们将在下一节中看到的,一些非凡的办法名将触发特定的运行程序。

module.exports = class extends Generator {  method1() {    this.log('method 1 just ran');  }  method2() {    this.log('method 2 just ran');  }};//主动按序执行,执行程序 method1->method2

运行

在这里,咱们曾经有一个能够运行的generator了,下一步咱们看怎么把它跑起来,看是不是能够失常工作。

咱们的generator是在本地的,还不能作为一个全局的npm module能够应用npm创立全局模块并将其符号链接到本地模块,运行:

npm link

它将装置我的项目依赖项并将全局模块符号链接到本地文件。npm实现后,您就能够调用yo name,并且应该在终端中看到log。

寻找我的项目根目录

在generator运行时,Yeoman将尝试依据运行它的文件夹的上下文来解决一些问题。

最重要的是,Yeoman在目录树中搜寻.yo-rc.json文件文件。如果找到,它会将文件的地位视为我的项目的根目录。在后盾,Yeoman将把当前目录改为.yo-rc.json文件文件地位并在那里运行申请的generator。

调用this.config.save文件()创立.yo-rc.json文件文件。

所以,如果generator没有在当前工作目录中运行,请确保目录树中没有.yo-rc.json文件。