摘要:在實際工作中,我們可以定制一個屬于自己的腳手架,來提高自己的工作效率。思路要開發腳手架,首先要理清思路,腳手架是如何工作的我們可以借鑒的基本思路。本地測試以上是我寫的一個的腳手架源碼,點擊即可查看,歡迎
前言
像我們熟悉的 vue-cli,create-react-app 等腳手架,只需要輸入簡單的命令 vue init webpack project,即可快速幫我們生成一個初始項目。在實際工作中,我們可以定制一個屬于自己的腳手架,來提高自己的工作效率。
為什么需要需要腳手架?
減少重復性的工作,不再需要復制其他項目再刪除無關代碼,或者從零創建一個項目和文件。
根據交互動態生成項目結構和配置文件等。
多人協作更為方便,不需要把文件傳來傳去。
思路要開發腳手架,首先要理清思路,腳手架是如何工作的?我們可以借鑒 vue-cli 的基本思路。vue-cli 是將項目模板放在 git 上,運行的時候再根據用戶交互下載不同的模板,經過模板引擎渲染出來,生成項目。這樣將模板和腳手架分離,就可以各自維護,即使模板有變動,只需要上傳最新的模板即可,而不需要用戶去更新腳手架就可以生成最新的項目。那么就可以按照這個思路來進行開發了。
第三方庫首先來看看會用到哪些庫。
commander.js,可以自動的解析命令和參數,用于處理用戶輸入的命令。
download-git-repo,下載并提取 git 倉庫,用于下載項目模板。
Inquirer.js,通用的命令行用戶界面集合,用于和用戶進行交互。
handlebars.js,模板引擎,將用戶提交的信息動態填充到文件中。
ora,下載過程久的話,可以用于顯示下載中的動畫效果。
chalk,可以給終端的字體加上顏色。
log-symbols,可以在終端上顯示出 √ 或 × 等的圖標。
初始化項目首先創建一個空項目,然后新建一個 index.js 文件,再執行 npm init 生成一個 package.json 文件。最后安裝上面需要用到的依賴。
npm install commander download-git-repo inquirer handlebars ora chalk log-symbols -S處理命令行
node.js 內置了對命令行操作的支持,在 package.json 中的 bin 字段可以定義命令名和關聯的執行文件。所以現在 package.json 中加上 bin 的內容:
{ "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 中來定義 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);
調用 version("1.0.0", "-v, --version") 會將 -v 和 --version 添加到命令中,可以通過這些選項打印出版本號。
調用 command("init
action() 則是執行 init 命令會發生的行為,要生成項目的過程就是在這里面執行的,這里暫時只打印出 name。
其實到這里,已經可以執行 init 命令了。我們來測試一下,在同級目錄下執行:
node index.js init HelloWorld
可以看到命令行工具也打印出了 HelloWorld,那么很清楚, action((name) => {}) 這里的參數 name,就是我們執行 init 命令時輸入的項目名稱。
命令已經完成,接下來就要下載模板生成項目結構了。
下載模板download-git-repo 支持從 Github、Gitlab 和 Bitbucket 下載倉庫,各自的具體用法可以參考官方文檔。
命令行交互命令行交互功能可以在用戶執行 init 命令后,向用戶提出問題,接收用戶的輸入并作出相應的處理。這里使用 inquirer.js 來實現。
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); })
通過這里例子可以看出,問題就放在 prompt() 中,問題的類型為 input 就是輸入類型,name 就是作為答案對象中的 key,message 就是問題了,用戶輸入的答案就在 answers 中,使用起來就是這么簡單。更多的參數設置可以參考官方文檔。
通過命令行交互,獲得用戶的輸入,從而可以把答案渲染到模板中。
渲染模板這里用 handlebars 的語法對模板中的 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 中
視覺美化在用戶輸入答案之后,開始下載模板,這時候使用 ora 來提示用戶正在下載中。
const ora = require("ora"); // 開始下載 const spinner = ora("正在下載模板..."); spinner.start(); // 下載失敗調用 spinner.fail(); // 下載成功調用 spinner.succeed();
然后通過 chalk 來為打印信息加上樣式,比如成功信息為綠色,失敗信息為紅色,這樣子會讓用戶更加容易分辨,同時也讓終端的顯示更加的好看。
const chalk = require("chalk"); console.log(chalk.green("項目創建成功")); console.log(chalk.red("項目創建失敗"));
除了給打印信息加上顏色之外,還可以使用 log-symbols 在信息前面加上 √ 或 × 等的圖標
const chalk = require("chalk"); const symbols = require("log-symbols"); console.log(symbols.success, chalk.green("項目創建成功")); console.log(symbols.error, chalk.red("項目創建失敗"));完整示例
// index.js #!/usr/bin/env node // 處理用戶輸入的命令 const program = require("commander"); // 下載模板 const download = require("download-git-repo"); // 問題交互 const inquirer = require("inquirer"); // node 文件模塊 const fs = require("fs"); // 填充信息至文件 const handlebars = require("handlebars"); // 動畫效果 const ora = require("ora"); // 字體加顏色 const chalk = require("chalk"); // 顯示提示圖標 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 { // 錯誤提示項目已存在,避免覆蓋原有項目 console.log(symbols.error, chalk.red("The object has exist")); } }); program.parse(process.argv);
npm publish發布你的項目即可。
本地測試node index init parcel-vue
以上是我寫的一個 suporka-parcel-vue 的腳手架源碼,suporka-parcel-vue 點擊即可查看,歡迎star.
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://m.specialneedsforspecialkids.com/yun/108539.html
摘要:一個基于打包工具的急速開發腳手架解決方案強烈建議使用以上項目地址初始化項目安裝依賴其中是主要的工具,對于結尾的單文件,需要單獨處理文件類型,這個插件會通過來生成對應的代碼,會自動加載開頭的依賴。 parcel-vue 一個基于Parcel打包工具的 VueJS急速開發腳手架解決方案,強烈建議使用node8.0以上 項目地址: https://github.com/w3c-king/p....
摘要:微信小程序出現引發了很多討論,許多開發者都躍躍欲試嘗試了小程序的開發。為此我們設想了一套方案,怎么最快速的把現有的開發流接入到小程序中,并能快速的修改現有項目以符合微信小程序的規范于是寫了一套暴力轉譯成的方案,以及搭配了初始模板的腳手架。 微信小程序出現引發了很多討論,許多開發者都躍躍欲試嘗試了小程序的開發。它重新定義了自身的一套開發規范,對于現有的html頁面是不支持了。 為此我們設...
摘要:微信小程序出現引發了很多討論,許多開發者都躍躍欲試嘗試了小程序的開發。為此我們設想了一套方案,怎么最快速的把現有的開發流接入到小程序中,并能快速的修改現有項目以符合微信小程序的規范于是寫了一套暴力轉譯成的方案,以及搭配了初始模板的腳手架。 微信小程序出現引發了很多討論,許多開發者都躍躍欲試嘗試了小程序的開發。它重新定義了自身的一套開發規范,對于現有的html頁面是不支持了。 為此我們設...
摘要:本文發表在微店前端團隊是什么注意目前只兼容平臺地址地址前端開發一站式解決方案。使用,您將只需關注業務邏輯,無需關注腳手架配置信息,即可快速完成前端開發。該命令會完成以下動作在本地安裝腳手架,以確保腳手架存在。 本文發表在 微店前端團隊 blog bio 是什么 注意:bio 目前只兼容 Mac 平臺 github 地址:bio-cli npm 地址:bio-cli 前端開發一站式解決方...
摘要:多語言使用了的版本,并整合了的多語言和使用者自己的多語言配置,而且會根據用戶系統的語言自動切換為中文和英文。 谷歌今天發布了一系列性感的軟件,我們也發布了一款大家期待已久的開發者工具,同樣很性感 :) iView 2.0 已經發布有兩個月了,在 2.0 發布后,npm 下載量、issues 數量都提升了很多(可以 watch 下項目,感受感受郵件量)。兩個月里,我們平均 1 周發布一個...
閱讀 756·2023-04-26 01:30
閱讀 3306·2021-11-24 10:32
閱讀 2193·2021-11-22 14:56
閱讀 1988·2021-11-18 10:07
閱讀 561·2019-08-29 17:14
閱讀 632·2019-08-26 12:21
閱讀 3111·2019-08-26 10:55
閱讀 2946·2019-08-23 18:09