把vue项目或者vue组件发布成npm包或者打包成lib库文件本地使用

将vue项目发布成npm库文件,第三方通过npm依赖安装使用;使用最近公司接了一个项目,这个项目需要集成到第三方页面,在第三方页面点击项目名称,页面变成我们的项目页面;要求以npm库文件提供给他们;

发布和删除自定的npm包(基于vue/cli4)(如果是私服使用可以不发布)
1、npm源设置(项目终端中执行)
阿里云镜像:npm config set registry https://registry.npmmirror.com
npm官网:npm config set registry https://registry.npmjs.org
2、创建vue项目(vue cli)
vue create xxxx (名字自己取)
创建好后npm install
3、自己的组件
在src下面新建package包(文件夹名字随便,后面配置打包命令也要用这个名字),分别创建一个文件夹(组件放这里面)和index.js文件
结构如下,
在这里插入图片描述
为了使图片能够正常打包,且从npm安装后能正常显示,需要创建vue.config.js文件(有就不用创建了),然后在该文件写上如下图所示代码 vue组件或者项目里面有图片,发布到npm图片需要正常显示
在这里插入图片描述
在package新建一个打包命令,打包命令里面的包名不能和package的name相同,不然上传到npm后,无法通过npm install 包名 安装;命令如下
“package”: "vue-cli-service build --target lib ./src/package/index.js/ --name xxxxx --dest xxxxx " (xxxxx是包名)
在这里插入图片描述
项目终端中运行npm run package会生成 xxxxx 文件夹
cd 进入 xxxxx 文件夹执行 npm init -y ,会产生一个package.json文件如下
在这里插入图片描述
version是版本信息,每次更新版本递增,如果想减小包体积,可以删除一些不必要的文件保留必要文件,箭头所指为必要文件;

发布包之前,把npm源更换为官网源
在包终端中执行 npm login 跟着提示填写用户名、密码、邮箱、邮箱验证码
然后执行命令 npm publish 将包上传到npm
执行 npm install xxxxx 可以下载包

同时还可以继续优化文件结构,新建style文件夹,将xxxxx.umd.min.js改为 index.js,把package的main入口改为index.js;
在这里插入图片描述
同时新建一个readme.md文件,描述组件使用方法
在这里插入图片描述

在发布包之前验证包的各项功能是否正常,可以在main.js中引入
在这里插入图片描述

Vue3 中将组件打包 npm 通常涉及几个关键步骤,以便其他人可以方便地在他们的项目中引入和使用。以下是基本流程: 1. **创建项目结构**: - 创建一个新的 GitHub 存储库,用于存放你的组件库。 - 设计好目录结构,例如 `src/components` 存放各个组件,`README.md` 描述如何使用。 2. **配置 vue.config.js**: 配置 Vue CLI 的全局配置文件,设置 build 部分。确保使用 `lib` 目录来打包公共文件,而不是默认的 `dist`。示例配置如下: ```js module.exports = { //... output: { library: 'YourComponentLibrary', // 库名称 libraryTarget: 'umd', // 兼容 CommonJS 和浏览器环境 filename: (name) => `${name}.js`, // 输出文件名规则 path: path.resolve(__dirname, 'lib'), // 输出路径 }, //... }; ``` 3. **编写并导出组件**: 在 `src/components` 下创建你的组件,并确保它们都有导出(export default),如: ```js // src/components/Button.vue export default { //... }; ``` 4. **构建库**: 使用 `vue-cli-service build` 或者 npm script `build:lib` 来构建组件库。这会生含所有组件及其依赖的 UMD 文件。 5. **发布npm**: - 安装 `npm` 并登录 (`npm login`)。 - 初始化 npm package.json 文件 (`npm init -y` 或手动编辑),填写基本信息。 - 发布 (`npm publish`),如果第一次发布需要先创建新的 (`npm publish --access public`)。 6. **在项目中引用**: 使用 `npm install your-component-library` 导入你的组件库,然后在需要的地方通过库名导入使用
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值