vue3+ts + vite 封装组件发布npm包

1.创建项目

使用vite 去创建项目

javascript 复制代码
pnpm create vite
  1. 删除src下的assets文件
  2. 删除src下components下文件
  3. 清空App.vue中的文件内容,后续做测试使用
  4. 新建src/package 目录 用于存放待发布的方法或者组件

2. 划分目录

其中types 用于声明ts 类型 package 为待发布的包,其中待发布的组件跟方法都在这里定义 package/index.js 为入口文件

3. 项目配置

  • 配置vite.config.js 需要 安装 vite-plugin-dts 用于产生类型声明文件 并在vite.config.js 中配置

需要三处配置

  1. 配置dts 用于生成.d.ts 声明文件

  2. 配置lib 用于配置 打包成库的配置项 就是上传npm 配置项 其中entry 为打包的入口文件路径 name: 打包的名称 (x现在随便起的不确定作用) fileName: 打包后的文件名称

  3. 配置rollup

  • 配置 package.json

需要显示的去指定 main: 指定在node 环境的文件

module 指定在ESModule 中 文件路径

types: 指定ts 类型提示路径

files: 将哪些文件发布到npm 中

需要注意的是:在vite.config.js 中配置的lib > fileName 路径应该跟 package.json 中的路径相对应

4. 开发组件

在package/compoents 开发组件 开发之后,在入口文件引入

5. 发布组件

  1. 项目进行打包编译
  2. 登录npm
  3. 回到项目中 执行 npm whoami 查看是否登录 如果没有登录 执行 npm login
  4. 执行 npm publish

6. 注意事项

遇到的坑 ite-plugin-dts组件默认取的是tsconfig.json配置,但是vite创建的项目中tsconfig.json被拆分成2个文件,所以tsconfig.json中的include配置项未生效。如下图:

需要再dts 配置项去指定 dts 解析的路径

相关推荐
吴敬悦4 小时前
私有的 GitHub Package 怎么拉取?
npm·github
前端郭德纲12 小时前
React 19.2 已发布,现已上线 npm!
前端·react.js·npm
LYFlied13 小时前
【一句话概括】前端项目包管理器怎么选?
前端·npm·pnpm·yarn
LisEcho2 天前
yoyoj-rn — RN 的脚手架工具可以不是 @react-native-community/cli
前端·react native·npm
醉风塘2 天前
NPM:从“模块之痛”到“生态之基”的演化史
前端·npm·node.js
水冗水孚2 天前
通俗易懂地谈谈,前端工程化之自定义脚手架的理解,并附上一个实践案例发布到npm上
javascript·npm·node.js
蚂蚁不吃土&2 天前
cmd powershell svm nodejs npm
前端·npm·node.js
Lucky_Turtle3 天前
【Node】npm install报错npm error Cannot read properties of null (reading ‘matches‘)
前端·npm·node.js
水冗水孚3 天前
20张图的保姆级教程,记录使用Verdaccio在Ubuntu服务器上搭建Npm私服
npm
Irene19914 天前
npm 完整生命周期脚本及特点
npm·生命周期