av激情亚洲男人的天堂国语,日韩欧美精品一中文字幕,无码av一区二区三区无码,国产又色又爽又刺激的a片,国产又色又爽又刺激的a片

教你從零開始搭建一款前端腳手架工具

前言

在實(shí)際的開發(fā)過程中，從零開始建立項(xiàng)目的結(jié)構(gòu)是一件讓人頭疼的事情，所以各種各樣的腳手架工具應(yīng)運(yùn)而生。筆者使用較多的yoeman，express-generator和vue-cli便是當(dāng)中之一。它們功能豐富，但最核心的功能都是能夠快速搭建一個(gè)完整的項(xiàng)目的結(jié)構(gòu)，開發(fā)者只需要在生成的項(xiàng)目結(jié)構(gòu)的基礎(chǔ)上進(jìn)行開發(fā)即可，非常簡(jiǎn)單高效。

作為一個(gè)不折騰會(huì)死星人，在熟悉了使用方法以后就開始琢磨起它們的原理來(lái)了。經(jīng)過仔細(xì)研究文檔和源碼，終于算是摸清了其核心的原理，并且依據(jù)這個(gè)原理自己搭建了一款叫做SCION的腳手架。

現(xiàn)在讓我們就以SCION為例，從零開始搭建一款屬于我們自己的腳手架工具吧!

核心原理

yoeman搭建項(xiàng)目需要提供yoeman-generator。yoeman-generator本質(zhì)上就是一個(gè)具備完整文件結(jié)構(gòu)的項(xiàng)目樣板，用戶需要手動(dòng)地把這些generator下載到本地，然后yoeman就會(huì)根據(jù)這些generator自動(dòng)生成各種不同的項(xiàng)目。

vue-cli提供了相當(dāng)豐富的選項(xiàng)和設(shè)定功能，但是其本質(zhì)也是從遠(yuǎn)程倉(cāng)庫(kù)把不同的模版拉取到本地，而并非是什么“本地生成”的黑科技。

這樣看來(lái)，思路也就有了——首先建立不同的樣板項(xiàng)目，然后腳手架根據(jù)用戶的指令引用樣板項(xiàng)目生成實(shí)際項(xiàng)目。樣板項(xiàng)目可以內(nèi)置在腳手架當(dāng)中，也可以部署在遠(yuǎn)程倉(cāng)庫(kù)。為了更廣的適用范圍，SCION采用的是第二種方式。

技術(shù)選型

  1. node.js：整個(gè)腳手架工具的根本組成部分，推薦使用***的版本。
  2. es6：新版本的node.js對(duì)于es6的支持度已經(jīng)非常高，使用es6能夠極大地提升開發(fā)效率和開發(fā)感受。
  3. commander：TJ大神開發(fā)的工具，能夠更好地組織和處理命令行的輸入。
  4. co：TJ大神開發(fā)的異步流程控制工具，用更舒服的方式寫異步代碼。
  5. co-prompt：還是TJ大神的作品……傳統(tǒng)的命令行只能單行一次性地輸入所有參數(shù)和選項(xiàng)，使用這個(gè)工具可以自動(dòng)提供提示信息，并且分步接收用戶的輸入，體驗(yàn)類似npm init時(shí)的一步一步輸入?yún)?shù)的過程。

整體架構(gòu)

國(guó)際慣例，著手開發(fā)之前得先弄明白整體架構(gòu)，看圖：

首先明白模版的概念。一個(gè)模版就是一個(gè)項(xiàng)目的樣板，包含項(xiàng)目的完整結(jié)構(gòu)和信息。

模版的信息都存放在一個(gè)叫做templates.json的文件當(dāng)中。

用戶可以通過命令行對(duì)templates.json進(jìn)行添加、刪除、羅列的操作。

通過選擇不同的模版，SCION會(huì)自動(dòng)從遠(yuǎn)程倉(cāng)庫(kù)把相應(yīng)的模板拉取到本地，完成項(xiàng)目的搭建。

