my-ui-library-bydumi

v0.0.2

Published

12 days ago

A react library developed with dumi

0High
0Medium
0Low

sun-line

my

A react library developed with dumi

Usage

TODO

Options

TODO

Development

# install dependencies
$ pnpm install

# develop library by docs demo
$ pnpm start

# build library source code
$ pnpm run build

# build library source code in watch mode
$ pnpm run build:watch

# build docs
$ pnpm run docs:build

# Locally preview the production build.
$ pnpm run docs:preview

# check your project for potential problems
$ pnpm run doctor

LICENSE

MIT

要将当前包发布到 npm 上，需要按照以下步骤进行操作：

一、准备工作

检查包配置
- 查看 package.json 文件，确保以下字段正确：
  - name ：包名，确保在 npm 上唯一（可通过 npm view <包名> 检查是否已存在）
  - version ：遵循 Semantic Versioning（语义化版本）规范（如 1.0.0 ）
  - main / module / types ：确保入口文件路径正确
  - files ：指定要发布的文件/目录（当前项目已配置 ["dist"] ，仅发布构建产物）
配置 .npmignore （可选）
- 如果没有 .npmignore 文件，npm 会默认忽略 .gitignore 中的文件
- 确保只发布必要的文件（如 dist 目录、README、LICENSE 等）
注册 npm 账号
- 如果没有 npm 账号，先在 npm 官网注册
- 或通过命令行注册： npm adduser

二、发布前验证

运行构建
```
npm run build
```
确保构建成功，生成 dist 目录

运行测试和 lint（可选但推荐）

npm run lint  # 检查代码质量
# 如果有测试脚本，运行测试

检查发布内容（可选）

npm pack  # 生成 .tgz 文件，可查看包含
的文件

三、发布流程

登录 npm
```
npm login
```
- 输入 npm 用户名、密码和邮箱
- 注意：确保当前 registry 是官方 npm registry（ https://registry.npmjs.org/ ），而不是淘宝镜像等
发布包
```
npm publish
```
- 如果是第一次发布，会直接发布
- 如果是更新版本，需要先修改 package.json 中的 version 字段

验证发布结果

npm view <包名>  # 查看已发布的包信息

四、注意事项

版本管理
- 每次发布前需更新版本号
- 遵循 Semantic Versioning：
  - 主版本（Major）：不兼容的 API 变更
  - 次版本（Minor）：向后兼容的新功能
  - 补丁版本（Patch）：向后兼容的 bug 修复
发布权限
- 如果包名被占用，需要更换包名或联系现有包的所有者
- 组织包（如 @username/package ）需要先创建组织

后续更新

每次更新代码后，需重新构建并发布

可使用 npm version 命令自动更新版本号：

npm version patch  # 更新补丁版本
npm version minor  # 更新次版本
npm version major  # 更新主版本

五、当前项目的发布建议

当前项目已经配置了：

正确的 files 字段（仅发布 dist 目录）
完整的构建脚本
类型声明文件发布前需要：

确认 package.json 中的 name 字段唯一（当前为 ui-library ，可能已被占用，建议修改为更独特的名称，如 my-dumi-ui-library ）
确保 version 字段符合语义化版本规范
运行 npm run build 确保构建成功
使用 npm login 登录 npm 账号
运行 npm publish 发布包

示例发布命令

# 修改包名（可选，避免冲突）
npm pkg set name="my-dumi-ui-library"

# 构建
npm run build

# 登录
npm login

# 发布

修改包名（可选，避免冲突）

npm pkg set name="my-dumi-ui-library"

构建

npm run build

发布

npm publish