摘要:在實(shí)際工作中,我們可以定制一個(gè)屬于自己的腳手架,來(lái)提高自己的工作效率。思路要開(kāi)發(fā)腳手架,首先要理清思路,腳手架是如何工作的我們可以借鑒的基本思路。本地測(cè)試以上是我寫的一個(gè)的腳手架源碼,點(diǎn)擊即可查看,歡迎
前言
像我們熟悉的 vue-cli,create-react-app 等腳手架,只需要輸入簡(jiǎn)單的命令 vue init webpack project,即可快速幫我們生成一個(gè)初始項(xiàng)目。在實(shí)際工作中,我們可以定制一個(gè)屬于自己的腳手架,來(lái)提高自己的工作效率。
為什么需要需要腳手架?
減少重復(fù)性的工作,不再需要復(fù)制其他項(xiàng)目再刪除無(wú)關(guān)代碼,或者從零創(chuàng)建一個(gè)項(xiàng)目和文件。
根據(jù)交互動(dòng)態(tài)生成項(xiàng)目結(jié)構(gòu)和配置文件等。
多人協(xié)作更為方便,不需要把文件傳來(lái)傳去。
思路要開(kāi)發(fā)腳手架,首先要理清思路,腳手架是如何工作的?我們可以借鑒 vue-cli 的基本思路。vue-cli 是將項(xiàng)目模板放在 git 上,運(yùn)行的時(shí)候再根據(jù)用戶交互下載不同的模板,經(jīng)過(guò)模板引擎渲染出來(lái),生成項(xiàng)目。這樣將模板和腳手架分離,就可以各自維護(hù),即使模板有變動(dòng),只需要上傳最新的模板即可,而不需要用戶去更新腳手架就可以生成最新的項(xiàng)目。那么就可以按照這個(gè)思路來(lái)進(jìn)行開(kāi)發(fā)了。
第三方庫(kù)首先來(lái)看看會(huì)用到哪些庫(kù)。
commander.js,可以自動(dòng)的解析命令和參數(shù),用于處理用戶輸入的命令。
download-git-repo,下載并提取 git 倉(cāng)庫(kù),用于下載項(xiàng)目模板。
Inquirer.js,通用的命令行用戶界面集合,用于和用戶進(jìn)行交互。
handlebars.js,模板引擎,將用戶提交的信息動(dòng)態(tài)填充到文件中。
ora,下載過(guò)程久的話,可以用于顯示下載中的動(dòng)畫效果。
chalk,可以給終端的字體加上顏色。
log-symbols,可以在終端上顯示出 √ 或 × 等的圖標(biāo)。
初始化項(xiàng)目首先創(chuàng)建一個(gè)空項(xiàng)目,然后新建一個(gè) index.js 文件,再執(zhí)行 npm init 生成一個(gè) package.json 文件。最后安裝上面需要用到的依賴。
npm install commander download-git-repo inquirer handlebars ora chalk log-symbols -S處理命令行
node.js 內(nèi)置了對(duì)命令行操作的支持,在 package.json 中的 bin 字段可以定義命令名和關(guān)聯(lián)的執(zhí)行文件。所以現(xiàn)在 package.json 中加上 bin 的內(nèi)容:
{ "name": "suporka-parcel-vue", "version": "1.0.0", "description": "a vue cli which use parcel to package object", "bin": { "suporka-parcel-vue": "index.js" }, ... }
然后在 index.js 中來(lái)定義 init 命令:
#!/usr/bin/env node const program = require("commander"); program.version("1.0.0", "-v, --version") .command("init") .action((name) => { console.log(name); }); program.parse(process.argv);
調(diào)用 version("1.0.0", "-v, --version") 會(huì)將 -v 和 --version 添加到命令中,可以通過(guò)這些選項(xiàng)打印出版本號(hào)。
調(diào)用 command("init
action() 則是執(zhí)行 init 命令會(huì)發(fā)生的行為,要生成項(xiàng)目的過(guò)程就是在這里面執(zhí)行的,這里暫時(shí)只打印出 name。
其實(shí)到這里,已經(jīng)可以執(zhí)行 init 命令了。我們來(lái)測(cè)試一下,在同級(jí)目錄下執(zhí)行:
node index.js init HelloWorld
可以看到命令行工具也打印出了 HelloWorld,那么很清楚, action((name) => {}) 這里的參數(shù) name,就是我們執(zhí)行 init 命令時(shí)輸入的項(xiàng)目名稱。
命令已經(jīng)完成,接下來(lái)就要下載模板生成項(xiàng)目結(jié)構(gòu)了。
下載模板download-git-repo 支持從 Github、Gitlab 和 Bitbucket 下載倉(cāng)庫(kù),各自的具體用法可以參考官方文檔。
命令行交互命令行交互功能可以在用戶執(zhí)行 init 命令后,向用戶提出問(wèn)題,接收用戶的輸入并作出相應(yīng)的處理。這里使用 inquirer.js 來(lái)實(shí)現(xiàn)。
const inquirer = require("inquirer"); inquirer.prompt([ { name: "description", message: "Input the object description" }, { name: "author", message: "Input the object author" } ]).then((answers) => { console.log(answers.author); })
通過(guò)這里例子可以看出,問(wèn)題就放在 prompt() 中,問(wèn)題的類型為 input 就是輸入類型,name 就是作為答案對(duì)象中的 key,message 就是問(wèn)題了,用戶輸入的答案就在 answers 中,使用起來(lái)就是這么簡(jiǎn)單。更多的參數(shù)設(shè)置可以參考官方文檔。
通過(guò)命令行交互,獲得用戶的輸入,從而可以把答案渲染到模板中。
渲染模板這里用 handlebars 的語(yǔ)法對(duì)模板中的 package.json 文件做一些修改
{ "name": "{{name}}", "version": "1.0.0", "description": "{{description}}", "scripts": { "test": "echo "Error: no test specified" && exit 1" }, "author": "{{author}}", "license": "ISC" }
并在下載模板完成之后將用戶輸入的答案渲染到 package.json 中
視覺(jué)美化在用戶輸入答案之后,開(kāi)始下載模板,這時(shí)候使用 ora 來(lái)提示用戶正在下載中。
const ora = require("ora"); // 開(kāi)始下載 const spinner = ora("正在下載模板..."); spinner.start(); // 下載失敗調(diào)用 spinner.fail(); // 下載成功調(diào)用 spinner.succeed();
然后通過(guò) chalk 來(lái)為打印信息加上樣式,比如成功信息為綠色,失敗信息為紅色,這樣子會(huì)讓用戶更加容易分辨,同時(shí)也讓終端的顯示更加的好看。
const chalk = require("chalk"); console.log(chalk.green("項(xiàng)目創(chuàng)建成功")); console.log(chalk.red("項(xiàng)目創(chuàng)建失敗"));
除了給打印信息加上顏色之外,還可以使用 log-symbols 在信息前面加上 √ 或 × 等的圖標(biāo)
const chalk = require("chalk"); const symbols = require("log-symbols"); console.log(symbols.success, chalk.green("項(xiàng)目創(chuàng)建成功")); console.log(symbols.error, chalk.red("項(xiàng)目創(chuàng)建失敗"));完整示例
// index.js #!/usr/bin/env node // 處理用戶輸入的命令 const program = require("commander"); // 下載模板 const download = require("download-git-repo"); // 問(wèn)題交互 const inquirer = require("inquirer"); // node 文件模塊 const fs = require("fs"); // 填充信息至文件 const handlebars = require("handlebars"); // 動(dòng)畫效果 const ora = require("ora"); // 字體加顏色 const chalk = require("chalk"); // 顯示提示圖標(biāo) const symbols = require("log-symbols"); // 命令行操作 var shell = require("shelljs"); program.version("1.0.1", "-v, --version") .command("init") .action((name) => { if (!fs.existsSync(name)) { inquirer.prompt([ { name: "description", message: "Input the object description" }, { name: "author", message: "Input the object author" } ]).then((answers) => { const spinner = ora("Downloading..."); spinner.start(); download("zxpsuper/suporka-parcel-vue", name, (err) => { if (err) { spinner.fail(); console.log(symbols.error, chalk.red(err)); } else { spinner.succeed(); const fileName = `${name}/package.json`; const meta = { name, description: answers.description, author: answers.author } if (fs.existsSync(fileName)) { const content = fs.readFileSync(fileName).toString(); const result = handlebars.compile(content)(meta); fs.writeFileSync(fileName, result); } console.log(symbols.success, chalk.green("The vue object has downloaded successfully!")); inquirer.prompt([ { type: "confirm", name: "ifInstall", message: "Are you want to install dependence now?", default: true } ]).then((answers) => { if (answers.ifInstall) { inquirer.prompt([ { type: "list", name: "installWay", message: "Choose the tool to install", choices: [ "npm", "cnpm" ] } ]).then(ans => { if (ans.installWay === "npm") { let spinner = ora("Installing..."); spinner.start(); // 命令行操作安裝依賴 shell.exec("cd " + name + " && npm i", function (err, stdout, stderr) { if (err) { spinner.fail(); console.log(symbols.error, chalk.red(err)); } else { spinner.succeed(); console.log(symbols.success, chalk.green("The object has installed dependence successfully!")); } }); } else { let spinner = ora("Installing..."); spinner.start(); shell.exec("cd " + name + " && cnpm i", function (err, stdout, stderr) { if (err) { spinner.fail(); console.log(symbols.error, chalk.red(err)); } else { spinner.succeed(); console.log(symbols.success, chalk.green("The object has installed dependence successfully!")); } }) } }) } else { console.log(symbols.success, chalk.green("You should install the dependence by yourself!")); } }) } }) }) } else { // 錯(cuò)誤提示項(xiàng)目已存在,避免覆蓋原有項(xiàng)目 console.log(symbols.error, chalk.red("The object has exist")); } }); program.parse(process.argv);
npm publish發(fā)布你的項(xiàng)目即可。
本地測(cè)試node index init parcel-vue
以上是我寫的一個(gè) suporka-parcel-vue 的腳手架源碼,suporka-parcel-vue 點(diǎn)擊即可查看,歡迎star.
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://specialneedsforspecialkids.com/yun/108539.html
摘要:一個(gè)基于打包工具的急速開(kāi)發(fā)腳手架解決方案強(qiáng)烈建議使用以上項(xiàng)目地址初始化項(xiàng)目安裝依賴其中是主要的工具,對(duì)于結(jié)尾的單文件,需要單獨(dú)處理文件類型,這個(gè)插件會(huì)通過(guò)來(lái)生成對(duì)應(yīng)的代碼,會(huì)自動(dòng)加載開(kāi)頭的依賴。 parcel-vue 一個(gè)基于Parcel打包工具的 VueJS急速開(kāi)發(fā)腳手架解決方案,強(qiáng)烈建議使用node8.0以上 項(xiàng)目地址: https://github.com/w3c-king/p....
摘要:微信小程序出現(xiàn)引發(fā)了很多討論,許多開(kāi)發(fā)者都躍躍欲試嘗試了小程序的開(kāi)發(fā)。為此我們?cè)O(shè)想了一套方案,怎么最快速的把現(xiàn)有的開(kāi)發(fā)流接入到小程序中,并能快速的修改現(xiàn)有項(xiàng)目以符合微信小程序的規(guī)范于是寫了一套暴力轉(zhuǎn)譯成的方案,以及搭配了初始模板的腳手架。 微信小程序出現(xiàn)引發(fā)了很多討論,許多開(kāi)發(fā)者都躍躍欲試嘗試了小程序的開(kāi)發(fā)。它重新定義了自身的一套開(kāi)發(fā)規(guī)范,對(duì)于現(xiàn)有的html頁(yè)面是不支持了。 為此我們?cè)O(shè)...
摘要:微信小程序出現(xiàn)引發(fā)了很多討論,許多開(kāi)發(fā)者都躍躍欲試嘗試了小程序的開(kāi)發(fā)。為此我們?cè)O(shè)想了一套方案,怎么最快速的把現(xiàn)有的開(kāi)發(fā)流接入到小程序中,并能快速的修改現(xiàn)有項(xiàng)目以符合微信小程序的規(guī)范于是寫了一套暴力轉(zhuǎn)譯成的方案,以及搭配了初始模板的腳手架。 微信小程序出現(xiàn)引發(fā)了很多討論,許多開(kāi)發(fā)者都躍躍欲試嘗試了小程序的開(kāi)發(fā)。它重新定義了自身的一套開(kāi)發(fā)規(guī)范,對(duì)于現(xiàn)有的html頁(yè)面是不支持了。 為此我們?cè)O(shè)...
摘要:本文發(fā)表在微店前端團(tuán)隊(duì)是什么注意目前只兼容平臺(tái)地址地址前端開(kāi)發(fā)一站式解決方案。使用,您將只需關(guān)注業(yè)務(wù)邏輯,無(wú)需關(guān)注腳手架配置信息,即可快速完成前端開(kāi)發(fā)。該命令會(huì)完成以下動(dòng)作在本地安裝腳手架,以確保腳手架存在。 本文發(fā)表在 微店前端團(tuán)隊(duì) blog bio 是什么 注意:bio 目前只兼容 Mac 平臺(tái) github 地址:bio-cli npm 地址:bio-cli 前端開(kāi)發(fā)一站式解決方...
摘要:多語(yǔ)言使用了的版本,并整合了的多語(yǔ)言和使用者自己的多語(yǔ)言配置,而且會(huì)根據(jù)用戶系統(tǒng)的語(yǔ)言自動(dòng)切換為中文和英文。 谷歌今天發(fā)布了一系列性感的軟件,我們也發(fā)布了一款大家期待已久的開(kāi)發(fā)者工具,同樣很性感 :) iView 2.0 已經(jīng)發(fā)布有兩個(gè)月了,在 2.0 發(fā)布后,npm 下載量、issues 數(shù)量都提升了很多(可以 watch 下項(xiàng)目,感受感受郵件量)。兩個(gè)月里,我們平均 1 周發(fā)布一個(gè)...
閱讀 746·2023-04-26 01:30
閱讀 3300·2021-11-24 10:32
閱讀 2179·2021-11-22 14:56
閱讀 1978·2021-11-18 10:07
閱讀 552·2019-08-29 17:14
閱讀 624·2019-08-26 12:21
閱讀 3102·2019-08-26 10:55
閱讀 2939·2019-08-23 18:09