從0搭建vue3組件庫: 如何完整搭建一個前端腳手架?

相信大家在前端開發中都使用過很多前端腳手架,如vue-cli , create-vite,create-vue等;本篇文章將會為大家詳細介紹這些前端腳手架是如何實現的,并且從零實現一個create-kitty腳手架發布到npm上 。
pnpm搭建Monorepo環境使用pnpm管理對項目進行管理是非常方便的,極大的解決了多個包在本地調試繁瑣的問題 。
什么是Monorepo?
就是指在一個大的項目倉庫中,管理多個模塊/包(package),這種類型的項目大都在項目根目錄下有一個packages文件夾,分多個項目管理 。大概結構如下:
-- packages-- pkg1--package.json-- pkg2--package.json--package.json簡單來說就是單倉庫 多項目
目前很多我們熟知的項目都是采用這種模式,如Vant,ElementUI,Vue3等 。打造一個Monorepo環境的工具有很多,如:lerna、pnpm、yarn等,這里我們將使用pnpm來開發我們的UI組件庫 。
使用pnpm安裝首先新建文件夾kitty-ui;然后執行
npm install pnpm -g初始化package.jsonpnpm init新建配置文件 .npmrcshamefully-hoist = true這里簡單說下為什么要配置shamefully-hoist 。
如果某些工具僅在根目錄的node_modules時才有效,可以將其設置為true來提升那些不在根目錄的node_modules,就是將你安裝的依賴包的依賴包的依賴包的...都放到同一級別(扁平化) 。說白了就是不設置為true有些包就有可能會出問題 。
monorepo的實現接下就是pnpm如何實現monorepo的了 。
為了我們各個項目之間能夠互相引用我們要在根目錄下新建一個pnpm-workspace.yaml文件將我們的包關聯起來
packages:- 'packages/**'這樣就能將我們項目下的packages目錄下的所有包關聯起來了,當然如果你想關聯更多目錄你只需要往里面添加即可 。根據上面的目錄結構很顯然你在根目錄下新packages文件夾,packages文件夾新建create-kitty以及測試用的cli-demo文件夾 , 并分別執行pnpm init
腳手架簡單實現在create-kittypackage.json中新增bin屬性然后指向index.js 。這里去掉了main屬性,因為我們開發的不是工具包 。
{"name": "create-kitty","version": "1.0.0","description": "","bin": "index.js","scripts": {"test": "echo \"Error: no test specified\" && exit 1"},"keywords": [],"author": "","license": "ISC"}當然,bin也支持對象格式,讓腳手架可以使用多個命令
"bin": {"create-kitty": "index.js","create-app": "index.js"},新建create-kitty/index.js作為腳手架入口
#! /usr/bin/env nodeconsole.log("hello kitty")注意cli入口文件需要加#! /usr/bin/env node指定腳本的解釋程序為node,否則會報錯
本地測試腳手架來到測試包cli-demo文件夾下直安裝create-kitty
pnpm add create-kitty然后就會發現cli-demo下的package出現依賴,同時加上scripts
{"name": "cli-demo","version": "1.0.0","description": "","main": "index.js","scripts": {"create-kitty": "create-kitty"},"keywords": [],"author": "","license": "ISC","dependencies": {"create-kitty": "workspace:^1.0.0"}}然后執行pnpm run create-kitty

從0搭建vue3組件庫: 如何完整搭建一個前端腳手架?

文章插圖
說明
當我們上線的時候可以直接執行npm create kitty或者npm init kitty,它們其實就是執行npx create-kitty
解析用戶輸入參數一般腳手架都會根據用戶輸入不同命令來做出不同操作,比如用戶輸入kitty-ui -v提示版本號,kitty-ui -h顯示幫助信息等 。而實現這些基本原理就是process.argv
create-kitty下的入口文件index.js修改為
#! /usr/bin/env nodeconsole.log(process.argv);然后執行這個文件并帶幾個參數
從0搭建vue3組件庫: 如何完整搭建一個前端腳手架?

文章插圖
然后會發現用戶傳的參數在process.argv數組的第二位以后,這樣我們就可以根據用戶輸入不同參數做不同操作了 。但是這樣很不方便,所以我們可以使用框架來解決 。
使用第三方庫解析參數首先安裝command-line-args
pnpm add command-line-args -S接下來看它是如何獲取用戶輸入參數的
#! /usr/bin/env nodeimport commandLineArgs from 'command-line-args';//配置命令參數const optionDefinitions = [{ name: 'version', alias: 'v', type: Boolean },{ name: 'arg1', type: String },{ name: 'arg2', type: Number },];const options = commandLineArgs(optionDefinitions);console.log(options);

推薦閱讀