如何使用vue脚手架构建库并发布到npm
如何使用vue腳手架構建庫并發布到npm?下面本篇文章給大家介紹一下基于vue腳手架構建庫并發布到npm的方法。有一定的參考價值,有需要的朋友可以參考一下,希望對大家有所幫助。
構建庫的常見方法有兩種:一種是自己手動構建webpack庫打包,設置output為 library; 另一種是基于vue-cli3輸出庫資源包。我們采用第二種vue腳手架的方式構建庫。
新增編譯庫命令
// package.json
"scripts": {
// ...
"lib": "vue-cli-service build --target lib --name Step --dest dist packages/index.js"
}
// packages/index.js 默認打包Step
import Step from '../steps/src/step';
Step.install = function(Vue) {
Vue.component(Step.name, Step);
};
export default Step;
--name: 庫名稱。--target: 構建目標,默認為應用模式。這里修改為 lib 啟用庫模式。--dest: 輸出目錄,默認 dist。[entry]: 最后一個參數為入口文件,默認為 src/App.vue。
更多詳細配置查看 ? vue腳手架官網
如果該庫依賴于其他庫,請在vue.config.js 配置 externals
// vue.config.js
module.exports = {
configureWebpack:{
externals: {
vue: 'Vue',
'vue-router':'VueRouter',
axios: 'axios'
}
}
}
執行 npm run lib 就可以發現我們的庫被打包到了 根目錄的dist文件夾下。
添加 .npmignore 文件(可選)
和 .gitignore 的語法一樣,具體需要提交什么文件,看各自的實際情況
# 忽略目錄 examples/ packages/ public/ # 忽略指定文件 vue.config.js babel.config.js *.map
配置npm庫信息
配置package.json文件,以發布庫文件。
{
"name": "gis",
"version": "1.2.5",
"description": "基于 Vue 的庫文件",
"main": "dist/gis.umd.min.js",
"keyword": "vue gis",
"private": false,
"files": ["dist"],
"license": "MIT"
}
name: 包名,該名字是唯一的。可在 npm 官網搜索名字,如果存在則需換個名字。version: 版本號,每次發布至 npm 需要修改版本號,不能和歷史版本號相同。description: 描述。main: 入口文件,該字段需指向我們最終編譯后的包文件。keyword:關鍵字,以空格分離希望用戶最終搜索的詞。author:作者files: 要上傳的文件private:是否私有,需要修改為 false 才能發布到 npmlicense: 開源協議dependencies: 依賴庫注意每次發布新的庫,需要更改版本號,規則如下:
"version": "1.2.5"主版本號為 1,次版本號 2,修訂號 5
主版本號(Major):當你做了不兼容的API修改次版本號(Minor):當你做了向下兼容的功能性新增修訂號(Patch):當你做了向下兼容的問題修正登錄npm
首先設置登錄的npm鏡像地址
npm config set registry http://168.20.20.57.4873
然后在終端執行登錄命令,輸入用戶名、密碼、郵箱即可登錄
npm login
接著發布庫資源到npm
npm publish
最后發布成功可到官網查看對應的包并下載
npm install package_name
相關推薦:
2020年前端vue面試題大匯總(附答案)
vue教程推薦:2020最新的5個vue.js視頻教程精選
更多編程相關知識,請訪問:編程入門!!
總結
以上是生活随笔為你收集整理的如何使用vue脚手架构建库并发布到npm的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 最“失败”的95后创业者,曾半年亏掉十几
- 下一篇: Yaml了解一下