最終整個(gè)腳手架的文件結(jié)構(gòu)如下：

 
 
    
  
  
  1. ================= 
    2. 
  
  
  2.   |__ bin 
    3. 
  
  
  3.     |__ scion 
    4. 
  
  
  4.   |__ command 
    5. 
  
  
  5.     |__ add.js 
    6. 
  
  
  6.     |__ delete.js 
    7. 
  
  
  7.     |__ init.js 
    8. 
  
  
  8.     |__ list.js 
    9. 
  
  
  9.   |__ node_modules 
    10. 
  
  
  10.   |__ package.json 
    11. 
  
  
  11.   |__ templates.json 
    12.

入口文件

首先建立項(xiàng)目，在package.json里面寫入依賴并執(zhí)行npm install：

 
 
    
  
  
  1. "dependencies": { 
    2. 
  
  
  2.     "chalk": "^1.1.3", 
    3. 
  
  
  3.     "co": "^4.6.0", 
    4. 
  
  
  4.     "co-prompt": "^1.0.0", 
    5. 
  
  
  5.     "commander": "^2.9.0" 
    6. 
  
  
  6.   } 
    7.

在根目錄下建立\bin文件夾，在里面建立一個(gè)無(wú)后綴名的scion文件。這個(gè)bin\scion文件是整個(gè)腳手架的入口文件，所以我們首先對(duì)它進(jìn)行編寫。

首先是一些初始化的代碼：

 
 
    
  
  
  1. #!/usr/bin/env node --harmony 
    2. 
  
  
  2. 'use strict' 
    3. 
  
  
  3.  // 定義腳手架的文件路徑 
    4. 
  
  
  4. process.env.NODE_PATH = __dirname + '/../node_modules/' 
    5. 
  
  
  5.  
    6. 
  
  
  6. const program = require('commander') 
    7. 
  
  
  7.  
    8. 
  
  
  8.  // 定義當(dāng)前版本 
    9. 
  
  
  9. program 
    10. 
  
  
  10.     .version(require('../package').version ) 
    11. 
  
  
  11.  
    12. 
  
  
  12. // 定義使用方法 
    13. 
  
  
  13. program 
    14. 
  
  
  14.     .usage('') 
    15.

 從前文的架構(gòu)圖中可以知道，腳手架支持用戶輸入4種不同的命令。現(xiàn)在我們來(lái)寫處理這4種命令的方法：

 
 
    
  
  
  1. program 
    2. 
  
  
  2.     .command('add') 
    3. 
  
  
  3.     .description('Add a new template') 
    4. 
  
  
  4.   .alias('a') 
    5. 
  
  
  5.   .action(() => { 
    6. 
  
  
  6.     require('../command/add')() 
    7. 
  
  
  7.   }) 
    8. 
  
  
  8.  
    9. 
  
  
  9. program 
    10. 
  
  
  10.     .command('list') 
    11. 
  
  
  11.     .description('List all the templates') 
    12. 
  
  
  12.     .alias('l') 
    13. 
  
  
  13.     .action(() => { 
    14. 
  
  
  14.         require('../command/list')() 
    15. 
  
  
  15.     }) 
    16. 
  
  
  16.  
    17. 
  
  
  17. program 
    18. 
  
  
  18.     .command('init') 
    19. 
  
  
  19.     .description('Generate a new project') 
    20. 
  
  
  20.   .alias('i') 
    21. 
  
  
  21.   .action(() => { 
    22. 
  
  
  22.     require('../command/init')() 
    23. 
  
  
  23.   }) 
    24. 
  
  
  24.  
    25. 
  
  
  25. program 
    26. 
  
  
  26.     .command('delete') 
    27. 
  
  
  27.     .description('Delete a template') 
    28. 
  
  
  28.     .alias('d') 
    29. 
  
  
  29.     .action(() => { 
    30. 
  
  
  30.         require('../command/delete')() 
    31. 
  
  
  31.     }) 
    32.

commander的具體使用方法在這里就不展開了，可以直接到官網(wǎng)去看詳細(xì)的文檔。

