Yeoman-脚手架搭建工具《一》

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.js

var 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文件。

Yeoman-脚手架搭建工具《二》
Yeoman-脚手架搭建工具《三》
[原文链接]
（https://segmentfault.com/a/1190000038438057）