自定义Yeoman生成器(一)

自定义Yeoman生成器

生成器(脚手架都可以)是Yeoman生态系统中的重要组成部分,yo通过插件的方式运行生成器,为终端用户生成文件。

通过这篇文章,你将学会如何创建和发布自定义的生成器

组织你的生成器

创建node模块

生成器本质上就是一个node.js的模块

首先、创建一个文件夹,例如:generator-net。文件夹的命名必须是:generator-name(其中name就是你要自定义的生成器的名字),这一点非常重要,因为Yeoman就是根据文件系统去发现可用的生成器。

然后,进入到刚创建的文件夹:cd generator-net,通过npm init 创建package.json文件,文件内容如下:

注意:name必须是generator开头,keywords属性必须要包含“yeoman-generator”,files属性必须是一个文件和文件夹的数组项(具体参考文件结构说明)

为了确保依赖项yeoman-generator是最新的,可以通过运行如下命令:npm install --save yeoman-generator

请参考package.json 说明给package.json添加其他需要的属性

目录结构

Yeoman的功能依赖于如何去组织目录结构。每一个子生成器也都有自己的目录

当你执行yo name 命令时,使用的是app默认的生成器,包含在app目录下

输入yo name:subcommand就是执行子生成器,文件的目录名和子生成器的名字一样。

目录结构可以参考如下示例:

如图的生成器就会提供yo net 和 yo net:subnet两个命令

Yeoman提供了两种不同的目录结构,会在generators目录下注册可用的生成器

上面的示例也可以采用如下的目录结构:


但是必须要修改package.json文件中files的属性为:

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

编写生成器

组织好了目录结构,接下来就可以写生成器相关的代码了

Yeoman提供一个生成器的基类,该基类提供了大部分的功能,以减少我们的工作量,我们也可以继承该基类去实现一些自定义的逻辑

修改生成器的index.js文件,引入yeoman-generator并继承Generator基类:

具体怎么样使用module.exports,可以参考exports 使用说明

重写构造函数

有些方法只能在构造函数中执行,例如:构建一些状态而且作用域在构造函数中

我们可以按照如下的方式进行构造函数的重写

添加自定义的功能

每一个被添加的方法都将按顺序执行。但是,下一章节中,我们也能看到有些特殊的方法执行顺序也比较固定。

我们来添加一些方法:

执行 yo net,将看到如下的输出信息:


执行生成器

此时,你应该有一个可以工作的生成器,接下来,验证一下创建的生成器是否能正常工作。

因为是在本地开发的生成器,所以还不是一个全局的node模块。可以通过命令npm link,去创建一个全局的node模块并链接到我们开发的本地模块。注意需要在生成器的根目录下执行命令:generator-name/ 目录,执行完命令之后,我们就能执行命令:yo net并能在控制台中看到输出的日志信息

发现项目的根目录

当运行一个生成器时,Yeoman将试图根据它运行的上下文推断出一些东西。

最关键的是,Yeoman将在文件目录中查找.yo-rc.json的文件,如果找到了,则把该文件所在的目录当作是项目的根目录,Yeoman会自动在后台更改当前的目录为.yo-rc.json文件所在的目录并执行生成器的请求。

.yo-rc.json文件是通过存储模块创建的。在生成器中只有第一次执行的时候才会生成.yo-rc.json文件:

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

推荐阅读更多精彩内容