***別忘了處理參數(shù)和提供幫助信息： 

 
 
    
  
  
  1. program.parse(process.argv) 
    2. 
  
  
  2.  
    3. 
  
  
  3. if(!program.args.length){ 
    4. 
  
  
  4.   program.help() 
    5. 
  
  
  5. } 
    6.

 完整的代碼請(qǐng)看這里。

使用node運(yùn)行這個(gè)文件，看到輸出如下，證明入口文件已經(jīng)編寫完成了。

 
 
    
  
  
  1. Usage: scion  
    2. 
  
  
  2.  
    3. 
  
  
  3.  
    4. 
  
  
  4.   Commands: 
    5. 
  
  
  5.  
    6. 
  
  
  6.     add|a      Add a new template 
    7. 
  
  
  7.     list|l     List all the templates 
    8. 
  
  
  8.     init|i     Generate a new project 
    9. 
  
  
  9.     delete|d   Delete a template 
    10. 
  
  
  10.  
    11. 
  
  
  11.   Options: 
    12. 
  
  
  12.  
    13. 
  
  
  13.     -h, --help     output usage information 
    14. 
  
  
  14.     -V, --version  output the version number 
    15.

 處理用戶輸入

在項(xiàng)目根目錄下建立\command文件夾，專門用來(lái)存放命令處理文件。

在根目錄下建立templates.json文件并寫入如下內(nèi)容，用來(lái)存放模版信息： 

 
 
    
  
  
  1. {"tpl":{}} 
    2.

添加模板

進(jìn)入\command并新建add.js文件： 

 
 
    
  
  
  1. 'use strict' 
    2. 
  
  
  2. const co = require('co') 
    3. 
  
  
  3. const prompt = require('co-prompt') 
    4. 
  
  
  4. const config = require('../templates') 
    5. 
  
  
  5. const chalk = require('chalk') 
    6. 
  
  
  6. const fs = require('fs') 
    7. 
  
  
  7.  
    8. 
  
  
  8. module.exports = () => { 
    9. 
  
  
  9.  co(function *() { 
    10. 
  
  
  10.  
    11. 
  
  
  11.    // 分步接收用戶輸入的參數(shù) 
    12. 
  
  
  12.    let tplName = yield prompt('Template name: ') 
    13. 
  
  
  13.    let gitUrl = yield prompt('Git https link: ') 
    14. 
  
  
  14.    let branch = yield prompt('Branch: ') 
    15. 
  
  
  15.      
    16. 
  
  
  16.    // 避免重復(fù)添加 
    17. 
  
  
  17.    if (!config.tpl[tplName]) { 
    18. 
  
  
  18.      config.tpl[tplName] = {} 
    19. 
  
  
  19.      config.tpl[tplName]['url'] = gitUrl.replace(/[\u0000-\u0019]/g, '') // 過濾unicode字符 
    20. 
  
  
  20.      config.tpl[tplName]['branch'] = branch 
    21. 
  
  
  21.    } else { 
    22. 
  
  
  22.      console.log(chalk.red('Template has already existed!')) 
    23. 
  
  
  23.      process.exit() 
    24. 
  
  
  24.    } 
    25. 
  
  
  25.     
    26. 
  
  
  26.    // 把模板信息寫入templates.json 
    27. 
  
  
  27.    fs.writeFile(__dirname + '/../templates.json', JSON.stringify(config), 'utf-8', (err) => { 
    28. 
  
  
  28.      if (err) console.log(err) 
    29. 
  
  
  29.      console.log(chalk.green('New template added!\n')) 
    30. 
  
  
  30.      console.log(chalk.grey('The last template list is: \n')) 
    31. 
  
  
  31.      console.log(config) 
    32. 
  
  
  32.      console.log('\n') 
    33. 
  
  
  33.      process.exit() 
    34. 
  
  
  34.     }) 
    35. 
  
  
  35.  }) 
    36. 
  
  
  36. } 
    37.

 刪除模板

