跨环境前端组件库打包方案(node+esm)

2024-02-23 11:44

本文主要是介绍跨环境前端组件库打包方案(node+esm),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

背景

最近项目中需要把一个功能做成通用方案,抽离一个公共组件库。方案由两部分组成,包括一个用在页面上的组件库(lib.ts),以及一个用在打包期间的vite插件(plugin.ts)。

- src- lib.ts- plugin.ts

设想打包后的结果可以通过import引入

// 页面
import { Lib } from 'MyLib/lib';
// vite.config.js
import { VitePlugin } from 'MyLib/plugin';

初始方案

一开始打算直接使用 vite 采用多入口的方式打包,然后使用dts库生成对应的.d.ts文件。由于vite-plugin运行在node环境中,里面用到的库都是node环境库,在浏览器上不可使用,因此需要加一个nodePolyfills进行兼容。

// vite.config.js
import { defineConfig } from 'vite';
import { nodePolyfills } from 'vite-plugin-node-polyfills';
import dts from "vite-plugin-dts";// https://vitejs.dev/config/
export default defineConfig({build: {//打包后文件目录outDir: "build",//压缩minify: false,lib: {entry: ["./src/lib.ts", "./src/plugin.ts"],name: "MyLib",formats: ["es", "cjs"]},},plugins: [vue(),dts({insertTypesEntry: true,}),nodePolyfills({// To exclude specific polyfills, add them to this list.include: ['fs', // Excludes the polyfill for `fs` and `node:fs`.'path', // Excludes the polyfill for `path` and `node:path`.],// Whether to polyfill specific globals.globals: {Buffer: true, // can also be 'build', 'dev', or falseglobal: true,process: true,},// Whether to polyfill `node:` protocol imports.protocolImports: true,}),],
})

思路看起来很美好,配置也简单,也确实生成了对应的打包后的js。但有两个小问题:

  1. plugin.ts 本身只有20行代码,但是加了polyfill后体积直接爆炸,变成了400+行。况且node脚本本来就能直接运行的,不需要过度打包
  2. 跑不起来,node脚本polyfill后的结果与node环境不兼容,寄

思路

  1. 对于在页面上使用的组件库,采用vite + esm打包方式,并输出.d.ts文件
  2. 对于node脚本,直接采用tsc进行编译就好了,并输出.d.ts文件

实现方式

lib.ts 交由vite进行esm打包,而 vite-plugin.ts 直接用命令行 + tsc 打包即可。

// vite.config.js
import { defineConfig } from 'vite';
import dts from "vite-plugin-dts";// https://vitejs.dev/config/
export default defineConfig({build: {//打包后文件目录outDir: "build",//压缩minify: false,lib: {entry: ["./src/lib.ts"],name: "MyLib",formats: ["es", "cjs"]},},plugins: [dts({insertTypesEntry: true,}),],
})

在 package.json 中编写打包命令

{"script": {"build": "pnpm build:lib && pnpm build:plugin","build:lib": "vite build","build:plugin": "tsc --outDir build src/plugin.ts --declaration"}
}

最后直接运行 npm build 就完成打包了,再用 npm publish 就发布成独立组件库了。

使用问题

当使用npm安装组件库时,发现上一步打包生成的.d.ts文件,在项目中居然没有自动识别到对应的类型定义并应用。查了很多文档才发现需要在 package.json 中声明类型文件。

如果是纯组件库,一般声明文件会放在同一个.d.ts文件里,可以简单地用 types 字段声明类型文件,形如:

{"name": "awesome","author": "Vandelay Industries","version": "1.0.0","main": "./lib/main.js","types": "./lib/main.d.ts"
}

但在这个项目里,存在不同场景的组件,各组件分别有自己的一个类型文件,不能通过一个.d.ts来实现。通过查找文档,发现了一个更灵活的属性 exports。通过它可以指定引用路径以及对应的文件:

{"exports": {"./lib": {"import": {"default": "./build/lib.js","types": "./build/lib.d.ts"},"require": {"default": "./build/lib.mjs","types": "./build/lib.d.ts"}},"./plugin": {"import": {"default": "./build/plugin.js","types": "./build/plugin.d.ts"},"require": {"default": "./build/plugin.js","types": "./build/plugin.d.ts"}}}
}

至此,问题圆满解决~

这篇关于跨环境前端组件库打包方案(node+esm)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/738522

相关文章

Knife4j+Axios+Redis前后端分离架构下的 API 管理与会话方案(最新推荐)

《Knife4j+Axios+Redis前后端分离架构下的API管理与会话方案(最新推荐)》本文主要介绍了Swagger与Knife4j的配置要点、前后端对接方法以及分布式Session实现原理,... 目录一、Swagger 与 Knife4j 的深度理解及配置要点Knife4j 配置关键要点1.Spri

SQLite3 在嵌入式C环境中存储音频/视频文件的最优方案

《SQLite3在嵌入式C环境中存储音频/视频文件的最优方案》本文探讨了SQLite3在嵌入式C环境中存储音视频文件的优化方案,推荐采用文件路径存储结合元数据管理,兼顾效率与资源限制,小文件可使用B... 目录SQLite3 在嵌入式C环境中存储音频/视频文件的专业方案一、存储策略选择1. 直接存储 vs

前端如何通过nginx访问本地端口

《前端如何通过nginx访问本地端口》:本文主要介绍前端如何通过nginx访问本地端口的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、nginx安装1、下载(1)下载地址(2)系统选择(3)版本选择2、安装部署(1)解压(2)配置文件修改(3)启动(4)

HTML中meta标签的常见使用案例(示例详解)

《HTML中meta标签的常见使用案例(示例详解)》HTMLmeta标签用于提供文档元数据,涵盖字符编码、SEO优化、社交媒体集成、移动设备适配、浏览器控制及安全隐私设置,优化页面显示与搜索引擎索引... 目录html中meta标签的常见使用案例一、基础功能二、搜索引擎优化(seo)三、社交媒体集成四、移动

HTML input 标签示例详解

《HTMLinput标签示例详解》input标签主要用于接收用户的输入,随type属性值的不同,变换其具体功能,本文通过实例图文并茂的形式给大家介绍HTMLinput标签,感兴趣的朋友一... 目录通用属性输入框单行文本输入框 text密码输入框 password数字输入框 number电子邮件输入编程框

HTML img标签和超链接标签详细介绍

《HTMLimg标签和超链接标签详细介绍》:本文主要介绍了HTML中img标签的使用,包括src属性(指定图片路径)、相对/绝对路径区别、alt替代文本、title提示、宽高控制及边框设置等,详细内容请阅读本文,希望能对你有所帮助... 目录img 标签src 属性alt 属性title 属性width/h

CSS3打造的现代交互式登录界面详细实现过程

《CSS3打造的现代交互式登录界面详细实现过程》本文介绍CSS3和jQuery在登录界面设计中的应用,涵盖动画、选择器、自定义字体及盒模型技术,提升界面美观与交互性,同时优化性能和可访问性,感兴趣的朋... 目录1. css3用户登录界面设计概述1.1 用户界面设计的重要性1.2 CSS3的新特性与优势1.

HTML5 中的<button>标签用法和特征

《HTML5中的<button>标签用法和特征》在HTML5中,button标签用于定义一个可点击的按钮,它是创建交互式网页的重要元素之一,本文将深入解析HTML5中的button标签,详细介绍其属... 目录引言<button> 标签的基本用法<button> 标签的属性typevaluedisabled

HTML5实现的移动端购物车自动结算功能示例代码

《HTML5实现的移动端购物车自动结算功能示例代码》本文介绍HTML5实现移动端购物车自动结算,通过WebStorage、事件监听、DOM操作等技术,确保实时更新与数据同步,优化性能及无障碍性,提升用... 目录1. 移动端购物车自动结算概述2. 数据存储与状态保存机制2.1 浏览器端的数据存储方式2.1.

基于 HTML5 Canvas 实现图片旋转与下载功能(完整代码展示)

《基于HTML5Canvas实现图片旋转与下载功能(完整代码展示)》本文将深入剖析一段基于HTML5Canvas的代码,该代码实现了图片的旋转(90度和180度)以及旋转后图片的下载... 目录一、引言二、html 结构分析三、css 样式分析四、JavaScript 功能实现一、引言在 Web 开发中,