如何将vue中自定义的组件编译打包输出,并提供给其他系统使用(或者上传到npm仓库)?

最近,本人参与的一个系统突然要考虑一个问题:那就是把系统A中的一些公共的组件页面提供给其他系统使用。

面对这个问题,我认为有以下两种方式:

1、提供一个页面URL,直接甩给其他系统调用者,并加上权限验证
2、将公共组件编译成文件,并以包的方式输出给其他系统

这里我们来考虑方式二如何实现:
1、建立一个用来打包编译的工程plugin-generator-system

安装脚手架
npm install --save vue-cli
初始化工程
vue init webpack-simple
生成的工程目录如下:
在这里插入图片描述

2、新建一个组件,并修改相关配置

在这里插入图片描述
此处目录用来放那些公共的组件,hello.vue和index.js的内容如下:
在这里插入图片描述
在index.js文件中引入组件hello,并定义hello组件的使用标签,
其中if判断很重要!
在这里插入图片描述
接下来修改package.json和webpack.config.js文件
在这里插入图片描述
其中最重要的是main、files、private(false表示公用)
keywords是用来搜索该插件的关键字,可选
在这里插入图片描述
其中entry表示编译文件的入口
此时,我们的一切准备工作就差不多就绪了,接下来让我们见证奇迹。

3、编译打包输出

编译文件:npm run build
打包文件:npm pack
结果如下:
在这里插入图片描述

4、其他系统使用上一步输出的包plugin-generator-system-1.0.0.tgz

它在磁盘中的路径:D:\workspace\plugin-generater-system\plugin-generator-system-1.0.0.tgz
其他系统(qxda-web)安装包的命令:
npm install D:\workspace\plugin-generater-system\plugin-generator-system-1.0.0.tgz
安装成功后,node_modules和package.js会发生改变:
在这里插入图片描述
在这里插入图片描述
然后,我们在qxda-web工程中的main.js中引入:
在这里插入图片描述
在其他文件中通过hz-hello使用:
在这里插入图片描述

5、最后的效果是什么样子呢?让我们把qxda-web工程跑起来看一看:

在这里插入图片描述
至此,大功告成!

### Vue3 组件打包发布到 NPM 的教程 #### 准备工作 为了将 Vue3 组件打包发布至 NPM,需先安装 Node.js 和 npm。确保本地环境已配置好 Git 账户以及拥有 NPM 用户账号。 #### 创建项目结构 创建一个新的文件夹作为项目的根目录,在该目录下初始化一个新项目: ```bash mkdir vue-component && cd $_ npm init -y ``` 这一步骤会生成 `package.json` 文件用于管理依赖项和脚本命令[^1]。 #### 安装必要的开发工具 接下来安装构建所需的工具链,包括 Webpack 或 Vite 来处理模块化资源编译;TypeScript (如果适用),以及其他辅助库如 Babel 等来支持更广泛的浏览器兼容性和语法特性: ```bash npm install --save-dev vite typescript @vitejs/plugin-vue ``` 对于 TypeScript 支持还需要额外设置 tsconfig.json 配置文件以定义编译选项。 #### 编写组件代码 在 src 目录内编写自定义Vue 单文件组件(SFCs), 通过 `<script setup>` 语法糖简化模板逻辑表达: ```html <!-- MyComponent.vue --> <template> <div class="my-component"> Hello from {{ name }}! </div> </template> <script lang="ts" setup> import { ref } from 'vue' const props = defineProps<{ msg?: string; }>(); const name = ref(props.msg || "World"); </script> <style scoped> .my-component { color: blue; } </style> ``` 此示例展示了如何利用组合 API 构建响应式的 UI 控件。 #### 设置 Rollup/Vite 进行优化与压缩 为了让其他开发者能够轻松引入这个组件库而无需关心内部实现细节, 可以借助于 rollup-plugin-typescript2 插件完成 ES Module 输出格式转换及 Tree Shaking 功能去除未使用的部分从而减小程序体积大小. 如果是基于 Vite,则可以直接使用其内置功能来进行生产模式下的打包操作: ```json // package.json scripts section { ... "build": "vite build" } ``` 执行上述命令将会依据默认配置自动产出 dist/ 下面的目标产物. #### 注册登录 NPM 首次发布之前要注册成为 NPM 用户,按照提示输入用户名、密码等相关信息完成账户验证过程。之后可以通过如下指令登陆: ```bash npm login ``` #### 发布流程 最后一步就是实际推送源码包给官方仓库啦!只需要简单运行下面这条语句即可达成目的: ```bash npm publish ``` 一旦成功提交后就能看到类似这样的反馈消息:“+ my-awesome-package@1.0.0”,表示已经正式上线可供他人下载试用了。
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

明致成

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值