同樣的，在\command文件夾下建立delete.js文件：

 
 
    
  
  
  1. 'use strict' 
    2. 
  
  
  2. const co = require('co') 
    3. 
  
  
  3. const prompt = require('co-prompt') 
    4. 
  
  
  4. const config = require('../templates') 
    5. 
  
  
  5. const chalk = require('chalk') 
    6. 
  
  
  6. const fs = require('fs') 
    7. 
  
  
  7.  
    8. 
  
  
  8. module.exports = () => { 
    9. 
  
  
  9.     co(function *() { 
    10. 
  
  
  10.         // 接收用戶輸入的參數(shù) 
    11. 
  
  
  11.         let tplName = yield prompt('Template name: ') 
    12. 
  
  
  12.  
    13. 
  
  
  13.         // 刪除對(duì)應(yīng)的模板 
    14. 
  
  
  14.         if (config.tpl[tplName]) { 
    15. 
  
  
  15.             config.tpl[tplName] = undefined 
    16. 
  
  
  16.         } else { 
    17. 
  
  
  17.             console.log(chalk.red('Template does not exist!')) 
    18. 
  
  
  18.             process.exit() 
    19. 
  
  
  19.         } 
    20. 
  
  
  20.          
    21. 
  
  
  21.         // 寫入template.json 
    22. 
  
  
  22.         fs.writeFile(__dirname + '/../templates.json', JSON.stringify(config),     'utf-8', (err) => { 
    23. 
  
  
  23.             if (err) console.log(err) 
    24. 
  
  
  24.             console.log(chalk.green('Template deleted!')) 
    25. 
  
  
  25.             console.log(chalk.grey('The last template list is: \n')) 
    26. 
  
  
  26.             console.log(config) 
    27. 
  
  
  27.             console.log('\n') 
    28. 
  
  
  28.             process.exit() 
    29. 
  
  
  29.         }) 
    30. 
  
  
  30.     }) 
    31. 
  
  
  31. } 
    32.

 羅列模板

建立list.js文件：

 
 
    
  
  
  1. 'use strict' 
    2. 
  
  
  2. const config = require('../templates') 
    3. 
  
  
  3.  
    4. 
  
  
  4. module.exports = () => { 
    5. 
  
  
  5.      console.log(config.tpl) 
    6. 
  
  
  6.      process.exit() 
    7. 
  
  
  7. } 
    8.

 構(gòu)建項(xiàng)目

現(xiàn)在來(lái)到我們最重要的部分——構(gòu)建項(xiàng)目。同樣的，在\command目錄下新建一個(gè)叫做init.js的文件：

 
 
    
  
  
  1. 'use strict' 
    2. 
  
  
  2. const exec = require('child_process').exec 
    3. 
  
  
  3. const co = require('co') 
    4. 
  
  
  4. const prompt = require('co-prompt') 
    5. 
  
  
  5. const config = require('../templates') 
    6. 
  
  
  6. const chalk = require('chalk') 
    7. 
  
  
  7.  
    8. 
  
  
  8. module.exports = () => { 
    9. 
  
  
  9.  co(function *() { 
    10. 
  
  
  10.     // 處理用戶輸入 
    11. 
  
  
  11.       let tplName = yield prompt('Template name: ') 
    12. 
  
  
  12.       let projectName = yield prompt('Project name: ') 
    13. 
  
  
  13.       let gitUrl 
    14. 
  
  
  14.       let branch 
    15. 
  
  
  15.  
    16. 
  
  
  16.     if (!config.tpl[tplName]) { 
    17. 
  
  
  17.         console.log(chalk.red('\n × Template does not exit!')) 
    18. 
  
  
  18.         process.exit() 
    19. 
  
  
  19.     } 
    20. 
  
  
  20.     gitUrl = config.tpl[tplName].url 
    21. 
  
  
  21.     branch = config.tpl[tplName].branch 
    22. 
  
  
  22.  
    23. 
  
  
  23.     // git命令，遠(yuǎn)程拉取項(xiàng)目并自定義項(xiàng)目名 
    24. 
  
  
  24.     let cmdStr = `git clone ${gitUrl} ${projectName} && cd ${projectName} && git checkout ${branch}` 
    25. 
  
  
  25.  
    26. 
  
  
  26.     console.log(chalk.white('\n Start generating...')) 
    27. 
  
  
  27.  
    28. 
  
  
  28.     exec(cmdStr, (error, stdout, stderr) => { 
    29. 
  
  
  29.       if (error) { 
    30. 
  
  
  30.         console.log(error) 
    31. 
  
  
  31.         process.exit() 
    32. 
  
  
  32.       } 
    33. 
  
  
  33.       console.log(chalk.green('\n √ Generation completed!')) 
    34. 
  
  
  34.       console.log(`\n cd ${projectName} && npm install \n`) 
    35. 
  
  
  35.       process.exit() 
    36. 
  
  
  36.     }) 
    37. 
  
  
  37.   }) 
    38. 
  
  
  38. } 
    39.

 可以看到，這一部分代碼也非常簡(jiǎn)單，關(guān)鍵的一句話是 

 
 
    
  
  
  1. let cmdStr = `git clone ${gitUrl} ${projectName} && cd ${projectName} && git checkout ${branch}` 
    2.

