发布一个库到 npm 上

先注册 npm

选择一个模板项目

例如 create-vite 模板

yarn create vite react-lib-demo --template react-ts

库模式配置 https://cn.vitejs.dev/guide/build.html#library-mode 可参考 vite.config.ts

package.json 说明

参考 package.json

关键字段说明：

type: module // 作为模块使用

main: 'dist/stylis-plugin-px2vw.umd.js' // 默认引入路径（umd 同时满足 CommonJS, AMD, CMD 以及全局挂载到 windows）

types: types/main.d.ts // ts 类型定义路径

exports: .. // 导出配置：使用 esModule 的 import 导入时的 ./dist/stylis-plugin-px2vw.es.js 路径

其他相关字段 name version repository keywords

发布到 npm.js

发布前测试模块可以使用 npm link

cd stylis-plugin-px2vw

# 将项目链接为全局模块
npm link

# 删除链接
npm unlink

cd your-project

# 引用
npm link stylis-plugin-px2vw

# 删除引用
npm unlink stylis-plugin-px2vw

登录 npm、发布（在项目根目录下）

npm login

npm publish

疑问

• 如果登录失败，检查 npm config edit 是否代理到 taobao 镜像去了。

• 包名以 @ 开头的默认发到私有化，需要加参数 npm publish --access publish

其他模板介绍

tsdx ts 库开发模板