Vite+Vue3+TS打包一个npm组件,并支持IDE的代码提示功能

为了创建一个支持IDE代码提示的Vite + Vue 3 + TypeScript项目,你需要遵循以下步骤:

  1. 初始化项目:



npm init vite@latest my-vue-component -- --template vue-ts
  1. 进入项目目录:



cd my-vue-component
  1. 安装项目依赖:



npm install
  1. 修改vite.config.ts以支持库模式:



// vite.config.ts
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
 
// https://vitejs.dev/config/
export default defineConfig({
  plugins: [vue()],
  build: {
    lib: {
      entry: 'src/main.ts',
      name: 'MyComponent',
      fileName: (format) => `my-component.${format}.js`
    },
    rollupOptions: {
      // 确保外部化处理依赖
      external: ['vue'],
      output: {
        // 在 UMD 和 IIFE 格式下使用 'amd' 模块化
        globals: {
          vue: 'Vue'
        }
      }
    }
  }
})
  1. src目录下创建你的组件文件,例如MyComponent.vue:



<template>
  <div>{{ message }}</div>
</template>
 
<script lang="ts">
import { defineComponent } from 'vue';
 
export default defineComponent({
  name: 'MyComponent',
  props: {
    message: String
  }
});
</script>
  1. package.json中添加入口文件和类型声明:



{
  "name": "my-vue-component",
  "version": "1.0.0",
  "main": "dist/my-component.umd.js",
  "types": "dist/types/my-component.d.ts",
  // ...
}
  1. 构建库:



npm run build

现在你的项目已经设置好了,可以发布到npm上,并且其他开发者可以通过npm安装并使用你的组件,得益于Vite的热模块替换功能,开发过程中也能享受非常良好的开发体验。

VUE , npm
最后修改于:2024年08月23日 09:59

评论已关闭

推荐阅读

Vue中使用mind-map实现在线思维导图
2024年08月04日
VUE
Web前端最全Vue实现免密登录跳转的方式_vue怎么样不登录返回首页,最强技术实现
2024年08月04日
VUE
vue3 项目搭建教程(基于create-vue,vite,Vite + Vue)
2024年08月04日
VUE
Vue-颜色选择器实现方案——>Vue-Color( 实战*1+ Demo*7)
2024年08月04日
VUE
Vue项目卡顿慢加载?这些优化技巧告诉你!_vue数据多渲染卡顿
2024年08月04日
VUE
vue中的keep-alive详解与应用场景
2024年08月04日
VUE
Vue、React实现excel导出功能(三种实现方式保姆级讲解)
2024年08月04日
vue-office/docx插件实现docx文件预览
2024年08月04日
VUE
java调用js文件的两种方法(支持V8引擎)
2024年08月04日
JavaScript:解决计算精度问题/mathjs/bignumber.js/big.js/decimal.js
2024年08月04日
两周从爬虫小白变大神 _yjs_js_security_passport
2024年08月04日
JS笔记(对象、函数、数组)
2024年08月04日
Markdown.js:强大的纯JavaScript Markdown解析器
2024年08月04日
Vue项目:js模拟点击a标签下载文件并重命名,URL文件地址下载方法、请求接口下载文件方法总结。
2024年08月04日
vue 父组件怎么获取子组件里面的data数据
2024年08月04日
VUE
个人开发实现AI套壳网站快速搭建(Vue+elementUI+SpringBoot)
2024年08月04日
el-table 表格封装并改造实现单元格可编辑
2024年08月04日
none
nodejs环境下创建vue项目、SSH密钥登陆!!!
2024年08月04日
vue+quill+element-ui实现视频、图片上传及缩放保姆级教程,轻松使用富文本
2024年08月04日
【three.js】22. Imported Models导入模型
2024年08月04日