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

评论已关闭

推荐阅读

DDPG 模型解析,附Pytorch完整代码
2024年11月24日
DQN 模型解析,附Pytorch完整代码
2024年11月24日
AIGC实战——Transformer模型
2024年12月01日
Socket TCP 和 UDP 编程基础(Python)
2024年11月30日
python , tcp , udp
如何使用 ChatGPT 进行学术润色?你需要这些指令
2024年12月01日
AI
最新 Python 调用 OpenAi 详细教程实现问答、图像合成、图像理解、语音合成、语音识别(详细教程)
2024年11月24日
ChatGPT 和 DALL·E 2 配合生成故事绘本
2024年12月01日
omegaconf,一个超强的 Python 库!
2024年11月24日
【视觉AIGC识别】误差特征、人脸伪造检测、其他类型假图检测
2024年12月01日
[超级详细]如何在深度学习训练模型过程中使用 GPU 加速
2024年11月29日
Python 物理引擎pymunk最完整教程
2024年11月27日
MediaPipe 人体姿态与手指关键点检测教程
2024年11月27日
深入了解 Taipy:Python 打造 Web 应用的全面教程
2024年11月26日
基于Transformer的时间序列预测模型
2024年11月25日
Python在金融大数据分析中的AI应用(股价分析、量化交易)实战
2024年11月25日
AIGC Gradio系列学习教程之Components
2024年12月01日
Python3 `asyncio` — 异步 I/O,事件循环和并发工具
2024年11月30日
llama-factory SFT系列教程:大模型在自定义数据集 LoRA 训练与部署
2024年12月01日
Python 多线程和多进程用法
2024年11月24日
Python socket详解,全网最全教程
2024年11月27日