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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容