关于脚手架:Yeoman脚手架搭建工具一

3次阅读

共计 2150 个字符,预计需要花费 6 分钟才能阅读完成。

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

正文完
 0