自定義Yeoman生成器(一)

自定義Yeoman生成器

生成器(腳手架都可以)是Yeoman生態(tài)系統(tǒng)中的重要組成部分氓英,yo通過插件的方式運行生成器,為終端用戶生成文件。

通過這篇文章剔桨,你將學(xué)會如何創(chuàng)建和發(fā)布自定義的生成器

組織你的生成器

創(chuàng)建node模塊

生成器本質(zhì)上就是一個node.js的模塊

首先腻暮、創(chuàng)建一個文件夾彤守,例如:generator-net。文件夾的命名必須是:generator-name(其中name就是你要自定義的生成器的名字)哭靖,這一點非常重要具垫,因為Yeoman就是根據(jù)文件系統(tǒng)去發(fā)現(xiàn)可用的生成器。

然后试幽,進(jìn)入到剛創(chuàng)建的文件夾:cd generator-net筝蚕,通過npm init 創(chuàng)建package.json文件,文件內(nèi)容如下:

注意:name必須是generator開頭铺坞,keywords屬性必須要包含“yeoman-generator”起宽,files屬性必須是一個文件和文件夾的數(shù)組項(具體參考文件結(jié)構(gòu)說明)

為了確保依賴項yeoman-generator是最新的,可以通過運行如下命令:npm install --save yeoman-generator

請參考package.json 說明給package.json添加其他需要的屬性

目錄結(jié)構(gòu)

Yeoman的功能依賴于如何去組織目錄結(jié)構(gòu)济榨。每一個子生成器也都有自己的目錄

當(dāng)你執(zhí)行yo name 命令時坯沪,使用的是app默認(rèn)的生成器,包含在app目錄下

輸入yo name:subcommand就是執(zhí)行子生成器擒滑,文件的目錄名和子生成器的名字一樣腐晾。

目錄結(jié)構(gòu)可以參考如下示例:

如圖的生成器就會提供yo net 和 yo net:subnet兩個命令

Yeoman提供了兩種不同的目錄結(jié)構(gòu)叉弦,會在generators目錄下注冊可用的生成器

上面的示例也可以采用如下的目錄結(jié)構(gòu):


但是必須要修改package.json文件中files的屬性為:

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

編寫生成器

組織好了目錄結(jié)構(gòu),接下來就可以寫生成器相關(guān)的代碼了

Yeoman提供一個生成器的基類藻糖,該基類提供了大部分的功能淹冰,以減少我們的工作量,我們也可以繼承該基類去實現(xiàn)一些自定義的邏輯

修改生成器的index.js文件巨柒,引入yeoman-generator并繼承Generator基類:

具體怎么樣使用module.exports樱拴,可以參考exports 使用說明

重寫構(gòu)造函數(shù)

有些方法只能在構(gòu)造函數(shù)中執(zhí)行,例如:構(gòu)建一些狀態(tài)而且作用域在構(gòu)造函數(shù)中

我們可以按照如下的方式進(jìn)行構(gòu)造函數(shù)的重寫

添加自定義的功能

每一個被添加的方法都將按順序執(zhí)行潘拱。但是疹鳄,下一章節(jié)中,我們也能看到有些特殊的方法執(zhí)行順序也比較固定芦岂。

我們來添加一些方法:

執(zhí)行 yo net瘪弓,將看到如下的輸出信息:


執(zhí)行生成器

此時,你應(yīng)該有一個可以工作的生成器禽最,接下來腺怯,驗證一下創(chuàng)建的生成器是否能正常工作。

因為是在本地開發(fā)的生成器川无,所以還不是一個全局的node模塊呛占。可以通過命令npm link懦趋,去創(chuàng)建一個全局的node模塊并鏈接到我們開發(fā)的本地模塊晾虑。注意需要在生成器的根目錄下執(zhí)行命令:generator-name/ 目錄,執(zhí)行完命令之后仅叫,我們就能執(zhí)行命令:yo net并能在控制臺中看到輸出的日志信息

發(fā)現(xiàn)項目的根目錄

當(dāng)運行一個生成器時帜篇,Yeoman將試圖根據(jù)它運行的上下文推斷出一些東西。

最關(guān)鍵的是诫咱,Yeoman將在文件目錄中查找.yo-rc.json的文件笙隙,如果找到了,則把該文件所在的目錄當(dāng)作是項目的根目錄坎缭,Yeoman會自動在后臺更改當(dāng)前的目錄為.yo-rc.json文件所在的目錄并執(zhí)行生成器的請求竟痰。

.yo-rc.json文件是通過存儲模塊創(chuàng)建的。在生成器中只有第一次執(zhí)行的時候才會生成.yo-rc.json文件:

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末掏呼,一起剝皮案震驚了整個濱河市坏快,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌哄尔,老刑警劉巖假消,帶你破解...
    沈念sama閱讀 222,252評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異岭接,居然都是意外死亡富拗,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,886評論 3 399
  • 文/潘曉璐 我一進(jìn)店門鸣戴,熙熙樓的掌柜王于貴愁眉苦臉地迎上來啃沪,“玉大人,你說我怎么就攤上這事窄锅〈辞В” “怎么了?”我有些...
    開封第一講書人閱讀 168,814評論 0 361
  • 文/不壞的土叔 我叫張陵入偷,是天一觀的道長追驴。 經(jīng)常有香客問我,道長疏之,這世上最難降的妖魔是什么殿雪? 我笑而不...
    開封第一講書人閱讀 59,869評論 1 299
  • 正文 為了忘掉前任,我火速辦了婚禮锋爪,結(jié)果婚禮上丙曙,老公的妹妹穿的比我還像新娘。我一直安慰自己其骄,他們只是感情好亏镰,可當(dāng)我...
    茶點故事閱讀 68,888評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著拯爽,像睡著了一般索抓。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上毯炮,一...
    開封第一講書人閱讀 52,475評論 1 312
  • 那天逼肯,我揣著相機(jī)與錄音,去河邊找鬼否副。 笑死汉矿,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的备禀。 我是一名探鬼主播洲拇,決...
    沈念sama閱讀 41,010評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼曲尸!你這毒婦竟也來了赋续?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,924評論 0 277
  • 序言:老撾萬榮一對情侶失蹤另患,失蹤者是張志新(化名)和其女友劉穎纽乱,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體昆箕,經(jīng)...
    沈念sama閱讀 46,469評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡鸦列,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,552評論 3 342
  • 正文 我和宋清朗相戀三年租冠,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片薯嗤。...
    茶點故事閱讀 40,680評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡顽爹,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出骆姐,到底是詐尸還是另有隱情镜粤,我是刑警寧澤,帶...
    沈念sama閱讀 36,362評論 5 351
  • 正文 年R本政府宣布玻褪,位于F島的核電站肉渴,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏带射。R本人自食惡果不足惜同规,卻給世界環(huán)境...
    茶點故事閱讀 42,037評論 3 335
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望庸诱。 院中可真熱鬧捻浦,春花似錦、人聲如沸桥爽。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,519評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽钠四。三九已至盗扒,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間缀去,已是汗流浹背侣灶。 一陣腳步聲響...
    開封第一講書人閱讀 33,621評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留缕碎,地道東北人褥影。 一個月前我還...
    沈念sama閱讀 49,099評論 3 378
  • 正文 我出身青樓,卻偏偏與公主長得像咏雌,于是被迫代替她去往敵國和親凡怎。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,691評論 2 361

推薦閱讀更多精彩內(nèi)容