它的作用正是從遠(yuǎn)程倉(cāng)庫(kù)克隆到自定義目錄，并切換到對(duì)應(yīng)的分支。熟悉git命令的同學(xué)應(yīng)該明白，不熟悉的同學(xué)是時(shí)候補(bǔ)補(bǔ)課啦!

全局使用

為了可以全局使用，我們需要在package.json里面設(shè)置一下：

 
 
    
  
  
  1. "bin": { 
    2. 
  
  
  2.     "scion": "bin/scion" 
    3. 
  
  
  3.   }, 
    4.

 本地調(diào)試的時(shí)候，在根目錄下執(zhí)行 

 
 
    
  
  
  1. npm link 
    2.

即可把scion命令綁定到全局，以后就可以直接以scion作為命令開頭而無(wú)需敲入長(zhǎng)長(zhǎng)的node scion之類的命令了。

現(xiàn)在我們的腳手架工具已經(jīng)搭建好了，一起來(lái)嘗試一下吧!

使用測(cè)試

  • add | a 添加模版命令 

  • init | i 生成項(xiàng)目命令

  • delete | d 刪除模版命令 和 list | l 羅列模版命令

 大功告成啦!現(xiàn)在我們的整個(gè)腳手架工具已經(jīng)搭建完成了，以后只需要知道模板的git https地址和branch就可以不斷地往SCION上面添加，團(tuán)隊(duì)協(xié)作的話只需要分享SCION的templates.json文件就可以了。

后記

看起來(lái)并不復(fù)雜的東西，實(shí)際從零開始搭建也是頗費(fèi)了一番心思。***的難題是在開始的時(shí)候并不懂得如何像npm init那樣可以一步一步地處理用戶輸入，只懂得一條命令行把所有的參數(shù)都帶上，這樣的用戶體驗(yàn)真的很不好。研究了vue-cli和yoeman也沒有找到相應(yīng)的代碼，只好不斷地google，***總算找到了一篇文章，可以用co和co-prompt這兩個(gè)工具實(shí)現(xiàn)，再一次膜拜無(wú)所不能的TJ大神，也希望能夠有小伙伴告訴我vue-cli它們是怎么實(shí)現(xiàn)的。

這個(gè)腳手架只具備最基本的功能，還遠(yuǎn)遠(yuǎn)沒有達(dá)到市面上同類產(chǎn)品的高度，在日后再慢慢填補(bǔ)吧，不管怎么說，完成SCION的過程中真的學(xué)習(xí)到了很多東西。

感謝你的閱讀。


本文名稱：教你從零開始搭建一款前端腳手架工具
文章分享：http://uogjgqi.cn/article/djjdsho.html
掃二維碼與項(xiàng)目經(jīng)理溝通

我們?cè)谖⑿派?4小時(shí)期待你的聲音

解答本文疑問/技術(shù)咨詢/運(yùn)營(yíng)咨詢/技術(shù)建議/互聯(lián)網(wǎng)交流